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.vtkTexturedButtonRepresentation Class Reference

vtkTexturedButtonRepresentation - defines a representation for a vtkButtonWidget More...

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

List of all members.

Public Member Functions

 vtkTexturedButtonRepresentation (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTexturedButtonRepresentation ()
 Instantiate the class.
override void BuildRepresentation ()
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API.
override int ComputeInteractionState (int X, int Y, int modify)
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API.
virtual void FollowCameraOff ()
 Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.
virtual void FollowCameraOn ()
 Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.
override void GetActors (vtkPropCollection pc)
 Provide the necessary methods to satisfy the rendering API.
override double[] GetBounds ()
 Provide the necessary methods to satisfy the rendering API.
vtkPolyData GetButtonGeometry ()
 Set/Get the polydata which defines the button geometry.
vtkImageData GetButtonTexture (int i)
 Add the ith texture corresponding to the ith button state. The parameter i should be (0 <= i < NumberOfStates).
virtual int GetFollowCamera ()
 Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.
virtual vtkProperty GetHoveringProperty ()
 Specify the property to use when the hovering over the button.
virtual vtkProperty GetProperty ()
 Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.
virtual vtkProperty GetSelectingProperty ()
 Specify the property to use when selecting the button.
override int HasTranslucentPolygonalGeometry ()
 Provide the necessary methods to satisfy the rendering API.
override void Highlight (int state)
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API.
override int IsA (string type)
 Standard methods for instances of the class.
new vtkTexturedButtonRepresentation NewInstance ()
 Standard methods for instances of the class.
virtual void PlaceWidget (double scale, IntPtr point, IntPtr normal)
 Alternative method for placing a button at a given position (defined by point[3]); at a given orientation (normal[3], where the z-axis of the button geometry is parallel to the normal); and scaled by the scale parameter. This method can bs used to attach "sticky notes" or "sticky buttons" to objects. A great way to attach interactive meta-data to 3D actors.
override void PlaceWidget (IntPtr bounds)
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API.
override void ReleaseGraphicsResources (vtkWindow arg0)
 Provide the necessary methods to satisfy the rendering API.
override int RenderOpaqueGeometry (vtkViewport arg0)
 Provide the necessary methods to satisfy the rendering API.
override int RenderTranslucentPolygonalGeometry (vtkViewport arg0)
 Provide the necessary methods to satisfy the rendering API.
void SetButtonGeometry (vtkPolyData pd)
 Set/Get the polydata which defines the button geometry.
void SetButtonGeometryConnection (vtkAlgorithmOutput algOutput)
 Set/Get the polydata which defines the button geometry.
void SetButtonTexture (int i, vtkImageData image)
 Add the ith texture corresponding to the ith button state. The parameter i should be (0 <= i < NumberOfStates).
virtual void SetFollowCamera (int _arg)
 Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.
virtual void SetHoveringProperty (vtkProperty p)
 Specify the property to use when the hovering over the button.
virtual void SetProperty (vtkProperty p)
 Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.
virtual void SetSelectingProperty (vtkProperty p)
 Specify the property to use when selecting the button.
override void ShallowCopy (vtkProp prop)
 Provide the necessary methods to satisfy the rendering API.

Static Public Member Functions

static new
vtkTexturedButtonRepresentation 
New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Standard methods for instances of the class.
static new
vtkTexturedButtonRepresentation 
SafeDownCast (vtkObjectBase o)
 Standard methods for instances of the class.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "31vtkTexturedButtonRepresentation"
 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 vtkTexturedButtonRepresentation_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTexturedButtonRepresentation_BuildRepresentation_01 (HandleRef pThis)
static internal int vtkTexturedButtonRepresentation_ComputeInteractionState_02 (HandleRef pThis, int X, int Y, int modify)
static internal void vtkTexturedButtonRepresentation_FollowCameraOff_03 (HandleRef pThis)
static internal void vtkTexturedButtonRepresentation_FollowCameraOn_04 (HandleRef pThis)
static internal void vtkTexturedButtonRepresentation_GetActors_05 (HandleRef pThis, HandleRef pc)
static internal IntPtr vtkTexturedButtonRepresentation_GetBounds_06 (HandleRef pThis)
static internal IntPtr vtkTexturedButtonRepresentation_GetButtonGeometry_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTexturedButtonRepresentation_GetButtonTexture_08 (HandleRef pThis, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTexturedButtonRepresentation_GetFollowCamera_09 (HandleRef pThis)
static internal IntPtr vtkTexturedButtonRepresentation_GetHoveringProperty_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTexturedButtonRepresentation_GetProperty_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTexturedButtonRepresentation_GetSelectingProperty_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTexturedButtonRepresentation_HasTranslucentPolygonalGeometry_13 (HandleRef pThis)
static internal void vtkTexturedButtonRepresentation_Highlight_14 (HandleRef pThis, int state)
static internal int vtkTexturedButtonRepresentation_IsA_15 (HandleRef pThis, string type)
static internal int vtkTexturedButtonRepresentation_IsTypeOf_16 (string type)
static internal IntPtr vtkTexturedButtonRepresentation_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTexturedButtonRepresentation_PlaceWidget_19 (HandleRef pThis, double scale, IntPtr point, IntPtr normal)
static internal void vtkTexturedButtonRepresentation_PlaceWidget_20 (HandleRef pThis, IntPtr bounds)
static internal void vtkTexturedButtonRepresentation_ReleaseGraphicsResources_21 (HandleRef pThis, HandleRef arg0)
static internal int vtkTexturedButtonRepresentation_RenderOpaqueGeometry_22 (HandleRef pThis, HandleRef arg0)
static internal int vtkTexturedButtonRepresentation_RenderTranslucentPolygonalGeometry_23 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkTexturedButtonRepresentation_SafeDownCast_24 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTexturedButtonRepresentation_SetButtonGeometry_25 (HandleRef pThis, HandleRef pd)
static internal void vtkTexturedButtonRepresentation_SetButtonGeometryConnection_26 (HandleRef pThis, HandleRef algOutput)
static internal void vtkTexturedButtonRepresentation_SetButtonTexture_27 (HandleRef pThis, int i, HandleRef image)
static internal void vtkTexturedButtonRepresentation_SetFollowCamera_28 (HandleRef pThis, int _arg)
static internal void vtkTexturedButtonRepresentation_SetHoveringProperty_29 (HandleRef pThis, HandleRef p)
static internal void vtkTexturedButtonRepresentation_SetProperty_30 (HandleRef pThis, HandleRef p)
static internal void vtkTexturedButtonRepresentation_SetSelectingProperty_31 (HandleRef pThis, HandleRef p)
static internal void vtkTexturedButtonRepresentation_ShallowCopy_32 (HandleRef pThis, HandleRef prop)

Static Private Member Functions

static vtkTexturedButtonRepresentation ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTexturedButtonRepresentation - defines a representation for a vtkButtonWidget

Description This class implements one type of vtkButtonRepresentation. It changes the appearance of a user-provided polydata by assigning textures according to the current button state. It also provides highlighting (when hovering and selecting the button) by fiddling with the actor's property.

To use this representation, always begin by specifying the number of button states. Then provide a polydata (the polydata should have associated texture coordinates), and a list of textures cooresponding to the button states. Optionally, the HoveringProperty and SelectionProperty can be adjusted to obtain the appropriate appearance.

This widget representation has two placement methods. The conventional PlaceWidget() method is used to locate the textured button inside of a user-specified bounding box (note that the button geometry is uniformly scaled to fit, thus two of the three dimensions can be "large" and the third used to perform the scaling). However this PlaceWidget() method will align the geometry within x-y-z oriented bounds. To further control the placement, use the additional PlaceWidget(scale,point,normal) method. This scales the geometry, places its center at the specified point position, and orients the geometry's z-direction parallel to the specified normal. This can be used to attach "sticky notes" or "sticky buttons" to the surface of objects.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate the class.


Member Function Documentation

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

override int Kitware.VTK.vtkTexturedButtonRepresentation.ComputeInteractionState ( int  X,
int  Y,
int  modify 
) [virtual]

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

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

Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.

Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Set/Get the polydata which defines the button geometry.

Here is the call graph for this function:

Add the ith texture corresponding to the ith button state. The parameter i should be (0 <= i < NumberOfStates).

Here is the call graph for this function:

Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.

Specify the property to use when the hovering over the button.

Here is the call graph for this function:

Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.

Here is the call graph for this function:

Specify the property to use when selecting the button.

Here is the call graph for this function:

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

override void Kitware.VTK.vtkTexturedButtonRepresentation.Highlight ( int  state) [virtual]

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

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

Standard methods for instances of the class.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

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

Standard methods for instances of the class.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

Standard methods for instances of the class.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

virtual void Kitware.VTK.vtkTexturedButtonRepresentation.PlaceWidget ( double  scale,
IntPtr  point,
IntPtr  normal 
) [virtual]

Alternative method for placing a button at a given position (defined by point[3]); at a given orientation (normal[3], where the z-axis of the button geometry is parallel to the normal); and scaled by the scale parameter. This method can bs used to attach "sticky notes" or "sticky buttons" to objects. A great way to attach interactive meta-data to 3D actors.

override void Kitware.VTK.vtkTexturedButtonRepresentation.PlaceWidget ( IntPtr  bounds) [virtual]

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkWidgetRepresentation.

Standard methods for instances of the class.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

Here is the call graph for this function:

Set/Get the polydata which defines the button geometry.

Set/Get the polydata which defines the button geometry.

Add the ith texture corresponding to the ith button state. The parameter i should be (0 <= i < NumberOfStates).

Specify whether the button should always face the camera. If enabled, the button rotates as the camera moves.

Specify the property to use when the hovering over the button.

Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.

Specify the property to use when selecting the button.

Provide the necessary methods to satisfy the rendering API.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

static internal int Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_ComputeInteractionState_02 ( HandleRef  pThis,
int  X,
int  Y,
int  modify 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_GetActors_05 ( HandleRef  pThis,
HandleRef  pc 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_GetButtonGeometry_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_GetButtonTexture_08 ( HandleRef  pThis,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_GetHoveringProperty_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_GetProperty_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_GetSelectingProperty_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_Highlight_14 ( HandleRef  pThis,
int  state 
) [private]
static internal int Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_IsA_15 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_PlaceWidget_19 ( HandleRef  pThis,
double  scale,
IntPtr  point,
IntPtr  normal 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_PlaceWidget_20 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_ReleaseGraphicsResources_21 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_RenderOpaqueGeometry_22 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SafeDownCast_24 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetButtonGeometry_25 ( HandleRef  pThis,
HandleRef  pd 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetButtonGeometryConnection_26 ( HandleRef  pThis,
HandleRef  algOutput 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetButtonTexture_27 ( HandleRef  pThis,
int  i,
HandleRef  image 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetFollowCamera_28 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetHoveringProperty_29 ( HandleRef  pThis,
HandleRef  p 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetProperty_30 ( HandleRef  pThis,
HandleRef  p 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_SetSelectingProperty_31 ( HandleRef  pThis,
HandleRef  p 
) [private]
static internal void Kitware.VTK.vtkTexturedButtonRepresentation.vtkTexturedButtonRepresentation_ShallowCopy_32 ( HandleRef  pThis,
HandleRef  prop 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTexturedButtonRepresentation.MRClassNameKey = "31vtkTexturedButtonRepresentation" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkButtonRepresentation.


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