vtkCaptionRepresentation Class Reference

#include <vtkCaptionRepresentation.h>

Inheritance diagram for vtkCaptionRepresentation:

[legend]

Collaboration diagram for vtkCaptionRepresentation:

[legend]

List of all members.

Detailed Description

represents vtkCaptionWidget in the scene

This class represents vtkCaptionWidget. A caption is defined by some text with a leader (e.g., arrow) that points from the text to a point in the scene. The caption is defined by an instance of vtkCaptionActor2D. It uses the event bindings of its superclass (vtkBorderWidget) to control the placement of the text, and adds the ability to move the attachment point around. In addition, when the caption text is selected, the widget emits a ActivateEvent that observers can watch for. This is useful for opening GUI dialogoues to adjust font characteristics, etc. (Please see the superclass for a description of event bindings.)

Note that this widget extends the behavior of its superclass vtkBorderRepresentation.

See also:: vtkCaptionWidget vtkBorderWidget vtkBorderRepresentation vtkCaptionActor

Definition at line 46 of file vtkCaptionRepresentation.h.


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

void	SetAnchorPosition (double pos[3])
void	GetAnchorPosition (double pos[3])

void	SetCaptionActor2D (vtkCaptionActor2D *captionActor)
virtual vtkCaptionActor2D *	GetCaptionActor2D ()

void	SetAnchorRepresentation (vtkPointHandleRepresentation3D *)
virtual vtkPointHandleRepresentation3D *	GetAnchorRepresentation ()

virtual void	BuildRepresentation ()
virtual void	GetSize (double size[2])

virtual void	GetActors2D (vtkPropCollection *)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOverlay (vtkViewport *)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	HasTranslucentPolygonalGeometry ()

virtual void	SetFontFactor (double)
virtual double	GetFontFactor ()
Static Public Member Functions
static vtkCaptionRepresentation *	New ()
Protected Member Functions
	vtkCaptionRepresentation ()
	~vtkCaptionRepresentation ()
virtual void	AdjustCaptionBoundary ()
Protected Attributes
vtkCaptionActor2D *	CaptionActor2D
vtkConeSource *	CaptionGlyph
int	PointWidgetState
int	DisplayAttachmentPoint [2]
double	FontFactor
vtkPointHandleRepresentation3D *	AnchorRepresentation

Member Typedef Documentation

typedef vtkBorderRepresentation vtkCaptionRepresentation::Superclass

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

Definition at line 54 of file vtkCaptionRepresentation.h.

Constructor & Destructor Documentation

vtkCaptionRepresentation::vtkCaptionRepresentation ( ) [protected]

vtkCaptionRepresentation::~vtkCaptionRepresentation ( ) [protected]

Member Function Documentation

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

Instantiate this class.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

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

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

void vtkCaptionRepresentation::SetAnchorPosition ( double pos[3] )

Specify the position of the anchor (i.e., the point that the caption is anchored to). Note that the position should be specified in world coordinates.

void vtkCaptionRepresentation::GetAnchorPosition ( double pos[3] )

Specify the position of the anchor (i.e., the point that the caption is anchored to). Note that the position should be specified in world coordinates.

void vtkCaptionRepresentation::SetCaptionActor2D ( vtkCaptionActor2D * captionActor )

Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.

virtual vtkCaptionActor2D* vtkCaptionRepresentation::GetCaptionActor2D ( ) [virtual]

Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.

void vtkCaptionRepresentation::SetAnchorRepresentation ( vtkPointHandleRepresentation3D * )

Set and get the instances of vtkPointHandleRepresention3D used to implement this representation. Normally default representations are created, but you can specify the ones you want to use.

virtual vtkPointHandleRepresentation3D* vtkCaptionRepresentation::GetAnchorRepresentation ( ) [virtual]

Set and get the instances of vtkPointHandleRepresention3D used to implement this representation. Normally default representations are created, but you can specify the ones you want to use.

virtual void vtkCaptionRepresentation::BuildRepresentation ( ) [virtual]

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

virtual void vtkCaptionRepresentation::GetSize ( double size[2] ) [inline, virtual]

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

Definition at line 84 of file vtkCaptionRepresentation.h.

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