VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkOrientationMarkerWidget Class Reference

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

#include <vtkOrientationMarkerWidget.h>

Inherits vtkInteractorObserver.

Collaboration diagram for vtkOrientationMarkerWidget:
[legend]

Public Types

typedef vtkInteractorObserver Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkOrientationMarkerWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetEnabled (int)
 
void ExecuteCameraUpdateEvent (vtkObject *o, unsigned long event, void *calldata)
 
virtual void SetOrientationMarker (vtkProp *prop)
 
virtual vtkProp * GetOrientationMarker ()
 
void SetInteractive (int state)
 
virtual int GetInteractive ()
 
virtual void InteractiveOn ()
 
virtual void InteractiveOff ()
 
void SetOutlineColor (double r, double g, double b)
 
double * GetOutlineColor ()
 
void SetViewport (double minX, double minY, double maxX, double maxY)
 
double * GetViewport ()
 
virtual void SetTolerance (int)
 
virtual int GetTolerance ()
 

Static Public Member Functions

static vtkOrientationMarkerWidgetNew ()
 
static int IsTypeOf (const char *type)
 
static vtkOrientationMarkerWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  WidgetState {
  Outside = 0, Inside, Translating, AdjustingP1,
  AdjustingP2, AdjustingP3, AdjustingP4
}
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkOrientationMarkerWidget ()
 
 ~vtkOrientationMarkerWidget ()
 
void OnLeftButtonDown ()
 
void OnLeftButtonUp ()
 
void OnMouseMove ()
 
int ComputeStateBasedOnPosition (int X, int Y, int *pos1, int *pos2)
 
void SetCursor (int state)
 
void MoveWidget (int X, int Y)
 
void ResizeTopLeft (int X, int Y)
 
void ResizeTopRight (int X, int Y)
 
void ResizeBottomLeft (int X, int Y)
 
void ResizeBottomRight (int X, int Y)
 
void SquareRenderer ()
 
void UpdateOutline ()
 

Static Protected Member Functions

static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

vtkRenderer * Renderer
 
vtkProp * OrientationMarker
 
vtkPolyDataOutline
 
vtkActor2D * OutlineActor
 
unsigned long StartEventObserverId
 
vtkOrientationMarkerWidgetObserver * Observer
 
int Interactive
 
int Tolerance
 
int Moving
 
int StartPosition [2]
 
int State
 

Detailed Description

2D widget for manipulating a marker prop

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.

Thanks:
This class was based originally on Paraview's vtkPVAxesWidget.
Warning
The input orientation marker prop should calculate its bounds as though they are symmetric about it's origin. This must currently be done to correctly implement the camera synchronization between the ivar renderer and the renderer associated with the set interactor. Importantly, the InteractorStyle associated with the interactor must be of the type vtkInteractorStyle*Camera. Where desirable, the parent renderer should be set by the SetDefaultRenderer method. The parent renderer's number of layers is modified to 2 where required.
See Also
vtkInteractorObserver vtkXYPlotWidget vtkScalarBarWidget vtkAxesActor vtkAnnotatedCubeActor
Events:
vtkCommand::StartInteractionEvent vtkCommand::EnableEvent vtkCommand::InteractionEvent vtkCommand::EndInteractionEvent vtkCommand::DisableEvent
Examples:
vtkOrientationMarkerWidget (Examples)
Tests:
vtkOrientationMarkerWidget (Tests)

Definition at line 89 of file vtkOrientationMarkerWidget.h.

Member Typedef Documentation

typedef vtkInteractorObserver vtkOrientationMarkerWidget::Superclass

Definition at line 93 of file vtkOrientationMarkerWidget.h.

Member Enumeration Documentation

Enumerator
Outside 
Inside 
Translating 
AdjustingP1 
AdjustingP2 
AdjustingP3 
AdjustingP4 

Definition at line 171 of file vtkOrientationMarkerWidget.h.

Constructor & Destructor Documentation

vtkOrientationMarkerWidget::vtkOrientationMarkerWidget ( )
protected
vtkOrientationMarkerWidget::~vtkOrientationMarkerWidget ( )
protected

Member Function Documentation

