VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkEventForwarderCommand Class Reference

a simple event forwarder command More...

#include <vtkEventForwarderCommand.h>

Inheritance diagram for vtkEventForwarderCommand:
[legend]
Collaboration diagram for vtkEventForwarderCommand:
[legend]

List of all members.

Public Types

typedef vtkCommand Superclass
- Public Types inherited from vtkCommand
enum  EventIds {
  NoEvent = 0, AnyEvent, DeleteEvent, StartEvent,
  EndEvent, RenderEvent, ProgressEvent, PickEvent,
  StartPickEvent, EndPickEvent, AbortCheckEvent, ExitEvent,
  LeftButtonPressEvent, LeftButtonReleaseEvent, MiddleButtonPressEvent, MiddleButtonReleaseEvent,
  RightButtonPressEvent, RightButtonReleaseEvent, EnterEvent, LeaveEvent,
  KeyPressEvent, KeyReleaseEvent, CharEvent, ExposeEvent,
  ConfigureEvent, TimerEvent, MouseMoveEvent, MouseWheelForwardEvent,
  MouseWheelBackwardEvent, ActiveCameraEvent, CreateCameraEvent, ResetCameraEvent,
  ResetCameraClippingRangeEvent, ModifiedEvent, WindowLevelEvent, StartWindowLevelEvent,
  EndWindowLevelEvent, ResetWindowLevelEvent, SetOutputEvent, ErrorEvent,
  WarningEvent, StartInteractionEvent, InteractionEvent, EndInteractionEvent,
  EnableEvent, DisableEvent, CreateTimerEvent, DestroyTimerEvent,
  PlacePointEvent, PlaceWidgetEvent, CursorChangedEvent, ExecuteInformationEvent,
  RenderWindowMessageEvent, WrongTagEvent, StartAnimationCueEvent, AnimationCueTickEvent,
  EndAnimationCueEvent, VolumeMapperRenderEndEvent, VolumeMapperRenderProgressEvent, VolumeMapperRenderStartEvent,
  VolumeMapperComputeGradientsEndEvent, VolumeMapperComputeGradientsProgressEvent, VolumeMapperComputeGradientsStartEvent, WidgetModifiedEvent,
  WidgetValueChangedEvent, WidgetActivateEvent, ConnectionCreatedEvent, ConnectionClosedEvent,
  DomainModifiedEvent, PropertyModifiedEvent, UpdateEvent, RegisterEvent,
  UnRegisterEvent, UpdateInformationEvent, AnnotationChangedEvent, SelectionChangedEvent,
  UpdatePropertyEvent, ViewProgressEvent, UpdateDataEvent, CurrentChangedEvent,
  ComputeVisiblePropBoundsEvent, TDxMotionEvent, TDxButtonPressEvent, TDxButtonReleaseEvent,
  HoverEvent, LoadStateEvent, SaveStateEvent, StateChangedEvent,
  WindowMakeCurrentEvent, WindowIsCurrentEvent, WindowFrameEvent, HighlightEvent,
  WindowSupportsOpenGLEvent, WindowIsDirectEvent, UserEvent = 1000
}

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void Execute (vtkObject *caller, unsigned long eid, void *callData)
virtual void SetTarget (vtkObject *obj)
virtual void * GetTarget ()
- Public Member Functions inherited from vtkCommand
void UnRegister ()
virtual void UnRegister (vtkObjectBase *)
void SetAbortFlag (int f)
int GetAbortFlag ()
void AbortFlagOn ()
void AbortFlagOff ()
void SetPassiveObserver (int f)
int GetPassiveObserver ()
void PassiveObserverOn ()
void PassiveObserverOff ()
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkEventForwarderCommandSafeDownCast (vtkObject *o)
static vtkEventForwarderCommandNew ()
- Static Public Member Functions inherited from vtkCommand
static const char * GetStringFromEventId (unsigned long event)
static unsigned long GetEventIdFromString (const char *event)

Protected Member Functions

 vtkEventForwarderCommand ()
 ~vtkEventForwarderCommand ()
- Protected Member Functions inherited from vtkCommand
 vtkCommand ()
virtual ~vtkCommand ()
 vtkCommand (const vtkCommand &c)
void operator= (const vtkCommand &)
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkObjectTarget
- Protected Attributes inherited from vtkCommand
int AbortFlag
int PassiveObserver
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

a simple event forwarder command

Use vtkEventForwarderCommand to forward an event to a new object. This command will intercept the event, and use InvokeEvent on a 'target' as if that object was the one that invoked the event instead of the object this commmand was attached to using AddObserver.

See also:
vtkCommand

Definition at line 32 of file vtkEventForwarderCommand.h.


Member Typedef Documentation

Reimplemented from vtkCommand.

Definition at line 35 of file vtkEventForwarderCommand.h.


Constructor & Destructor Documentation

vtkEventForwarderCommand::vtkEventForwarderCommand ( )
protected
vtkEventForwarderCommand::~vtkEventForwarderCommand ( )
inlineprotected

Definition at line 60 of file vtkEventForwarderCommand.h.


Member Function Documentation

virtual const char* vtkEventForwarderCommand::GetClassName ( )
virtual

Reimplemented from vtkCommand.

static int vtkEventForwarderCommand::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommand.

virtual int vtkEventForwarderCommand::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCommand.

static vtkEventForwarderCommand* vtkEventForwarderCommand::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkCommand.

static vtkEventForwarderCommand* vtkEventForwarderCommand::New ( )
inlinestatic

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObjectBase.

Definition at line 37 of file vtkEventForwarderCommand.h.

void vtkEventForwarderCommand::Execute ( vtkObject caller,
unsigned long  eid,
void *  callData 
)
virtual

Satisfy the superclass API for callbacks. Recall that the caller is the instance invoking the event; eid is the event id (see vtkCommand.h); and calldata is information sent when the callback was invoked (e.g., progress value in the vtkCommand::ProgressEvent).

Implements vtkCommand.

virtual void vtkEventForwarderCommand::SetTarget ( vtkObject obj)
inlinevirtual

Methods to set and get client and callback information, and the callback function.

Definition at line 49 of file vtkEventForwarderCommand.h.

virtual void* vtkEventForwarderCommand::GetTarget ( )
inlinevirtual

Methods to set and get client and callback information, and the callback function.

Definition at line 51 of file vtkEventForwarderCommand.h.


Member Data Documentation

vtkObject* vtkEventForwarderCommand::Target
protected

Definition at line 57 of file vtkEventForwarderCommand.h.


The documentation for this class was generated from the following file: