vtkAngleRepresentation Class Reference

#include <vtkAngleRepresentation.h>

Inheritance diagram for vtkAngleRepresentation:

[legend]

Collaboration diagram for vtkAngleRepresentation:

[legend]

List of all members.

Detailed Description

represent the vtkAngleWidget

The vtkAngleRepresentation is a superclass for classes representing the vtkAngleWidget. This representation consists of two rays and three vtkHandleRepresentations to place and manipulate the three points defining the angle representation. (Note: the three points are referred to as Point1, Center, and Point2, at the two end points (Point1 and Point2) and Center (around which the angle is measured).

See also:: vtkAngleWidget vtkHandleRepresentation vtkAngleRepresentation2D

Definition at line 37 of file vtkAngleRepresentation.h.


typedef vtkWidgetRepresentation	Superclass
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
static int	IsTypeOf (const char *type)
static vtkAngleRepresentation *	SafeDownCast (vtkObject *o)
Public Types
enum	{ Outside = 0, NearP1, NearCenter, NearP2 }
Public Member Functions
virtual double	GetAngle ()=0

virtual void	GetPoint1WorldPosition (double pos[3])=0
virtual void	GetCenterWorldPosition (double pos[3])=0
virtual void	GetPoint2WorldPosition (double pos[3])=0
virtual void	SetPoint1DisplayPosition (double pos[3])=0
virtual void	SetCenterDisplayPosition (double pos[3])=0
virtual void	SetPoint2DisplayPosition (double pos[3])=0
virtual void	GetPoint1DisplayPosition (double pos[3])=0
virtual void	GetCenterDisplayPosition (double pos[3])=0
virtual void	GetPoint2DisplayPosition (double pos[3])=0

void	SetHandleRepresentation (vtkHandleRepresentation *handle)
void	InstantiateHandleRepresentation ()

virtual vtkHandleRepresentation *	GetPoint1Representation ()
virtual vtkHandleRepresentation *	GetCenterRepresentation ()
virtual vtkHandleRepresentation *	GetPoint2Representation ()

virtual void	SetTolerance (int)
virtual int	GetTolerance ()

virtual void	SetLabelFormat (const char *)
virtual char *	GetLabelFormat ()

virtual void	SetRay1Visibility (int)
virtual int	GetRay1Visibility ()
virtual void	Ray1VisibilityOn ()
virtual void	Ray1VisibilityOff ()
virtual void	SetRay2Visibility (int)
virtual int	GetRay2Visibility ()
virtual void	Ray2VisibilityOn ()
virtual void	Ray2VisibilityOff ()
virtual void	SetArcVisibility (int)
virtual int	GetArcVisibility ()
virtual void	ArcVisibilityOn ()
virtual void	ArcVisibilityOff ()

virtual void	BuildRepresentation ()
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual void	StartWidgetInteraction (double e[2])
virtual void	CenterWidgetInteraction (double e[2])
virtual void	WidgetInteraction (double e[2])
Protected Member Functions
	vtkAngleRepresentation ()
	~vtkAngleRepresentation ()
Protected Attributes
vtkHandleRepresentation *	HandleRepresentation
vtkHandleRepresentation *	Point1Representation
vtkHandleRepresentation *	CenterRepresentation
vtkHandleRepresentation *	Point2Representation
int	Tolerance
int	Ray1Visibility
int	Ray2Visibility
int	ArcVisibility
char *	LabelFormat

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkAngleRepresentation::Superclass

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

Definition at line 42 of file vtkAngleRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

Outside
NearP1
NearCenter
NearP2

Definition at line 118 of file vtkAngleRepresentation.h.

Constructor & Destructor Documentation

vtkAngleRepresentation::vtkAngleRepresentation ( ) [protected]

vtkAngleRepresentation::~vtkAngleRepresentation ( ) [protected]

Member Function Documentation

virtual const char* vtkAngleRepresentation::GetClassName ( ) [virtual]

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

static vtkAngleRepresentation* vtkAngleRepresentation::SafeDownCast ( vtkObject * o ) [static]

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual double vtkAngleRepresentation::GetAngle ( ) [pure virtual]

This representation and all subclasses must keep an angle (in degrees) consistent with the state of the widget.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::GetPoint1WorldPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::GetCenterWorldPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::GetPoint2WorldPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::SetPoint1DisplayPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::SetCenterDisplayPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::SetPoint2DisplayPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::GetPoint1DisplayPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::GetCenterDisplayPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

virtual void vtkAngleRepresentation::GetPoint2DisplayPosition ( double pos[3] ) [pure virtual]

Methods to Set/Get the coordinates of the three points defining this representation. Note that methods are available for both display and world coordinates.

Implemented in vtkAngleRepresentation2D, and vtkAngleRepresentation3D.

void vtkAngleRepresentation::SetHandleRepresentation ( vtkHandleRepresentation * handle )

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkAngleRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkAngleRepresentation uses this dummy to clone three vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkAngle widget.)

void vtkAngleRepresentation::InstantiateHandleRepresentation ( )

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkAngleRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkAngleRepresentation uses this dummy to clone three vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkAngle widget.)

virtual vtkHandleRepresentation* vtkAngleRepresentation::GetPoint1Representation ( ) [virtual]

Set/Get the handle representations used for the vtkAngleRepresentation.

virtual vtkHandleRepresentation* vtkAngleRepresentation::GetCenterRepresentation ( ) [virtual]

Set/Get the handle representations used for the vtkAngleRepresentation.

virtual vtkHandleRepresentation* vtkAngleRepresentation::GetPoint2Representation ( ) [virtual]

Set/Get the handle representations used for the vtkAngleRepresentation.

virtual void vtkAngleRepresentation::SetTolerance ( int ) [virtual]

The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the end points of the representation to be active.

virtual int vtkAngleRepresentation::GetTolerance ( ) [virtual]

The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the end points of the representation to be active.

virtual void vtkAngleRepresentation::SetLabelFormat ( const char * ) [virtual]

Specify the format to use for labelling the angle. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

virtual char* vtkAngleRepresentation::GetLabelFormat ( ) [virtual]

Specify the format to use for labelling the angle. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

virtual void vtkAngleRepresentation::SetRay1Visibility ( int ) [virtual]