static vtkOrientationMarkerWidget* vtkOrientationMarkerWidget::New ( )
static
static int vtkOrientationMarkerWidget::IsTypeOf ( const char *  type)
static
virtual int vtkOrientationMarkerWidget::IsA ( const char *  type)
virtual
static vtkOrientationMarkerWidget* vtkOrientationMarkerWidget::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkOrientationMarkerWidget::NewInstanceInternal ( ) const
protectedvirtual
vtkOrientationMarkerWidget* vtkOrientationMarkerWidget::NewInstance ( ) const
void vtkOrientationMarkerWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkOrientationMarkerWidget::SetOrientationMarker ( vtkProp *  prop)
virtual

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

virtual vtkProp* vtkOrientationMarkerWidget::GetOrientationMarker ( )
virtual

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

virtual void vtkOrientationMarkerWidget::SetEnabled ( int  )
virtual

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

void vtkOrientationMarkerWidget::ExecuteCameraUpdateEvent ( vtkObject *  o,
unsigned long  event,
void *  calldata 
)

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

void vtkOrientationMarkerWidget::SetInteractive ( int  state)

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

virtual int vtkOrientationMarkerWidget::GetInteractive ( )
virtual

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

virtual void vtkOrientationMarkerWidget::InteractiveOn ( )
virtual

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

virtual void vtkOrientationMarkerWidget::InteractiveOff ( )
virtual

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

void 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).

double* vtkOrientationMarkerWidget::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).

void 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).

double* vtkOrientationMarkerWidget::GetViewport ( )

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

virtual void vtkOrientationMarkerWidget::SetTolerance ( int  )
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).

virtual int vtkOrientationMarkerWidget::GetTolerance ( )
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).

static void vtkOrientationMarkerWidget::ProcessEvents ( vtkObject *  object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected
void vtkOrientationMarkerWidget::OnLeftButtonDown ( )
protected
void vtkOrientationMarkerWidget::OnLeftButtonUp ( )
protected
void vtkOrientationMarkerWidget::OnMouseMove ( )
protected
int vtkOrientationMarkerWidget::ComputeStateBasedOnPosition ( int  X,
int  Y,
int *  pos1,
int *  pos2 
)
protected
void vtkOrientationMarkerWidget::SetCursor ( int  state)
protected
void vtkOrientationMarkerWidget::MoveWidget ( int  X,
int  Y 
)
protected
void vtkOrientationMarkerWidget::ResizeTopLeft ( int  X,
int  Y 
)
protected
void vtkOrientationMarkerWidget::ResizeTopRight ( int  X,
int  Y 
)
protected
void vtkOrientationMarkerWidget::ResizeBottomLeft ( int  X,
int  Y 
)
protected
void vtkOrientationMarkerWidget::ResizeBottomRight ( int  X,
int  Y 
)
protected
void vtkOrientationMarkerWidget::SquareRenderer ( )
protected
void vtkOrientationMarkerWidget::UpdateOutline ( )
protected

Member Data Documentation

vtkRenderer* vtkOrientationMarkerWidget::Renderer
protected

Definition at line 144 of file vtkOrientationMarkerWidget.h.

vtkProp* vtkOrientationMarkerWidget::OrientationMarker
protected

Definition at line 145 of file vtkOrientationMarkerWidget.h.

vtkPolyData* vtkOrientationMarkerWidget::Outline
protected

Definition at line 146 of file vtkOrientationMarkerWidget.h.

vtkActor2D* vtkOrientationMarkerWidget::OutlineActor
protected

Definition at line 147 of file vtkOrientationMarkerWidget.h.

unsigned long vtkOrientationMarkerWidget::StartEventObserverId
protected

Definition at line 149 of file vtkOrientationMarkerWidget.h.

vtkOrientationMarkerWidgetObserver* vtkOrientationMarkerWidget::Observer
protected

Definition at line 160 of file vtkOrientationMarkerWidget.h.

int vtkOrientationMarkerWidget::Interactive
protected

Definition at line 162 of file vtkOrientationMarkerWidget.h.

int vtkOrientationMarkerWidget::Tolerance
protected

Definition at line 163 of file vtkOrientationMarkerWidget.h.

int vtkOrientationMarkerWidget::Moving
protected

Definition at line 164 of file vtkOrientationMarkerWidget.h.

int vtkOrientationMarkerWidget::StartPosition[2]
protected

Definition at line 167 of file vtkOrientationMarkerWidget.h.

int vtkOrientationMarkerWidget::State
protected

Definition at line 170 of file vtkOrientationMarkerWidget.h.


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