VTK
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
dox
Common
vtkCommand.h
Go to the documentation of this file.
1
/*=========================================================================
2
3
Program: Visualization Toolkit
4
Module: vtkCommand.h
5
6
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7
All rights reserved.
8
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10
This software is distributed WITHOUT ANY WARRANTY; without even
11
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12
PURPOSE. See the above copyright notice for more information.
13
14
=========================================================================*/
204
#ifndef __vtkCommand_h
205
#define __vtkCommand_h
206
207
#include "
vtkObjectBase.h
"
208
#include "
vtkObject.h
"
// Need vtkTypeMacro
209
210
// The superclass that all commands should be subclasses of
211
class
VTK_COMMON_EXPORT
vtkCommand
:
public
vtkObjectBase
212
{
213
public
:
214
vtkTypeMacro(
vtkCommand
,
vtkObjectBase
);
215
217
220
void
UnRegister
();
221
virtual
void
UnRegister
(
vtkObjectBase
*)
222
{ this->
UnRegister
(); }
224
226
235
virtual
void
Execute(
vtkObject
*caller,
unsigned
long
eventId,
236
void
*callData) = 0;
238
240
242
static
const
char
*GetStringFromEventId(
unsigned
long
event);
243
static
unsigned
long
GetEventIdFromString(
const
char
*event);
245
247
249
void
SetAbortFlag
(
int
f)
250
{ this->AbortFlag = f; }
251
int
GetAbortFlag
()
252
{
return
this->AbortFlag; }
253
void
AbortFlagOn
()
254
{ this->SetAbortFlag(1); }
255
void
AbortFlagOff
()
256
{ this->SetAbortFlag(0); }
258
260
264
void
SetPassiveObserver
(
int
f)
265
{ this->PassiveObserver = f; }
266
int
GetPassiveObserver
()
267
{
return
this->PassiveObserver; }
268
void
PassiveObserverOn
()
269
{ this->SetPassiveObserver(1); }
270
void
PassiveObserverOff
()
271
{ this->SetPassiveObserver(0); }
273
274
//BTX
276
280
enum
EventIds
{
281
NoEvent = 0,
282
AnyEvent
,
283
DeleteEvent
,
284
StartEvent
,
285
EndEvent
,
286
RenderEvent
,
287
ProgressEvent
,
288
PickEvent
,
289
StartPickEvent
,
290
EndPickEvent
,
291
AbortCheckEvent
,
292
ExitEvent
,
293
LeftButtonPressEvent
,
294
LeftButtonReleaseEvent
,
295
MiddleButtonPressEvent
,
296
MiddleButtonReleaseEvent
,
297
RightButtonPressEvent
,
298
RightButtonReleaseEvent
,
299
EnterEvent
,
300
LeaveEvent
,
301
KeyPressEvent
,
302
KeyReleaseEvent
,
303
CharEvent
,
304
ExposeEvent
,
305
ConfigureEvent
,
306
TimerEvent
,
307
MouseMoveEvent
,
308
MouseWheelForwardEvent
,
309
MouseWheelBackwardEvent
,
310
ActiveCameraEvent
,
311
CreateCameraEvent
,
312
ResetCameraEvent
,
313
ResetCameraClippingRangeEvent
,
314
ModifiedEvent
,
315
WindowLevelEvent
,
316
StartWindowLevelEvent
,
317
EndWindowLevelEvent
,
318
ResetWindowLevelEvent
,
319
SetOutputEvent
,
320
ErrorEvent
,
321
WarningEvent
,
322
StartInteractionEvent
,
//mainly used by vtkInteractorObservers
323
InteractionEvent
,
324
EndInteractionEvent
,
325
EnableEvent
,
326
DisableEvent
,
327
CreateTimerEvent
,
328
DestroyTimerEvent
,
329
PlacePointEvent
,
330
PlaceWidgetEvent
,
331
CursorChangedEvent
,
332
ExecuteInformationEvent
,
333
RenderWindowMessageEvent
,
334
WrongTagEvent
,
335
StartAnimationCueEvent
,
// used by vtkAnimationCue
336
AnimationCueTickEvent
,
337
EndAnimationCueEvent
,
338
VolumeMapperRenderEndEvent
,
339
VolumeMapperRenderProgressEvent
,
340
VolumeMapperRenderStartEvent
,
341
VolumeMapperComputeGradientsEndEvent
,
342
VolumeMapperComputeGradientsProgressEvent
,
343
VolumeMapperComputeGradientsStartEvent
,
344
WidgetModifiedEvent
,
345
WidgetValueChangedEvent
,
346
WidgetActivateEvent
,
347
ConnectionCreatedEvent
,
348
ConnectionClosedEvent
,
349
DomainModifiedEvent
,
350
PropertyModifiedEvent
,
351
UpdateEvent
,
352
RegisterEvent
,
353
UnRegisterEvent
,
354
UpdateInformationEvent
,
355
AnnotationChangedEvent
,
356
SelectionChangedEvent
,
357
UpdatePropertyEvent
,
358
ViewProgressEvent
,
359
UpdateDataEvent
,
360
CurrentChangedEvent
,
361
ComputeVisiblePropBoundsEvent
,
362
TDxMotionEvent
,
// 3D Connexion device event
363
TDxButtonPressEvent
,
// 3D Connexion device event
364
TDxButtonReleaseEvent
,
// 3D Connexion device event
365
HoverEvent
,
366
LoadStateEvent
,
367
SaveStateEvent
,
368
StateChangedEvent
,
369
WindowMakeCurrentEvent
,
370
WindowIsCurrentEvent
,
371
WindowFrameEvent
,
372
HighlightEvent
,
373
WindowSupportsOpenGLEvent
,
374
WindowIsDirectEvent
,
375
UserEvent = 1000
376
};
377
//ETX
379
380
protected
:
381
int
AbortFlag
;
382
int
PassiveObserver
;
383
384
vtkCommand
();
385
virtual
~vtkCommand
() {}
386
387
friend
class
vtkSubjectHelper;
388
//BTX
389
vtkCommand
(
const
vtkCommand
& c) :
vtkObjectBase
(c) {}
390
void
operator=
(
const
vtkCommand
&) {}
391
//ETX
392
};
393
394
#endif
/* __vtkCommand_h */
395
vtkCommand::KeyPressEvent
Definition:
vtkCommand.h:301
vtkCommand::MiddleButtonPressEvent
Definition:
vtkCommand.h:295
vtkCommand::EnableEvent
Definition:
vtkCommand.h:325
vtkCommand::SetPassiveObserver
void SetPassiveObserver(int f)
Definition:
vtkCommand.h:264
vtkCommand::WindowLevelEvent
Definition:
vtkCommand.h:315
vtkCommand::HoverEvent
Definition:
vtkCommand.h:365
vtkCommand::TDxMotionEvent
Definition:
vtkCommand.h:362
vtkCommand::AbortFlagOff
void AbortFlagOff()
Definition:
vtkCommand.h:255
vtkCommand::ModifiedEvent
Definition:
vtkCommand.h:314
vtkCommand::DestroyTimerEvent
Definition:
vtkCommand.h:328
vtkCommand::DeleteEvent
Definition:
vtkCommand.h:283
vtkCommand::operator=
void operator=(const vtkCommand &)
Definition:
vtkCommand.h:390
vtkCommand::CreateCameraEvent
Definition:
vtkCommand.h:311
vtkObject
abstract base class for most VTK objects
Definition:
vtkObject.h:60
vtkCommand::ResetCameraClippingRangeEvent
Definition:
vtkCommand.h:313
vtkCommand::MiddleButtonReleaseEvent
Definition:
vtkCommand.h:296
vtkCommand::EventIds
EventIds
Definition:
vtkCommand.h:280
vtkCommand::EndAnimationCueEvent
Definition:
vtkCommand.h:337
vtkCommand::LeftButtonPressEvent
Definition:
vtkCommand.h:293
vtkCommand::StartInteractionEvent
Definition:
vtkCommand.h:322
vtkCommand::AbortCheckEvent
Definition:
vtkCommand.h:291
vtkCommand::VolumeMapperRenderProgressEvent
Definition:
vtkCommand.h:339
vtkCommand::CurrentChangedEvent
Definition:
vtkCommand.h:360
vtkCommand::WindowFrameEvent
Definition:
vtkCommand.h:371
vtkCommand::AnyEvent
Definition:
vtkCommand.h:282
vtkCommand::UnRegisterEvent
Definition:
vtkCommand.h:353
vtkCommand::RenderWindowMessageEvent
Definition:
vtkCommand.h:333
vtkCommand::WidgetValueChangedEvent
Definition:
vtkCommand.h:345
vtkCommand::AbortFlagOn
void AbortFlagOn()
Definition:
vtkCommand.h:253
vtkCommand::WrongTagEvent
Definition:
vtkCommand.h:334
vtkCommand::ExecuteInformationEvent
Definition:
vtkCommand.h:332
vtkCommand::RegisterEvent
Definition:
vtkCommand.h:352
vtkCommand::EnterEvent
Definition:
vtkCommand.h:299
vtkCommand::AnimationCueTickEvent
Definition:
vtkCommand.h:336
vtkCommand::EndInteractionEvent
Definition:
vtkCommand.h:324
vtkCommand::SetOutputEvent
Definition:
vtkCommand.h:319
vtkCommand::HighlightEvent
Definition:
vtkCommand.h:372
vtkCommand::InteractionEvent
Definition:
vtkCommand.h:323
vtkCommand::VolumeMapperComputeGradientsEndEvent
Definition:
vtkCommand.h:341
vtkCommand::ResetCameraEvent
Definition:
vtkCommand.h:312
vtkCommand::CharEvent
Definition:
vtkCommand.h:303
vtkCommand::EndPickEvent
Definition:
vtkCommand.h:290
vtkCommand::CreateTimerEvent
Definition:
vtkCommand.h:327
vtkCommand::ActiveCameraEvent
Definition:
vtkCommand.h:310
vtkCommand::vtkCommand
vtkCommand(const vtkCommand &c)
Definition:
vtkCommand.h:389
vtkCommand::PassiveObserver
int PassiveObserver
Definition:
vtkCommand.h:382
vtkCommand::RightButtonPressEvent
Definition:
vtkCommand.h:297
vtkCommand::SetAbortFlag
void SetAbortFlag(int f)
Definition:
vtkCommand.h:249
vtkCommand::WindowIsDirectEvent
Definition:
vtkCommand.h:374
vtkCommand::AbortFlag
int AbortFlag
Definition:
vtkCommand.h:381
vtkCommand::EndWindowLevelEvent
Definition:
vtkCommand.h:317
vtkCommand::ResetWindowLevelEvent
Definition:
vtkCommand.h:318
vtkCommand::TDxButtonReleaseEvent
Definition:
vtkCommand.h:364
vtkCommand::ErrorEvent
Definition:
vtkCommand.h:320
vtkCommand::PassiveObserverOn
void PassiveObserverOn()
Definition:
vtkCommand.h:268
vtkCommand::ExposeEvent
Definition:
vtkCommand.h:304
vtkCommand::CursorChangedEvent
Definition:
vtkCommand.h:331
vtkCommand::StateChangedEvent
Definition:
vtkCommand.h:368
vtkCommand
superclass for callback/observer methods
Definition:
vtkCommand.h:211
vtkCommand::LeaveEvent
Definition:
vtkCommand.h:300
vtkCommand::ConfigureEvent
Definition:
vtkCommand.h:305
vtkCommand::DisableEvent
Definition:
vtkCommand.h:326
vtkCommand::WarningEvent
Definition:
vtkCommand.h:321
vtkObjectBase::UnRegister
virtual void UnRegister(vtkObjectBase *o)
vtkCommand::VolumeMapperComputeGradientsStartEvent
Definition:
vtkCommand.h:343
vtkCommand::PropertyModifiedEvent
Definition:
vtkCommand.h:350
vtkCommand::VolumeMapperComputeGradientsProgressEvent
Definition:
vtkCommand.h:342
vtkCommand::UpdateInformationEvent
Definition:
vtkCommand.h:354
vtkCommand::PassiveObserverOff
void PassiveObserverOff()
Definition:
vtkCommand.h:270
vtkCommand::ViewProgressEvent
Definition:
vtkCommand.h:358
vtkCommand::KeyReleaseEvent
Definition:
vtkCommand.h:302
vtkCommand::ConnectionCreatedEvent
Definition:
vtkCommand.h:347
vtkCommand::StartWindowLevelEvent
Definition:
vtkCommand.h:316
vtkCommand::WindowSupportsOpenGLEvent
Definition:
vtkCommand.h:373
vtkCommand::LoadStateEvent
Definition:
vtkCommand.h:366
vtkCommand::~vtkCommand
virtual ~vtkCommand()
Definition:
vtkCommand.h:385
vtkCommand::RightButtonReleaseEvent
Definition:
vtkCommand.h:298
vtkCommand::PlacePointEvent
Definition:
vtkCommand.h:329
vtkCommand::SelectionChangedEvent
Definition:
vtkCommand.h:356
VTK_COMMON_EXPORT
#define VTK_COMMON_EXPORT
Definition:
vtkWin32Header.h:269
vtkObjectBase
abstract base class for most VTK objects
Definition:
vtkObjectBase.h:59
vtkCommand::UpdateDataEvent
Definition:
vtkCommand.h:359
vtkCommand::MouseWheelForwardEvent
Definition:
vtkCommand.h:308
vtkCommand::LeftButtonReleaseEvent
Definition:
vtkCommand.h:294
vtkCommand::PlaceWidgetEvent
Definition:
vtkCommand.h:330
vtkCommand::StartAnimationCueEvent
Definition:
vtkCommand.h:335
vtkCommand::EndEvent
Definition:
vtkCommand.h:285
vtkCommand::GetAbortFlag
int GetAbortFlag()
Definition:
vtkCommand.h:251
vtkCommand::UpdatePropertyEvent
Definition:
vtkCommand.h:357
vtkCommand::MouseWheelBackwardEvent
Definition:
vtkCommand.h:309
vtkCommand::WindowIsCurrentEvent
Definition:
vtkCommand.h:370
vtkCommand::ExitEvent
Definition:
vtkCommand.h:292
vtkCommand::StartPickEvent
Definition:
vtkCommand.h:289
vtkCommand::MouseMoveEvent
Definition:
vtkCommand.h:307
vtkCommand::WidgetActivateEvent
Definition:
vtkCommand.h:346
vtkCommand::AnnotationChangedEvent
Definition:
vtkCommand.h:355
vtkCommand::WindowMakeCurrentEvent
Definition:
vtkCommand.h:369
vtkCommand::SaveStateEvent
Definition:
vtkCommand.h:367
vtkCommand::VolumeMapperRenderStartEvent
Definition:
vtkCommand.h:340
vtkCommand::WidgetModifiedEvent
Definition:
vtkCommand.h:344
vtkCommand::TimerEvent
Definition:
vtkCommand.h:306
vtkCommand::RenderEvent
Definition:
vtkCommand.h:286
vtkCommand::GetPassiveObserver
int GetPassiveObserver()
Definition:
vtkCommand.h:266
vtkObject.h
vtkCommand::StartEvent
Definition:
vtkCommand.h:284
vtkObjectBase.h
vtkCommand::VolumeMapperRenderEndEvent
Definition:
vtkCommand.h:338
vtkCommand::PickEvent
Definition:
vtkCommand.h:288
vtkCommand::ComputeVisiblePropBoundsEvent
Definition:
vtkCommand.h:361
vtkCommand::UpdateEvent
Definition:
vtkCommand.h:351
vtkCommand::UnRegister
virtual void UnRegister(vtkObjectBase *)
Definition:
vtkCommand.h:221
vtkCommand::TDxButtonPressEvent
Definition:
vtkCommand.h:363
vtkCommand::ProgressEvent
Definition:
vtkCommand.h:287
vtkCommand::DomainModifiedEvent
Definition:
vtkCommand.h:349
vtkCommand::ConnectionClosedEvent
Definition:
vtkCommand.h:348
Generated on Thu Oct 24 2019 21:14:24 for VTK by
1.8.6