VTK
Public Member Functions | Protected Member Functions | Protected Attributes
vtkAbstractPolygonalHandleRepresentation3D Class Reference

represent a user defined handle geometry in 3D while maintaining a fixed orientation w.r.t the camera. More...

#include <vtkAbstractPolygonalHandleRepresentation3D.h>

Inheritance diagram for vtkAbstractPolygonalHandleRepresentation3D:
Inheritance graph
[legend]
Collaboration diagram for vtkAbstractPolygonalHandleRepresentation3D:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual vtkAbstractTransformGetTransform ()
virtual void SetUniformScale (double scale)
void Highlight (int highlight)
virtual void SetWorldPosition (double p[3])
virtual void SetDisplayPosition (double p[3])
void SetHandle (vtkPolyData *)
vtkPolyDataGetHandle ()
void SetProperty (vtkProperty *)
void SetSelectedProperty (vtkProperty *)
virtual vtkPropertyGetProperty ()
virtual vtkPropertyGetSelectedProperty ()
virtual void BuildRepresentation ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double eventPos[2])
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void ShallowCopy (vtkProp *prop)
virtual void DeepCopy (vtkProp *prop)
virtual void GetActors (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
virtual int HasTranslucentPolygonalGeometry ()
virtual doubleGetBounds ()
virtual void SetLabelVisibility (int)
virtual int GetLabelVisibility ()
virtual void LabelVisibilityOn ()
virtual void LabelVisibilityOff ()
virtual void SetLabelText (const char *label)
virtual char * GetLabelText ()
virtual void SetLabelTextScale (double scale[3])
void SetLabelTextScale (double x, double y, double z)
virtual doubleGetLabelTextScale ()
virtual vtkFollowerGetLabelTextActor ()
virtual void SetHandleVisibility (int)
virtual int GetHandleVisibility ()
virtual void HandleVisibilityOn ()
virtual void HandleVisibilityOff ()
virtual void SetSmoothMotion (int)
virtual int GetSmoothMotion ()
virtual void SmoothMotionOn ()
virtual void SmoothMotionOff ()

Protected Member Functions

 vtkAbstractPolygonalHandleRepresentation3D ()
 ~vtkAbstractPolygonalHandleRepresentation3D ()
virtual void RegisterPickers ()
virtual void Translate (double *p1, double *p2)
virtual void Scale (double *p1, double *p2, double eventPos[2])
virtual void MoveFocus (double *p1, double *p2)
void CreateDefaultProperties ()
void MoveFocusRequest (double *p1, double *p2, double eventPos[2], double requestedDisplayPos[3])
int DetermineConstraintAxis (int constraint, double *x, double *startPickPos)
virtual void UpdateHandle ()
virtual void UpdateLabel ()

Protected Attributes

vtkActorActor
vtkPolyDataMapperMapper
vtkTransformPolyDataFilterHandleTransformFilter
vtkMatrixToLinearTransformHandleTransform
vtkMatrix4x4HandleTransformMatrix
vtkCellPickerHandlePicker
double LastPickPosition [3]
double LastEventPosition [2]
int ConstraintAxis
vtkPropertyProperty
vtkPropertySelectedProperty
int WaitingForMotion
int WaitCount
int HandleVisibility
int LabelVisibility
vtkFollowerLabelTextActor
vtkPolyDataMapperLabelTextMapper
vtkVectorTextLabelTextInput
bool LabelAnnotationTextScaleInitialized
int SmoothMotion
typedef vtkHandleRepresentation Superclass
static int IsTypeOf (const char *type)
static
vtkAbstractPolygonalHandleRepresentation3D
SafeDownCast (vtkObjectBase *o)
virtual int IsA (const char *type)
vtkAbstractPolygonalHandleRepresentation3DNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBaseNewInstanceInternal () const

Detailed Description

represent a user defined handle geometry in 3D while maintaining a fixed orientation w.r.t the camera.

This class serves as the geometrical representation of a vtkHandleWidget. The handle can be represented by an arbitrary polygonal data (vtkPolyData), set via SetHandle(vtkPolyData *). The actual position of the handle will be initially assumed to be (0,0,0). You can specify an offset from this position if desired. This class differs from vtkPolygonalHandleRepresentation3D in that the handle will always remain front facing, ie it maintains a fixed orientation with respect to the camera. This is done by using vtkFollowers internally to render the actors.

See also:
vtkPolygonalHandleRepresentation3D vtkHandleRepresentation vtkHandleWidget
Tests:
vtkAbstractPolygonalHandleRepresentation3D (Tests)

Definition at line 51 of file vtkAbstractPolygonalHandleRepresentation3D.h.


Member Typedef Documentation

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

Definition at line 58 of file vtkAbstractPolygonalHandleRepresentation3D.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkAbstractPolygonalHandleRepresentation3D::IsTypeOf ( const char *  type) [static]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

virtual int vtkAbstractPolygonalHandleRepresentation3D::IsA ( const char *  type) [virtual]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

void vtkAbstractPolygonalHandleRepresentation3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

Set the position of the point in world and display coordinates.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkPolygonalHandleRepresentation3D.

Set the position of the point in world and display coordinates.

Reimplemented from vtkHandleRepresentation.

Set/get the handle polydata.

Set/get the handle polydata.

Set/Get the handle properties when unselected and selected.

Set/Get the handle properties when unselected and selected.

Set/Get the handle properties when unselected and selected.

Set/Get the handle properties when unselected and selected.

Get the transform used to transform the generic handle polydata before placing it in the render window

Methods to make this class properly act like a vtkWidgetRepresentation.

Implements vtkWidgetRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D.

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkAbstractPolygonalHandleRepresentation3D::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
) [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

A label may be associated with the seed. The string can be set via SetLabelText. The visibility of the label can be turned on / off.

A label may be associated with the seed. The string can be set via SetLabelText. The visibility of the label can be turned on / off.

A label may be associated with the seed. The string can be set via SetLabelText. The visibility of the label can be turned on / off.

A label may be associated with the seed. The string can be set via SetLabelText. The visibility of the label can be turned on / off.

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelText ( const char *  label) [virtual]

A label may be associated with the seed. The string can be set via SetLabelText. The visibility of the label can be turned on / off.

A label may be associated with the seed. The string can be set via SetLabelText. The visibility of the label can be turned on / off.

Scale text (font size along each dimension).

Scale text (font size along each dimension).

Definition at line 120 of file vtkAbstractPolygonalHandleRepresentation3D.h.

Scale text (font size along each dimension).

Get the label text actor

The handle may be scaled uniformly in all three dimensions using this API. The handle can also be scaled interactively using the right mouse button.

Toogle the visibility of the handle on and off

Toogle the visibility of the handle on and off

Toogle the visibility of the handle on and off

Toogle the visibility of the handle on and off

Turn on/off smooth motion of the handle. See the documentation of MoveFocusRequest for details. By default, SmoothMotion is ON. However, in certain applications the user may want to turn it off. For instance when using certain specific PointPlacer's with the representation such as the vtkCellCentersPointPlacer, which causes the representation to snap to the center of cells, or using a vtkPolygonalSurfacePointPlacer which constrains the widget to the surface of a mesh. In such cases, inherent restrictions on handle placement might conflict with a request for smooth motion of the handles.

Turn on/off smooth motion of the handle. See the documentation of MoveFocusRequest for details. By default, SmoothMotion is ON. However, in certain applications the user may want to turn it off. For instance when using certain specific PointPlacer's with the representation such as the vtkCellCentersPointPlacer, which causes the representation to snap to the center of cells, or using a vtkPolygonalSurfacePointPlacer which constrains the widget to the surface of a mesh. In such cases, inherent restrictions on handle placement might conflict with a request for smooth motion of the handles.

Turn on/off smooth motion of the handle. See the documentation of MoveFocusRequest for details. By default, SmoothMotion is ON. However, in certain applications the user may want to turn it off. For instance when using certain specific PointPlacer's with the representation such as the vtkCellCentersPointPlacer, which causes the representation to snap to the center of cells, or using a vtkPolygonalSurfacePointPlacer which constrains the widget to the surface of a mesh. In such cases, inherent restrictions on handle placement might conflict with a request for smooth motion of the handles.

Turn on/off smooth motion of the handle. See the documentation of MoveFocusRequest for details. By default, SmoothMotion is ON. However, in certain applications the user may want to turn it off. For instance when using certain specific PointPlacer's with the representation such as the vtkCellCentersPointPlacer, which causes the representation to snap to the center of cells, or using a vtkPolygonalSurfacePointPlacer which constrains the widget to the surface of a mesh. In such cases, inherent restrictions on handle placement might conflict with a request for smooth motion of the handles.

virtual void vtkAbstractPolygonalHandleRepresentation3D::RegisterPickers ( ) [protected, virtual]

Register internal Pickers in the Picking Manager. Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAbstractPolygonalHandleRepresentation3D::Translate ( double p1,
double p2 
) [protected, virtual]
virtual void vtkAbstractPolygonalHandleRepresentation3D::Scale ( double p1,
double p2,
double  eventPos[2] 
) [protected, virtual]
virtual void vtkAbstractPolygonalHandleRepresentation3D::MoveFocus ( double p1,
double p2 
) [protected, virtual]
void vtkAbstractPolygonalHandleRepresentation3D::MoveFocusRequest ( double p1,
double p2,
double  eventPos[2],
double  requestedDisplayPos[3] 
) [protected]
int vtkAbstractPolygonalHandleRepresentation3D::DetermineConstraintAxis ( int  constraint,
double x,
double startPickPos 
) [protected]
virtual void vtkAbstractPolygonalHandleRepresentation3D::UpdateHandle ( ) [protected, virtual]

Update the actor position. Different subclasses handle this differently. For instance vtkPolygonalHandleRepresentation3D updates the handle transformation and sets this on the handle. vtkOrientedPolygonalHandleRepresentation3D, which uses a vtkFollower to keep the handle geometry facinig the camera handles this differently. This is an opportunity for subclasses to update the actor's position etc each time the handle is rendered.

Reimplemented in vtkOrientedPolygonalHandleRepresentation3D.

virtual void vtkAbstractPolygonalHandleRepresentation3D::UpdateLabel ( ) [protected, virtual]

Opportunity to update the label position and text during each render.


Member Data Documentation


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