vtkEventForwarderCommand Class Reference

#include <vtkEventForwarderCommand.h>

Inheritance diagram for vtkEventForwarderCommand:

Inheritance graph
[legend]
Collaboration diagram for vtkEventForwarderCommand:

Collaboration graph
[legend]

List of all members.


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.


Public Types

typedef vtkCommand Superclass

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 ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkEventForwarderCommandSafeDownCast (vtkObject *o)
static vtkEventForwarderCommandNew ()

Protected Member Functions

 vtkEventForwarderCommand ()
 ~vtkEventForwarderCommand ()

Protected Attributes

vtkObjectTarget

Member Typedef Documentation

Reimplemented from vtkCommand.

Definition at line 35 of file vtkEventForwarderCommand.h.


Constructor & Destructor Documentation

vtkEventForwarderCommand::vtkEventForwarderCommand (  )  [protected]

vtkEventForwarderCommand::~vtkEventForwarderCommand (  )  [inline, protected]

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 (  )  [inline, static]

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  )  [inline, virtual]

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 (  )  [inline, virtual]

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

Definition at line 51 of file vtkEventForwarderCommand.h.


Member Data Documentation

Definition at line 57 of file vtkEventForwarderCommand.h.


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

Generated on Wed Aug 24 11:34:50 2011 for VTK by  doxygen 1.5.6