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

vtkButtonRepresentation - abstract class defines the representation for a vtkButtonWidget More...

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

List of all members.

Public Types

enum  _HighlightState { HighlightHovering = 1, HighlightNormal = 0, HighlightSelecting = 2 }
 ETX. More...
enum  _InteractionState { Inside = 1, Outside = 0 }
 Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases. More...

Public Member Functions

 vtkButtonRepresentation (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual int GetHighlightState ()
 ETX.
virtual int GetNumberOfStatesMaxValue ()
 Retrieve the current button state.
virtual int GetNumberOfStatesMinValue ()
 Retrieve the current button state.
virtual int GetState ()
 Retrieve the current button state.
override void Highlight (int arg0)
 ETX.
override int IsA (string type)
 Standard methods for the class.
new vtkButtonRepresentation NewInstance ()
 Standard methods for the class.
virtual void NextState ()
 Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.
virtual void PreviousState ()
 Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.
virtual void SetNumberOfStates (int _arg)
 Retrieve the current button state.
virtual void SetState (int state)
 Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.
override void ShallowCopy (vtkProp prop)
 ETX.

Static Public Member Functions

static new int IsTypeOf (string type)
 Standard methods for the class.
static new vtkButtonRepresentation SafeDownCast (vtkObjectBase o)
 Standard methods for the class.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "23vtkButtonRepresentation"
 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 int vtkButtonRepresentation_GetHighlightState_01 (HandleRef pThis)
static internal int vtkButtonRepresentation_GetNumberOfStatesMaxValue_02 (HandleRef pThis)
static internal int vtkButtonRepresentation_GetNumberOfStatesMinValue_03 (HandleRef pThis)
static internal int vtkButtonRepresentation_GetState_04 (HandleRef pThis)
static internal void vtkButtonRepresentation_Highlight_05 (HandleRef pThis, int arg0)
static internal int vtkButtonRepresentation_IsA_06 (HandleRef pThis, string type)
static internal int vtkButtonRepresentation_IsTypeOf_07 (string type)
static internal IntPtr vtkButtonRepresentation_NewInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkButtonRepresentation_NextState_09 (HandleRef pThis)
static internal void vtkButtonRepresentation_PreviousState_10 (HandleRef pThis)
static internal IntPtr vtkButtonRepresentation_SafeDownCast_11 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkButtonRepresentation_SetNumberOfStates_12 (HandleRef pThis, int _arg)
static internal void vtkButtonRepresentation_SetState_13 (HandleRef pThis, int state)
static internal void vtkButtonRepresentation_ShallowCopy_14 (HandleRef pThis, HandleRef prop)

Static Private Member Functions

static vtkButtonRepresentation ()
 Automatically generated type registration mechanics.

Detailed Description

vtkButtonRepresentation - abstract class defines the representation for a vtkButtonWidget

Description This abstract class is used to specify how the vtkButtonWidget should interact with representations of the vtkButtonWidget. This class may be subclassed so that alternative representations can be created. The class defines an API, and a default implementation, that the vtkButtonWidget interacts with to render itself in the scene.

The vtkButtonWidget assumes an n-state button so that traveral methods are available for changing, querying and manipulating state. Derived classed determine the actual appearance. The state is represented by an integral value 0<=state<numStates.

To use this representation, always begin by specifying the number of states. Then follow with the necessary information to represent each state (done through a subclass API).


Member Enumeration Documentation

ETX.

Enumerator:
HighlightHovering 

enum member

HighlightNormal 

enum member

HighlightSelecting 

enum member

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

Enumerator:
Inside 

enum member

Outside 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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


Member Function Documentation

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

Reimplemented in Kitware.VTK.vtkTexturedButtonRepresentation, Kitware.VTK.vtkProp3DButtonRepresentation, and Kitware.VTK.vtkTexturedButtonRepresentation2D.

ETX.

Retrieve the current button state.

Retrieve the current button state.

Retrieve the current button state.

override void Kitware.VTK.vtkButtonRepresentation.Highlight ( int  arg0) [virtual]
override int Kitware.VTK.vtkButtonRepresentation.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkButtonRepresentation.IsTypeOf ( string  type) [static]

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

Standard methods for the class.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Reimplemented in Kitware.VTK.vtkTexturedButtonRepresentation, Kitware.VTK.vtkTexturedButtonRepresentation2D, and Kitware.VTK.vtkProp3DButtonRepresentation.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkButtonRepresentation.SetNumberOfStates ( int  _arg) [virtual]

Retrieve the current button state.

virtual void Kitware.VTK.vtkButtonRepresentation.SetState ( int  state) [virtual]

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

Reimplemented in Kitware.VTK.vtkProp3DButtonRepresentation.

override void Kitware.VTK.vtkButtonRepresentation.ShallowCopy ( vtkProp  prop) [virtual]
static internal int Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_GetState_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_Highlight_05 ( HandleRef  pThis,
int  arg0 
) [private]
static internal int Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_IsA_06 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_IsTypeOf_07 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_NewInstance_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_NextState_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_PreviousState_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_SafeDownCast_11 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_SetNumberOfStates_12 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_SetState_13 ( HandleRef  pThis,
int  state 
) [private]
static internal void Kitware.VTK.vtkButtonRepresentation.vtkButtonRepresentation_ShallowCopy_14 ( HandleRef  pThis,
HandleRef  prop 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkButtonRepresentation.MRClassNameKey = "23vtkButtonRepresentation" [static]
new const string Kitware.VTK.vtkButtonRepresentation.MRFullTypeName = "Kitware.VTK.vtkButtonRepresentation"

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