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

vtkOrientationMarkerWidget - 2D widget for manipulating a marker prop More...

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

List of all members.

Public Member Functions

 vtkOrientationMarkerWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkOrientationMarkerWidget ()
 Undocumented Block.
void ExecuteCameraUpdateEvent (vtkObject o, uint arg1, IntPtr calldata)
 Callback to keep the camera for the orientation marker up to date with the camera in the parent renderer.
virtual int GetInteractive ()
 Set/get whether to allow this widget to be interactively moved/scaled. Default is On.
virtual vtkProp GetOrientationMarker ()
 Set/get the orientation marker to be displayed in this widget.
IntPtr GetOutlineColor ()
 Set/get the color of the outline of this widget. The outline is visible when (in interactive mode) the cursor is over this widget. Default is white (1,1,1).
virtual int GetTolerance ()
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).
virtual int GetToleranceMaxValue ()
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).
virtual int GetToleranceMinValue ()
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).
IntPtr GetViewport ()
 Set/get the viewport to position/size this widget. Default is bottom left corner (0,0,0.2,0.2).
virtual void InteractiveOff ()
 Set/get whether to allow this widget to be interactively moved/scaled. Default is On.
virtual void InteractiveOn ()
 Set/get whether to allow this widget to be interactively moved/scaled. Default is On.
override int IsA (string type)
 Undocumented Block.
new vtkOrientationMarkerWidget NewInstance ()
 Undocumented Block.
override void SetEnabled (int arg0)
 Enable/disable the widget. Default is 0 (disabled).
void SetInteractive (int state)
 Set/get whether to allow this widget to be interactively moved/scaled. Default is On.
virtual void SetOrientationMarker (vtkProp prop)
 Set/get the orientation marker to be displayed in this widget.
void SetOutlineColor (double r, double g, double b)
 Set/get the color of the outline of this widget. The outline is visible when (in interactive mode) the cursor is over this widget. Default is white (1,1,1).
virtual void SetTolerance (int _arg)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).
void SetViewport (double minX, double minY, double maxX, double maxY)
 Set/get the viewport to position/size this widget. Default is bottom left corner (0,0,0.2,0.2).

Static Public Member Functions

static new
vtkOrientationMarkerWidget 
New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkOrientationMarkerWidget 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "26vtkOrientationMarkerWidget"
 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 vtkOrientationMarkerWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkOrientationMarkerWidget_ExecuteCameraUpdateEvent_01 (HandleRef pThis, HandleRef o, uint arg1, IntPtr calldata)
static internal int vtkOrientationMarkerWidget_GetInteractive_02 (HandleRef pThis)
static internal IntPtr vtkOrientationMarkerWidget_GetOrientationMarker_03 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkOrientationMarkerWidget_GetOutlineColor_04 (HandleRef pThis)
static internal int vtkOrientationMarkerWidget_GetTolerance_05 (HandleRef pThis)
static internal int vtkOrientationMarkerWidget_GetToleranceMaxValue_06 (HandleRef pThis)
static internal int vtkOrientationMarkerWidget_GetToleranceMinValue_07 (HandleRef pThis)
static internal IntPtr vtkOrientationMarkerWidget_GetViewport_08 (HandleRef pThis)
static internal void vtkOrientationMarkerWidget_InteractiveOff_09 (HandleRef pThis)
static internal void vtkOrientationMarkerWidget_InteractiveOn_10 (HandleRef pThis)
static internal int vtkOrientationMarkerWidget_IsA_11 (HandleRef pThis, string type)
static internal int vtkOrientationMarkerWidget_IsTypeOf_12 (string type)
static internal IntPtr vtkOrientationMarkerWidget_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkOrientationMarkerWidget_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkOrientationMarkerWidget_SetEnabled_16 (HandleRef pThis, int arg0)
static internal void vtkOrientationMarkerWidget_SetInteractive_17 (HandleRef pThis, int state)
static internal void vtkOrientationMarkerWidget_SetOrientationMarker_18 (HandleRef pThis, HandleRef prop)
static internal void vtkOrientationMarkerWidget_SetOutlineColor_19 (HandleRef pThis, double r, double g, double b)
static internal void vtkOrientationMarkerWidget_SetTolerance_20 (HandleRef pThis, int _arg)
static internal void vtkOrientationMarkerWidget_SetViewport_21 (HandleRef pThis, double minX, double minY, double maxX, double maxY)

Static Private Member Functions

static vtkOrientationMarkerWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkOrientationMarkerWidget - 2D widget for manipulating a marker prop

Description This class provides support for interactively manipulating the position, size, and apparent orientation of a prop that represents an orientation marker. This class works by adding its internal renderer to an external "parent" renderer on a different layer. The input orientation marker is rendered as an overlay on the parent renderer and, thus, appears superposed over all props in the parent's scene. The camera view of the orientation the marker is made to match that of the parent's by means of an observer mechanism, giving the illusion that the orientation of the marker reflects that of the prop(s) in the parent's scene.

The widget listens to left mouse button and mouse movement events. It will change the cursor shape based on its location. If the cursor is over the overlay renderer, it will change the cursor shape to a SIZEALL shape or to a resize corner shape (e.g., SIZENW) if the cursor is near a corner. If the left mouse button is pressed and held down while moving, the overlay renderer, and hence, the orientation marker, is resized or moved. I the case of a resize operation, releasing the left mouse button causes the widget to enforce its renderer to be square. The diagonally opposite corner to the one moved is repositioned such that all edges of the renderer have the same length: the minimum.

To use this object, there are two key steps: 1) invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor, and 2) invoke SetOrientationMarker with an instance of vtkProp (see caveats below). Specifically, vtkAxesActor and vtkAnnotatedCubeActor are two classes designed to work with this class. A composite orientation marker can be generated by adding instances of vtkAxesActor and vtkAnnotatedCubeActor to a vtkPropAssembly, which can then be set as the input orientation marker. The widget can be also be set up in a non-interactive fashion by setting Ineractive to Off and sizing/placing the overlay renderer in its parent renderer by calling the widget's SetViewport method.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

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

void Kitware.VTK.vtkOrientationMarkerWidget.ExecuteCameraUpdateEvent ( vtkObject  o,
uint  arg1,
IntPtr  calldata 
)

Callback to keep the camera for the orientation marker up to date with the camera in the parent renderer.

Set/get whether to allow this widget to be interactively moved/scaled. Default is On.

Set/get the orientation marker to be displayed in this widget.

Here is the call graph for this function:

Set/get the color of the outline of this widget. The outline is visible when (in interactive mode) the cursor is over this widget. Default is white (1,1,1).

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

Set/get the viewport to position/size this widget. Default is bottom left corner (0,0,0.2,0.2).

Set/get whether to allow this widget to be interactively moved/scaled. Default is On.

Set/get whether to allow this widget to be interactively moved/scaled. Default is On.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Here is the call graph for this function:

override void Kitware.VTK.vtkOrientationMarkerWidget.SetEnabled ( int  arg0) [virtual]

Enable/disable the widget. Default is 0 (disabled).

Reimplemented from Kitware.VTK.vtkInteractorObserver.

Set/get whether to allow this widget to be interactively moved/scaled. Default is On.

Set/get the orientation marker to be displayed in this widget.

void Kitware.VTK.vtkOrientationMarkerWidget.SetOutlineColor ( double  r,
double  g,
double  b 
)

Set/get the color of the outline of this widget. The outline is visible when (in interactive mode) the cursor is over this widget. Default is white (1,1,1).

virtual void Kitware.VTK.vtkOrientationMarkerWidget.SetTolerance ( int  _arg) [virtual]

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

void Kitware.VTK.vtkOrientationMarkerWidget.SetViewport ( double  minX,
double  minY,
double  maxX,
double  maxY 
)

Set/get the viewport to position/size this widget. Default is bottom left corner (0,0,0.2,0.2).

static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_ExecuteCameraUpdateEvent_01 ( HandleRef  pThis,
HandleRef  o,
uint  arg1,
IntPtr  calldata 
) [private]
static internal IntPtr Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_GetOrientationMarker_03 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_GetOutlineColor_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_GetViewport_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SetEnabled_16 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SetInteractive_17 ( HandleRef  pThis,
int  state 
) [private]
static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SetOrientationMarker_18 ( HandleRef  pThis,
HandleRef  prop 
) [private]
static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SetOutlineColor_19 ( HandleRef  pThis,
double  r,
double  g,
double  b 
) [private]
static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SetTolerance_20 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkOrientationMarkerWidget.vtkOrientationMarkerWidget_SetViewport_21 ( HandleRef  pThis,
double  minX,
double  minY,
double  maxX,
double  maxY 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkOrientationMarkerWidget.MRClassNameKey = "26vtkOrientationMarkerWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkInteractorObserver.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkInteractorObserver.


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