ActiViz .NET  5.8.0
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Kitware.VTK.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 Kitware.VTK.vtkObjectEventRelay:
[legend]
Collaboration diagram for Kitware.VTK.vtkObjectEventRelay:
[legend]

Public Member Functions

 vtkObjectEventRelay (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 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.
delegate void RelayHandler (IntPtr caller, uint eventId, IntPtr callData)
 Signature for method that vtkObject can call for VTK events.
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.
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.
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.
bool HasHandlers ()
 HasHandlers returns true if this event presently has any managed/.NET handlers.
void RemoveAllHandlers ()
 RemoveAllHandlers forcibly removes all existing handlers from its list. Sender should call this method from its Dispose if it has one.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkObjectEventRelay"
 Type registration mechanics.
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

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

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.
- Protected Member Functions inherited from Kitware.VTK.WrappedObject
 WrappedObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Constructor expected by the mummy Runtime.

Private Member Functions

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

Static Private Member Functions

static vtkObjectEventRelay ()
 Type registration mechanics.

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 Kitware.VTK.vtkObjectEventRelay.vtkObjectEventRelay ( )
staticprivate

Type registration mechanics.

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

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

Kitware.VTK.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 Kitware.VTK.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.

uint Kitware.VTK.vtkObjectEventRelay.AddObserver ( )
private
void Kitware.VTK.vtkObjectEventRelay.CallAddObserver ( )
private
void Kitware.VTK.vtkObjectEventRelay.CallRemoveObserver ( )
private
override void Kitware.VTK.vtkObjectEventRelay.Dispose ( bool  disposing)
protected

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

void Kitware.VTK.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 Kitware.VTK.vtkObjectEventRelay.HasHandlers ( )

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

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

Signature for method that vtkObject can call for VTK events.

void Kitware.VTK.vtkObjectEventRelay.RemoveAllHandlers ( )

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

void Kitware.VTK.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.

void Kitware.VTK.vtkObjectEventRelay.RemoveObserver ( uint  observerId)
private

Member Data Documentation

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

Type registration mechanics.

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

Type registration mechanics.

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

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