ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkButtonWidget Class Reference

vtkButtonWidget - activate an n-state button More...

Inheritance diagram for Kitware.VTK.vtkButtonWidget:
[legend]
Collaboration diagram for Kitware.VTK.vtkButtonWidget:
[legend]

List of all members.

Public Member Functions

 vtkButtonWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkButtonWidget ()
 Instantiate the class.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkButtonRepresentation GetSliderRepresentation ()
 Return the representation as a vtkButtonRepresentation.
override int IsA (string type)
 Standard macros.
new vtkButtonWidget NewInstance ()
 Standard macros.
void SetRepresentation (vtkButtonRepresentation r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.

Static Public Member Functions

static new vtkButtonWidget New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Standard macros.
static new vtkButtonWidget SafeDownCast (vtkObjectBase o)
 Standard macros.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkButtonWidget"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkButtonWidget"
 Automatically generated 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.

Private Member Functions

static internal IntPtr vtkButtonWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkButtonWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkButtonWidget_GetSliderRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkButtonWidget_IsA_03 (HandleRef pThis, string type)
static internal int vtkButtonWidget_IsTypeOf_04 (string type)
static internal IntPtr vtkButtonWidget_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkButtonWidget_SafeDownCast_07 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkButtonWidget_SetRepresentation_08 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkButtonWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkButtonWidget - activate an n-state button

Description The vtkButtonWidget is used to interface with an n-state button. That is each selection moves to the next button state (e.g., moves from "on" to "off"). The widget uses modulo list traversal to transition through one or more states. (A single state is simply a "selection" event; traversal through the list can be in the forward or backward direction.)

Depending on the nature of the representation the appearance of the button can change dramatically, the specifics of appearance changes are a function of the associated vtkButtonRepresentation (or subclass).

Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> LeftButtonPressEvent - select button LeftButtonReleaseEvent - end the button selection process </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkButtonWidget's widget events: <pre> vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed </pre>

In turn, when these widget events are processed, the vtkButtonWidget invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StateChangedEvent (on vtkWidgetEvent::EndSelect) </pre>


Constructor & Destructor Documentation

static Kitware.VTK.vtkButtonWidget.vtkButtonWidget ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Instantiate the class.


Member Function Documentation

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

override void Kitware.VTK.vtkButtonWidget.Dispose ( bool  disposing) [protected]

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

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Return the representation as a vtkButtonRepresentation.

Here is the call graph for this function:

override int Kitware.VTK.vtkButtonWidget.IsA ( string  type) [virtual]

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

static new int Kitware.VTK.vtkButtonWidget.IsTypeOf ( string  type) [static]

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.

static internal void Kitware.VTK.vtkButtonWidget.vtkButtonWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkButtonWidget.vtkButtonWidget_GetSliderRepresentation_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkButtonWidget.vtkButtonWidget_IsA_03 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkButtonWidget.vtkButtonWidget_IsTypeOf_04 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkButtonWidget.vtkButtonWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkButtonWidget.vtkButtonWidget_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkButtonWidget.vtkButtonWidget_SafeDownCast_07 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkButtonWidget.vtkButtonWidget_SetRepresentation_08 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkButtonWidget.MRClassNameKey = "15vtkButtonWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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