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:

Collaboration diagram for vtkAbstractPolygonalHandleRepresentation3D:

List of all members.

Public Member Functions
virtual vtkAbstractTransform *	GetTransform ()
virtual void	SetUniformScale (double scale)
void	Highlight (int highlight)
virtual void	SetWorldPosition (double p[3])
virtual void	SetDisplayPosition (double p[3])
void	SetHandle (vtkPolyData *)
vtkPolyData *	GetHandle ()
void	SetProperty (vtkProperty *)
void	SetSelectedProperty (vtkProperty *)
virtual vtkProperty *	GetProperty ()
virtual vtkProperty *	GetSelectedProperty ()
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 double *	GetBounds ()
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 double *	GetLabelTextScale ()
virtual vtkFollower *	GetLabelTextActor ()
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	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
vtkActor *	Actor
vtkPolyDataMapper *	Mapper
vtkTransformPolyDataFilter *	HandleTransformFilter
vtkMatrixToLinearTransform *	HandleTransform
vtkMatrix4x4 *	HandleTransformMatrix
vtkCellPicker *	HandlePicker
double	LastPickPosition [3]
double	LastEventPosition [2]
int	ConstraintAxis
vtkProperty *	Property
vtkProperty *	SelectedProperty
int	WaitingForMotion
int	WaitCount
int	HandleVisibility
int	LabelVisibility
vtkFollower *	LabelTextActor
vtkPolyDataMapper *	LabelTextMapper
vtkVectorText *	LabelTextInput
bool	LabelAnnotationTextScaleInitialized
int	SmoothMotion
typedef vtkHandleRepresentation	Superclass
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
static int	IsTypeOf (const char *type)
static vtkAbstractPolygonalHandleRepresentation3D *	SafeDownCast (vtkObject *o)

---

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 50 of file vtkAbstractPolygonalHandleRepresentation3D.h.

---

Member Typedef Documentation

typedef vtkHandleRepresentation vtkAbstractPolygonalHandleRepresentation3D::Superclass

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

Definition at line 57 of file vtkAbstractPolygonalHandleRepresentation3D.h.

---

Constructor & Destructor Documentation

vtkAbstractPolygonalHandleRepresentation3D::vtkAbstractPolygonalHandleRepresentation3D

(

)

[protected]

vtkAbstractPolygonalHandleRepresentation3D::~vtkAbstractPolygonalHandleRepresentation3D

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkAbstractPolygonalHandleRepresentation3D::GetClassName

(

)

[virtual]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.

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.

static vtkAbstractPolygonalHandleRepresentation3D* vtkAbstractPolygonalHandleRepresentation3D::SafeDownCast

(

vtkObject *

o

)

[static]

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.

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetWorldPosition

(

double

p[3]

)

[virtual]

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

Reimplemented from vtkHandleRepresentation.

Reimplemented in vtkPolygonalHandleRepresentation3D.

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetDisplayPosition

(

double

p[3]

)

[virtual]

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

Reimplemented from vtkHandleRepresentation.

void vtkAbstractPolygonalHandleRepresentation3D::SetHandle

(

vtkPolyData *

)

Set/get the handle polydata.

vtkPolyData* vtkAbstractPolygonalHandleRepresentation3D::GetHandle

(

)

Set/get the handle polydata.

void vtkAbstractPolygonalHandleRepresentation3D::SetProperty

(

vtkProperty *

)

Set/Get the handle properties when unselected and selected.

void vtkAbstractPolygonalHandleRepresentation3D::SetSelectedProperty

(

vtkProperty *

)

Set/Get the handle properties when unselected and selected.

virtual vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::GetProperty

(

)

[virtual]

Set/Get the handle properties when unselected and selected.

virtual vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::GetSelectedProperty

(

)

[virtual]

Set/Get the handle properties when unselected and selected.

virtual vtkAbstractTransform* vtkAbstractPolygonalHandleRepresentation3D::GetTransform

(

)

[virtual]

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

virtual void vtkAbstractPolygonalHandleRepresentation3D::BuildRepresentation

(

)

[virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Implements vtkWidgetRepresentation.

Reimplemented in vtkFixedSizeHandleRepresentation3D.

virtual void vtkAbstractPolygonalHandleRepresentation3D::StartWidgetInteraction

(

double

eventPos[2]

)

[virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAbstractPolygonalHandleRepresentation3D::WidgetInteraction

(

double

eventPos[2]

)

[virtual]

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.

virtual void vtkAbstractPolygonalHandleRepresentation3D::ShallowCopy

(

vtkProp *

prop

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

virtual void vtkAbstractPolygonalHandleRepresentation3D::DeepCopy

(

vtkProp *

prop

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

virtual void vtkAbstractPolygonalHandleRepresentation3D::GetActors

(

vtkPropCollection *

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAbstractPolygonalHandleRepresentation3D::ReleaseGraphicsResources

(

vtkWindow *

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkAbstractPolygonalHandleRepresentation3D::RenderOpaqueGeometry

(

vtkViewport *

viewport

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

virtual int vtkAbstractPolygonalHandleRepresentation3D::RenderTranslucentPolygonalGeometry

(

vtkViewport *

viewport

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

virtual int vtkAbstractPolygonalHandleRepresentation3D::HasTranslucentPolygonalGeometry

(

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual double* vtkAbstractPolygonalHandleRepresentation3D::GetBounds

(

)

[virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelVisibility

(

int

)

[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.

virtual int vtkAbstractPolygonalHandleRepresentation3D::GetLabelVisibility

(

)

[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.

virtual void vtkAbstractPolygonalHandleRepresentation3D::LabelVisibilityOn

(

)

[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.

virtual void vtkAbstractPolygonalHandleRepresentation3D::LabelVisibilityOff

(

)

[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.

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.

virtual char* vtkAbstractPolygonalHandleRepresentation3D::GetLabelText

(

)

[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.

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetLabelTextScale

(

double

scale[3]

)

[virtual]

Scale text (font size along each dimension).

void vtkAbstractPolygonalHandleRepresentation3D::SetLabelTextScale	(	double	x,
		double	y,
		double	z
	)		[inline]

Scale text (font size along each dimension).

Definition at line 119 of file vtkAbstractPolygonalHandleRepresentation3D.h.

virtual double* vtkAbstractPolygonalHandleRepresentation3D::GetLabelTextScale

(

)

[virtual]

Scale text (font size along each dimension).

virtual vtkFollower* vtkAbstractPolygonalHandleRepresentation3D::GetLabelTextActor

(

)

[virtual]

Get the label text actor

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetUniformScale

(

double

scale

)

[virtual]

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.

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetHandleVisibility

(

int

)

[virtual]

Toogle the visibility of the handle on and off

virtual int vtkAbstractPolygonalHandleRepresentation3D::GetHandleVisibility

(

)

[virtual]

Toogle the visibility of the handle on and off

virtual void vtkAbstractPolygonalHandleRepresentation3D::HandleVisibilityOn

(

)

[virtual]

Toogle the visibility of the handle on and off

virtual void vtkAbstractPolygonalHandleRepresentation3D::HandleVisibilityOff

(

)

[virtual]

Toogle the visibility of the handle on and off

void vtkAbstractPolygonalHandleRepresentation3D::Highlight

(

int

highlight

)

virtual void vtkAbstractPolygonalHandleRepresentation3D::SetSmoothMotion

(

int

)

[virtual]

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 int vtkAbstractPolygonalHandleRepresentation3D::GetSmoothMotion

(

)

[virtual]

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::SmoothMotionOn

(

)

[virtual]

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::SmoothMotionOff

(

)

[virtual]

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::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::CreateDefaultProperties

(

)

[protected]

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

vtkActor* vtkAbstractPolygonalHandleRepresentation3D::Actor [protected]

Definition at line 166 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkPolyDataMapper* vtkAbstractPolygonalHandleRepresentation3D::Mapper [protected]

Definition at line 167 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkTransformPolyDataFilter* vtkAbstractPolygonalHandleRepresentation3D::HandleTransformFilter [protected]

Definition at line 168 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkMatrixToLinearTransform* vtkAbstractPolygonalHandleRepresentation3D::HandleTransform [protected]

Definition at line 169 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkMatrix4x4* vtkAbstractPolygonalHandleRepresentation3D::HandleTransformMatrix [protected]

Definition at line 170 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkCellPicker* vtkAbstractPolygonalHandleRepresentation3D::HandlePicker [protected]

Definition at line 171 of file vtkAbstractPolygonalHandleRepresentation3D.h.

double vtkAbstractPolygonalHandleRepresentation3D::LastPickPosition[3] [protected]

Definition at line 172 of file vtkAbstractPolygonalHandleRepresentation3D.h.

double vtkAbstractPolygonalHandleRepresentation3D::LastEventPosition[2] [protected]

Definition at line 173 of file vtkAbstractPolygonalHandleRepresentation3D.h.

int vtkAbstractPolygonalHandleRepresentation3D::ConstraintAxis [protected]

Definition at line 174 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::Property [protected]

Definition at line 175 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkProperty* vtkAbstractPolygonalHandleRepresentation3D::SelectedProperty [protected]

Definition at line 176 of file vtkAbstractPolygonalHandleRepresentation3D.h.

int vtkAbstractPolygonalHandleRepresentation3D::WaitingForMotion [protected]

Definition at line 177 of file vtkAbstractPolygonalHandleRepresentation3D.h.

int vtkAbstractPolygonalHandleRepresentation3D::WaitCount [protected]

Definition at line 178 of file vtkAbstractPolygonalHandleRepresentation3D.h.

int vtkAbstractPolygonalHandleRepresentation3D::HandleVisibility [protected]

Definition at line 179 of file vtkAbstractPolygonalHandleRepresentation3D.h.

int vtkAbstractPolygonalHandleRepresentation3D::LabelVisibility [protected]

Definition at line 216 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkFollower* vtkAbstractPolygonalHandleRepresentation3D::LabelTextActor [protected]

Definition at line 217 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkPolyDataMapper* vtkAbstractPolygonalHandleRepresentation3D::LabelTextMapper [protected]

Definition at line 218 of file vtkAbstractPolygonalHandleRepresentation3D.h.

vtkVectorText* vtkAbstractPolygonalHandleRepresentation3D::LabelTextInput [protected]

Definition at line 219 of file vtkAbstractPolygonalHandleRepresentation3D.h.

bool vtkAbstractPolygonalHandleRepresentation3D::LabelAnnotationTextScaleInitialized [protected]

Definition at line 220 of file vtkAbstractPolygonalHandleRepresentation3D.h.

int vtkAbstractPolygonalHandleRepresentation3D::SmoothMotion [protected]

Definition at line 221 of file vtkAbstractPolygonalHandleRepresentation3D.h.

---

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

• dox/Widgets/vtkAbstractPolygonalHandleRepresentation3D.h