vtkBorderRepresentation Class Reference

#include <vtkBorderRepresentation.h>

Inheritance diagram for vtkBorderRepresentation:

[legend]

Collaboration diagram for vtkBorderRepresentation:

[legend]

List of all members.

Detailed Description

represent a vtkBorderWidget

This class is used to represent and render a vtBorderWidget. To use this class, you need to specify the two corners of a rectangular region.

The class is typically subclassed so that specialized representations can be created. The class defines an API and a default implementation that the vtkBorderRepresentation interacts with to render itself in the scene.

Warning:: The separation of the widget event handling (e.g., vtkBorderWidget) from the representation (vtkBorderRepresentation) enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).

See also:: vtkBorderWidget vtkTextWidget

Tests:: vtkBorderRepresentation (Tests)

Definition at line 56 of file vtkBorderRepresentation.h.


typedef vtkWidgetRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkBorderRepresentation *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Types
enum	{ BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }

enum	_InteractionState { Outside = 0, Inside, AdjustingP0, AdjustingP1, AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1, AdjustingE2, AdjustingE3 }
Public Member Functions

virtual vtkCoordinate *	GetPositionCoordinate ()
virtual void	SetPosition (float x[2])
virtual void	SetPosition (float x, float y)
virtual float *	GetPosition ()
virtual vtkCoordinate *	GetPosition2Coordinate ()
virtual void	SetPosition2 (float x[2])
virtual void	SetPosition2 (float x, float y)
virtual float *	GetPosition2 ()

virtual void	SetShowBorder (int)
virtual int	GetShowBorder ()
void	SetShowBorderToOff ()
void	SetShowBorderToOn ()
void	SetShowBorderToActive ()

virtual vtkProperty2D *	GetBorderProperty ()

virtual void	SetProportionalResize (int)
virtual int	GetProportionalResize ()
virtual void	ProportionalResizeOn ()
virtual void	ProportionalResizeOff ()

virtual void	SetMinimumSize (int, int)
void	SetMinimumSize (int[2])
virtual int *	GetMinimumSize ()
virtual void	GetMinimumSize (int &, int &)
virtual void	GetMinimumSize (int[2])
virtual void	SetMaximumSize (int, int)
void	SetMaximumSize (int[2])
virtual int *	GetMaximumSize ()
virtual void	GetMaximumSize (int &, int &)
virtual void	GetMaximumSize (int[2])

virtual void	SetTolerance (int)
virtual int	GetTolerance ()

virtual double *	GetSelectionPoint ()
virtual void	GetSelectionPoint (double data[2])

virtual void	SetMoving (int)
virtual int	GetMoving ()
virtual void	MovingOn ()
virtual void	MovingOff ()

virtual void	BuildRepresentation ()
virtual void	StartWidgetInteraction (double eventPos[2])
virtual void	WidgetInteraction (double eventPos[2])
virtual void	GetSize (double size[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)

virtual void	GetActors2D (vtkPropCollection *)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOverlay (vtkViewport *)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	HasTranslucentPolygonalGeometry ()
Static Public Member Functions
static vtkBorderRepresentation *	New ()
Protected Member Functions
	vtkBorderRepresentation ()
	~vtkBorderRepresentation ()
virtual void	NegotiateLayout ()
Protected Attributes
int	ShowBorder
vtkProperty2D *	BorderProperty
int	ProportionalResize
int	Tolerance
int	Moving
double	SelectionPoint [2]
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate
int	Negotiated
double	StartPosition [2]
vtkPoints *	BWPoints
vtkPolyData *	BWPolyData
vtkTransform *	BWTransform
vtkTransformPolyDataFilter *	BWTransformFilter
vtkPolyDataMapper2D *	BWMapper
vtkActor2D *	BWActor
int	MinimumSize [2]
int	MaximumSize [2]

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkBorderRepresentation::Superclass

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

Definition at line 64 of file vtkBorderRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

BORDER_OFF
BORDER_ON
BORDER_ACTIVE

Definition at line 82 of file vtkBorderRepresentation.h.

enum vtkBorderRepresentation::_InteractionState

Define the various states that the representation can be in.

Enumerator:

Outside
Inside
AdjustingP0
AdjustingP1
AdjustingP2
AdjustingP3
AdjustingE0
AdjustingE1
AdjustingE2
AdjustingE3

Definition at line 149 of file vtkBorderRepresentation.h.

Constructor & Destructor Documentation

vtkBorderRepresentation::vtkBorderRepresentation ( ) [protected]

vtkBorderRepresentation::~vtkBorderRepresentation ( ) [protected]

Member Function Documentation

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

Instantiate this class.

Reimplemented from vtkObject.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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

Define standard methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

virtual vtkCoordinate* vtkBorderRepresentation::GetPositionCoordinate ( ) [virtual]

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual void vtkBorderRepresentation::SetPosition ( float x[2] ) [virtual]

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual void vtkBorderRepresentation::SetPosition	(	float	x,
		float	y
	)			`[virtual]`

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual float* vtkBorderRepresentation::GetPosition ( ) [virtual]

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual vtkCoordinate* vtkBorderRepresentation::GetPosition2Coordinate ( ) [virtual]

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual void vtkBorderRepresentation::SetPosition2 ( float x[2] ) [virtual]

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual void vtkBorderRepresentation::SetPosition2	(	float	x,
		float	y
	)			`[virtual]`

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual float* vtkBorderRepresentation::GetPosition2 ( ) [virtual]

Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle. Also,

virtual void vtkBorderRepresentation::SetShowBorder ( int ) [virtual]

Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget.

virtual int vtkBorderRepresentation::GetShowBorder ( ) [virtual]

Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget.

void vtkBorderRepresentation::SetShowBorderToOff ( ) [inline]

Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget.

Definition at line 92 of file vtkBorderRepresentation.h.

void vtkBorderRepresentation::SetShowBorderToOn ( ) [inline]

Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget.

Definition at line 93 of file vtkBorderRepresentation.h.

void vtkBorderRepresentation::SetShowBorderToActive ( ) [inline]

Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget.

Definition at line 94 of file vtkBorderRepresentation.h.

virtual vtkProperty2D* vtkBorderRepresentation::GetBorderProperty ( ) [virtual]

Specify the properties of the border.

virtual void vtkBorderRepresentation::SetProportionalResize ( int ) [virtual]

Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual int vtkBorderRepresentation::GetProportionalResize ( ) [virtual]

Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual void vtkBorderRepresentation::ProportionalResizeOn ( ) [virtual]

Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual void vtkBorderRepresentation::ProportionalResizeOff ( ) [virtual]

Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

virtual void vtkBorderRepresentation::SetMinimumSize	(	int	,
		int
	)			`[virtual]`