vtkAffineRepresentation2D Class Reference

#include <vtkAffineRepresentation2D.h>

Inheritance diagram for vtkAffineRepresentation2D:

[legend]

Collaboration diagram for vtkAffineRepresentation2D:

[legend]

List of all members.

Detailed Description

represent 2D affine transformations

This class is used to represent a vtkAffineWidget. This representation consists of three parts: a box, a circle, and a cross. The box is used for scaling and shearing, the circle for rotation, and the cross for translation. These parts are drawn in the overlay plane and maintain a constant size (width and height) specified in terms of normalized viewport coordinates.

The representation maintains an internal transformation matrix (see superclass' GetTransform() method). The transformations generated by this widget assume that the representation lies in the x-y plane. If this is not the case, the user is responsible for transforming this representation's matrix into the correct coordinate space (by judicious matrix multiplication). Note that the transformation matrix returned by GetTransform() is relative to the last PlaceWidget() invocation. (The PlaceWidget() sets the origin around which rotation and scaling occurs; the origin is the center point of the bounding box provided.)

See also:: vtkAffineRepresentation vtkAffineWidget

Examples:: vtkAffineRepresentation2D (Examples)

Tests:: vtkAffineRepresentation2D (Tests)

Definition at line 63 of file vtkAffineRepresentation2D.h.


typedef vtkAffineRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkAffineRepresentation2D *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions
virtual void	GetTransform (vtkTransform *t)

virtual void	SetBoxWidth (int)
virtual int	GetBoxWidth ()
virtual void	SetCircleWidth (int)
virtual int	GetCircleWidth ()
virtual void	SetAxesWidth (int)
virtual int	GetAxesWidth ()

void	SetOrigin (double o[3])
void	SetOrigin (double ox, double oy, double oz)
virtual double *	GetOrigin ()
virtual void	GetOrigin (double &, double &, double &)
virtual void	GetOrigin (double[3])

void	SetProperty (vtkProperty2D *)
void	SetSelectedProperty (vtkProperty2D *)
void	SetTextProperty (vtkTextProperty *)
virtual vtkProperty2D *	GetProperty ()
virtual vtkProperty2D *	GetSelectedProperty ()
virtual vtkTextProperty *	GetTextProperty ()

virtual void	SetDisplayText (int)
virtual int	GetDisplayText ()
virtual void	DisplayTextOn ()
virtual void	DisplayTextOff ()

virtual void	PlaceWidget (double bounds[6])
virtual void	StartWidgetInteraction (double eventPos[2])
virtual void	WidgetInteraction (double eventPos[2])
virtual void	EndWidgetInteraction (double eventPos[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual void	BuildRepresentation ()

virtual void	ShallowCopy (vtkProp *prop)
virtual void	GetActors2D (vtkPropCollection *)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOverlay (vtkViewport *viewport)
Static Public Member Functions
static vtkAffineRepresentation2D *	New ()
Protected Member Functions
	vtkAffineRepresentation2D ()
	~vtkAffineRepresentation2D ()
void	Translate (double eventPos[2])
void	Scale (double eventPos[2])
void	Rotate (double eventPos[2])
void	Shear (double eventPos[2])
void	Highlight (int highlight)
void	UpdateText (const char *text, double eventPos[2])
void	ApplyShear ()
void	CreateDefaultProperties ()
Protected Attributes
int	BoxWidth
int	CircleWidth
int	AxesWidth
int	DisplayText
double	CurrentWidth
double	CurrentRadius
double	CurrentAxesWidth
vtkTransform *	CurrentTransform
vtkTransform *	TotalTransform
vtkTransform *	TempTransform
double	Origin [4]
double	DisplayOrigin [3]
double	CurrentTranslation [3]
double	StartWorldPosition [4]
double	StartAngle
double	CurrentAngle
double	CurrentScale [2]
double	CurrentShear [2]
vtkProperty2D *	Property
vtkProperty2D *	SelectedProperty
vtkTextProperty *	TextProperty
double	Opacity
double	SelectedOpacity
double	LastEventPosition [2]
vtkTextMapper *	TextMapper
vtkActor2D *	TextActor
vtkPoints *	BoxPoints
vtkCellArray *	BoxCellArray
vtkPolyData *	Box
vtkPolyDataMapper2D *	BoxMapper
vtkActor2D *	BoxActor
vtkPoints *	HBoxPoints
vtkCellArray *	HBoxCellArray
vtkPolyData *	HBox
vtkPolyDataMapper2D *	HBoxMapper
vtkActor2D *	HBoxActor
vtkPoints *	CirclePoints
vtkCellArray *	CircleCellArray
vtkPolyData *	Circle
vtkPolyDataMapper2D *	CircleMapper
vtkActor2D *	CircleActor
vtkPoints *	HCirclePoints
vtkCellArray *	HCircleCellArray
vtkPolyData *	HCircle
vtkPolyDataMapper2D *	HCircleMapper
vtkActor2D *	HCircleActor
vtkLeaderActor2D *	XAxis
vtkLeaderActor2D *	YAxis
vtkLeaderActor2D *	HXAxis
vtkLeaderActor2D *	HYAxis

Member Typedef Documentation

typedef vtkAffineRepresentation vtkAffineRepresentation2D::Superclass

Standard methods for instances of this class.

Reimplemented from vtkAffineRepresentation.

Definition at line 71 of file vtkAffineRepresentation2D.h.

Constructor & Destructor Documentation

vtkAffineRepresentation2D::vtkAffineRepresentation2D ( ) [protected]

vtkAffineRepresentation2D::~vtkAffineRepresentation2D ( ) [protected]

Member Function Documentation

static vtkAffineRepresentation2D* vtkAffineRepresentation2D::New ( ) [static]

Instantiate this class.

Reimplemented from vtkObject.

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

Standard methods for instances of this class.

Reimplemented from vtkAffineRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkAffineRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkAffineRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkAffineRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkAffineRepresentation.

virtual void vtkAffineRepresentation2D::SetBoxWidth ( int ) [virtual]

Specify the width of the various parts of the representation (in pixels). The three parts are of the representation are the translation axes, the rotation circle, and the scale/shear box. Note that since the widget resizes itself so that the width and height are always the same, only the width needs to be specified.

virtual int vtkAffineRepresentation2D::GetBoxWidth ( ) [virtual]

Specify the width of the various parts of the representation (in pixels). The three parts are of the representation are the translation axes, the rotation circle, and the scale/shear box. Note that since the widget resizes itself so that the width and height are always the same, only the width needs to be specified.

virtual void vtkAffineRepresentation2D::SetCircleWidth ( int ) [virtual]

Specify the width of the various parts of the representation (in pixels). The three parts are of the representation are the translation axes, the rotation circle, and the scale/shear box. Note that since the widget resizes itself so that the width and height are always the same, only the width needs to be specified.

virtual int vtkAffineRepresentation2D::GetCircleWidth ( ) [virtual]

Specify the width of the various parts of the representation (in pixels). The three parts are of the representation are the translation axes, the rotation circle, and the scale/shear box. Note that since the widget resizes itself so that the width and height are always the same, only the width needs to be specified.

virtual void vtkAffineRepresentation2D::SetAxesWidth ( int ) [virtual]

Specify the width of the various parts of the representation (in pixels). The three parts are of the representation are the translation axes, the rotation circle, and the scale/shear box. Note that since the widget resizes itself so that the width and height are always the same, only the width needs to be specified.

virtual int vtkAffineRepresentation2D::GetAxesWidth ( ) [virtual]

Specify the width of the various parts of the representation (in pixels). The three parts are of the representation are the translation axes, the rotation circle, and the scale/shear box. Note that since the widget resizes itself so that the width and height are always the same, only the width needs to be specified.

void vtkAffineRepresentation2D::SetOrigin ( double o[3] ) [inline]

Specify the origin of the widget (in world coordinates). The origin is the point where the widget places itself. Note that rotations and scaling occurs around the origin.

Definition at line 93 of file vtkAffineRepresentation2D.h.

void vtkAffineRepresentation2D::SetOrigin	(	double	ox,
		double	oy,
		double	oz
	)

Specify the origin of the widget (in world coordinates). The origin is the point where the widget places itself. Note that rotations and scaling occurs around the origin.

virtual double* vtkAffineRepresentation2D::GetOrigin ( ) [virtual]

Specify the origin of the widget (in world coordinates). The origin is the point where the widget places itself. Note that rotations and scaling occurs around the origin.

virtual void vtkAffineRepresentation2D::GetOrigin	(	double &	,
		double &	,
		double &
	)			`[virtual]`

Specify the origin of the widget (in world coordinates). The origin is the point where the widget places itself. Note that rotations and scaling occurs around the origin.

virtual void vtkAffineRepresentation2D::GetOrigin ( double [3] ) [virtual]

Specify the origin of the widget (in world coordinates). The origin is the point where the widget places itself. Note that rotations and scaling occurs around the origin.

virtual void vtkAffineRepresentation2D::GetTransform ( vtkTransform * t ) [virtual]

Retrieve a linear transform characterizing the affine transformation generated by this widget. This method copies its internal transform into the transform provided. Note that the PlaceWidget() method initializes the internal matrix to identity. All subsequent widget operations (i.e., scale, translate, rotate, shear) are concatenated with the internal transform.

Implements vtkAffineRepresentation.

void vtkAffineRepresentation2D::SetProperty ( vtkProperty2D * )

Set/Get the properties when unselected and selected.

void vtkAffineRepresentation2D::SetSelectedProperty ( vtkProperty2D * )

Set/Get the properties when unselected and selected.

void vtkAffineRepresentation2D::SetTextProperty ( vtkTextProperty * )

Set/Get the properties when unselected and selected.

virtual vtkProperty2D* vtkAffineRepresentation2D::GetProperty ( ) [virtual]

Set/Get the properties when unselected and selected.

virtual vtkProperty2D* vtkAffineRepresentation2D::GetSelectedProperty ( ) [virtual]

Set/Get the properties when unselected and selected.

virtual vtkTextProperty* vtkAffineRepresentation2D::GetTextProperty ( ) [virtual]

Set/Get the properties when unselected and selected.

virtual void vtkAffineRepresentation2D::SetDisplayText ( int ) [virtual]

Enable the display of text with numeric values characterizing the transformation. Rotation and shear are expressed in degrees; translation the distance in world coordinates; and scale normalized (sx,sy) values.

virtual int vtkAffineRepresentation2D::GetDisplayText ( ) [virtual]

Enable the display of text with numeric values characterizing the transformation. Rotation and shear are expressed in degrees; translation the distance in world coordinates; and scale normalized (sx,sy) values.

virtual void vtkAffineRepresentation2D::DisplayTextOn ( ) [virtual]

Enable the display of text with numeric values characterizing the transformation. Rotation and shear are expressed in degrees; translation the distance in world coordinates; and scale normalized (sx,sy) values.

virtual void vtkAffineRepresentation2D::DisplayTextOff ( ) [virtual]

Enable the display of text with numeric values characterizing the transformation. Rotation and shear are expressed in degrees; translation the distance in world coordinates; and scale normalized (sx,sy) values.

virtual void vtkAffineRepresentation2D::PlaceWidget ( double bounds[6] ) [virtual]

Subclasses of vtkAffineRepresentation2D must implement these methods. These are the methods that the widget and its representation use to communicate with each other. Note: PlaceWidget() reinitializes the transformation matrix (i.e., sets it to identity). It also sets the origin for scaling and rotation.

virtual void vtkAffineRepresentation2D::StartWidgetInteraction ( double eventPos[2] ) [virtual]

Subclasses of vtkAffineRepresentation2D must implement these methods. These are the methods that the widget and its representation use to communicate with each other. Note: PlaceWidget() reinitializes the transformation matrix (i.e., sets it to identity). It also sets the origin for scaling and rotation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAffineRepresentation2D::WidgetInteraction ( double eventPos[2] ) [virtual]

Subclasses of vtkAffineRepresentation2D must implement these methods. These are the methods that the widget and its representation use to communicate with each other. Note: PlaceWidget() reinitializes the transformation matrix (i.e., sets it to identity). It also sets the origin for scaling and rotation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAffineRepresentation2D::EndWidgetInteraction ( double eventPos[2] ) [virtual]

Subclasses of vtkAffineRepresentation2D must implement these methods. These are the methods that the widget and its representation use to communicate with each other. Note: PlaceWidget() reinitializes the transformation matrix (i.e., sets it to identity). It also sets the origin for scaling and rotation.

Reimplemented from vtkWidgetRepresentation.

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

Subclasses of vtkAffineRepresentation2D must implement these methods. These are the methods that the widget and its representation use to communicate with each other. Note: PlaceWidget() reinitializes the transformation matrix (i.e., sets it to identity). It also sets the origin for scaling and rotation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAffineRepresentation2D::BuildRepresentation ( ) [virtual]

Subclasses of vtkAffineRepresentation2D must implement these methods. These are the methods that the widget and its representation use to communicate with each other. Note: PlaceWidget() reinitializes the transformation matrix (i.e., sets it to identity). It also sets the origin for scaling and rotation.

Implements vtkWidgetRepresentation.

virtual void vtkAffineRepresentation2D::ShallowCopy ( vtkProp * prop ) [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkAffineRepresentation.

virtual void vtkAffineRepresentation2D::GetActors2D ( vtkPropCollection * ) [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkAffineRepresentation2D::ReleaseGraphicsResources ( vtkWindow * ) [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkAffineRepresentation2D::RenderOverlay ( vtkViewport * viewport ) [virtual]

Methods to make this class behave as a vtkProp.