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

vtkSphereWidget2 - 3D widget for manipulating a point on a sphere More...

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

List of all members.

Public Member Functions

 vtkSphereWidget2 (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSphereWidget2 ()
 Instantiate the object.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set. By default, this is an instance of the vtkSphereRepresentation class.
virtual int GetScalingEnabled ()
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
virtual int GetTranslationEnabled ()
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
override int IsA (string type)
 Standard class methods for type information and printing.
new vtkSphereWidget2 NewInstance ()
 Standard class methods for type information and printing.
virtual void ScalingEnabledOff ()
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
virtual void ScalingEnabledOn ()
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
void SetRepresentation (vtkSphereRepresentation 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.
virtual void SetScalingEnabled (int _arg)
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
virtual void SetTranslationEnabled (int _arg)
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
virtual void TranslationEnabledOff ()
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.
virtual void TranslationEnabledOn ()
 Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

Static Public Member Functions

static new vtkSphereWidget2 New ()
 Instantiate the object.
static new int IsTypeOf (string type)
 Standard class methods for type information and printing.
static new vtkSphereWidget2 SafeDownCast (vtkObjectBase o)
 Standard class methods for type information and printing.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkSphereWidget2"
 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 vtkSphereWidget2_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSphereWidget2_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal int vtkSphereWidget2_GetScalingEnabled_02 (HandleRef pThis)
static internal int vtkSphereWidget2_GetTranslationEnabled_03 (HandleRef pThis)
static internal int vtkSphereWidget2_IsA_04 (HandleRef pThis, string type)
static internal int vtkSphereWidget2_IsTypeOf_05 (string type)
static internal IntPtr vtkSphereWidget2_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSphereWidget2_SafeDownCast_08 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSphereWidget2_ScalingEnabledOff_09 (HandleRef pThis)
static internal void vtkSphereWidget2_ScalingEnabledOn_10 (HandleRef pThis)
static internal void vtkSphereWidget2_SetRepresentation_11 (HandleRef pThis, HandleRef r)
static internal void vtkSphereWidget2_SetScalingEnabled_12 (HandleRef pThis, int _arg)
static internal void vtkSphereWidget2_SetTranslationEnabled_13 (HandleRef pThis, int _arg)
static internal void vtkSphereWidget2_TranslationEnabledOff_14 (HandleRef pThis)
static internal void vtkSphereWidget2_TranslationEnabledOn_15 (HandleRef pThis)

Static Private Member Functions

static vtkSphereWidget2 ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSphereWidget2 - 3D widget for manipulating a point on a sphere

Description This 3D widget interacts with a vtkSphereRepresentation class (i.e., it handles the events that drive its corresponding representation). It can be used to position a point on a sphere (for example, to place a light or camera), or to position a sphere in a scene, including translating and scaling the sphere.

A nice feature of vtkSphereWidget2, like any 3D widget, is that it will work in combination with the current interactor style (or any other interactor observer). That is, if vtkSphereWidget2 does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkSphereWidget2 will terminate the processing of the event that it handles.

To use this widget, you generally pair it with a vtkSphereRepresentation (or a subclass). Variuos options are available in the representation for controlling how the widget appears, and how the widget functions.

Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> If the handle or sphere are selected: LeftButtonPressEvent - select the handle or sphere LeftButtonReleaseEvent - release the handle ot sphere MouseMoveEvent - move the handle or translate the sphere In all the cases, independent of what is picked, the widget responds to the following VTK events: MiddleButtonPressEvent - translate the representation MiddleButtonReleaseEvent - stop translating the representation RightButtonPressEvent - scale the widget's representation RightButtonReleaseEvent - stop scaling the representation MouseMoveEvent - scale (if right button) or move (if middle button) the widget </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkSphereWidget2's widget events: <pre> vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Scale -- some part of the widget has been selected vtkWidgetEvent::EndScale -- the selection process has completed vtkWidgetEvent::Translate -- some part of the widget has been selected vtkWidgetEvent::EndTranslate -- the selection process has completed vtkWidgetEvent::Move -- a request for motion has been invoked </pre>

In turn, when these widget events are processed, the vtkSphereWidget2 invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move) </pre>


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Instantiate the object.


Member Function Documentation

Create the default widget representation if one is not set. By default, this is an instance of the vtkSphereRepresentation class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

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

Standard class methods for type information and printing.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Standard class methods for type information and printing.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

Standard class methods for type information and printing.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard class methods for type information and printing.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

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.

virtual void Kitware.VTK.vtkSphereWidget2.SetScalingEnabled ( int  _arg) [virtual]

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

virtual void Kitware.VTK.vtkSphereWidget2.SetTranslationEnabled ( int  _arg) [virtual]

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

Control the behavior of the widget (i.e., how it processes events). Translation, and scaling can all be enabled and disabled.

static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_GetScalingEnabled_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_GetTranslationEnabled_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_IsA_04 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_IsTypeOf_05 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_NewInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_SafeDownCast_08 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_ScalingEnabledOff_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_ScalingEnabledOn_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_SetRepresentation_11 ( HandleRef  pThis,
HandleRef  r 
) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_SetScalingEnabled_12 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_SetTranslationEnabled_13 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_TranslationEnabledOff_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSphereWidget2.vtkSphereWidget2_TranslationEnabledOn_15 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSphereWidget2.MRClassNameKey = "16vtkSphereWidget2" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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