ActiViz .NET  5.10.1
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
vtkObjectEventRelay Class Reference

Implement a relay handler for VTK events. This is a class that receives events directly from the VTK object sender and transforms them into calls to .NET delegates. More...

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

Public Member Functions

 vtkObjectEventRelay (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly. More...
 
 vtkObjectEventRelay (Kitware.VTK.vtkObject sender, uint eventId)
 Construct a vtkObjectEventRelay object that will call "handler" when its Execute method gets called. Typically, it is not necessary to create instances of vtkObjectEventRelay from client applications. Usually, clients will just connect to ActiViz.NET events, which use vtkObjectEventRelay internally. However, vtkObjectEventRelay is suitable for use as the vtkCommand parameter to AddObserver calls. More...
 
delegate void RelayHandler (IntPtr caller, uint eventId, IntPtr callData)
 Signature for method that vtkObject can call for VTK events. More...
 
void Execute (IntPtr caller, uint eventId, IntPtr callData)
 Do not call directly. This method is called from VTK library code when InvokeEvent is called on a vtkObject. More...
 
void AddHandler (Kitware.VTK.vtkObject.vtkObjectEventHandler handler)
 AddHandler adds a managed/.NET event handler to this event relay object. If this is the first time a handler is being added, we call AddObserver so that the underlying VTK object will invoke the event from now on. More...
 
void RemoveHandler (Kitware.VTK.vtkObject.vtkObjectEventHandler handler)
 RemoveHandler removes a managed/.NET event handler previously added to this event relay object. If this is the last handler being removed, we call RemoveObserver so that the underlying VTK object will no longer send the event to us. More...
 
bool HasHandlers ()
 HasHandlers returns true if this event presently has any managed/.NET handlers. More...
 
void RemoveAllHandlers ()
 RemoveAllHandlers forcibly removes all existing handlers from its list. Sender should call this method from its Dispose if it has one. More...
 

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkObjectEventRelay"
 Type registration mechanics. More...
 

Static Public Attributes

static new readonly string MRClassNameKey = "class vtkObjectEventRelay"
 Type registration mechanics. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly. More...
 

Private Member Functions

uint AddObserver ()
 
void RemoveObserver (uint observerId)
 
void CallAddObserver ()
 
void CallRemoveObserver ()
 

Static Private Member Functions

static vtkObjectEventRelay ()
 Type registration mechanics. More...
 

Private Attributes

Kitware.VTK.vtkObject Sender
 
uint EventId
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EventImpl
 
uint ObserverId
 
RelayHandler RelayHandlerDelegate
 

Detailed Description

Implement a relay handler for VTK events. This is a class that receives events directly from the VTK object sender and transforms them into calls to .NET delegates.

Constructor & Destructor Documentation

static vtkObjectEventRelay.vtkObjectEventRelay ( )
staticprivate

Type registration mechanics.

vtkObjectEventRelay.vtkObjectEventRelay ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

vtkObjectEventRelay.vtkObjectEventRelay ( Kitware.VTK.vtkObject  sender,
uint  eventId 
)

Construct a vtkObjectEventRelay object that will call "handler" when its Execute method gets called. Typically, it is not necessary to create instances of vtkObjectEventRelay from client applications. Usually, clients will just connect to ActiViz.NET events, which use vtkObjectEventRelay internally. However, vtkObjectEventRelay is suitable for use as the vtkCommand parameter to AddObserver calls.

Member Function Documentation

void vtkObjectEventRelay.AddHandler ( Kitware.VTK.vtkObject.vtkObjectEventHandler  handler)

AddHandler adds a managed/.NET event handler to this event relay object. If this is the first time a handler is being added, we call AddObserver so that the underlying VTK object will invoke the event from now on.

Here is the call graph for this function:

uint vtkObjectEventRelay.AddObserver ( )
private

Here is the call graph for this function:

void vtkObjectEventRelay.CallAddObserver ( )
private

Here is the call graph for this function:

void vtkObjectEventRelay.CallRemoveObserver ( )
private

Here is the call graph for this function:

override void vtkObjectEventRelay.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

void vtkObjectEventRelay.Execute ( IntPtr  caller,
uint  eventId,
IntPtr  callData 
)

Do not call directly. This method is called from VTK library code when InvokeEvent is called on a vtkObject.

bool vtkObjectEventRelay.HasHandlers ( )

HasHandlers returns true if this event presently has any managed/.NET handlers.

delegate void vtkObjectEventRelay.RelayHandler ( IntPtr  caller,
uint  eventId,
IntPtr  callData 
)

Signature for method that vtkObject can call for VTK events.

void vtkObjectEventRelay.RemoveAllHandlers ( )

RemoveAllHandlers forcibly removes all existing handlers from its list. Sender should call this method from its Dispose if it has one.

Here is the call graph for this function:

void vtkObjectEventRelay.RemoveHandler ( Kitware.VTK.vtkObject.vtkObjectEventHandler  handler)

RemoveHandler removes a managed/.NET event handler previously added to this event relay object. If this is the last handler being removed, we call RemoveObserver so that the underlying VTK object will no longer send the event to us.

Here is the call graph for this function:

void vtkObjectEventRelay.RemoveObserver ( uint  observerId)
private

Member Data Documentation

uint vtkObjectEventRelay.EventId
private
Kitware.VTK.vtkObject.vtkObjectEventHandler vtkObjectEventRelay.EventImpl
private
new readonly string vtkObjectEventRelay.MRClassNameKey = "class vtkObjectEventRelay"
static

Type registration mechanics.

new const string vtkObjectEventRelay.MRFullTypeName = "Kitware.VTK.vtkObjectEventRelay"

Type registration mechanics.

uint vtkObjectEventRelay.ObserverId
private
RelayHandler vtkObjectEventRelay.RelayHandlerDelegate
private
Kitware.VTK.vtkObject vtkObjectEventRelay.Sender
private

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