vtkLeaderActor2D Class Reference

#include <vtkLeaderActor2D.h>

Inheritance diagram for vtkLeaderActor2D:

[legend]

Collaboration diagram for vtkLeaderActor2D:

[legend]

List of all members.

Detailed Description

create a leader with optional label and arrows

vtkLeaderActor2D creates a leader with an optional label and arrows. (A leader is typically used to indicate distance between points.) vtkLeaderActor2D is a type of vtkActor2D; that is, it is drawn on the overlay plane and is not occluded by 3D geometry. To use this class, you typically specify two points defining the start and end points of the line (x-y definition using vtkCoordinate class), whether to place arrows on one or both end points, and whether to label the leader. Also, this class has a special feature that allows curved leaders to be created by specifying a radius.

Use the vtkLeaderActor2D uses its superclass vtkActor2D instance variables Position and Position2 vtkCoordinates to place an instance of vtkLeaderActor2D (i.e., these two data members represent the start and end points of the leader). Using these vtkCoordinates you can specify the position of the leader in a variety of coordinate systems.

To control the appearance of the actor, use the superclasses vtkActor2D::vtkProperty2D and the vtkTextProperty objects associated with this actor.

See also:: vtkAxisActor2D vtkActor2D vtkCoordinate vtkTextProperty

Tests:: vtkLeaderActor2D (Tests)

Definition at line 57 of file vtkLeaderActor2D.h.


Public Types
enum	{ VTK_ARROW_NONE = 0, VTK_ARROW_POINT1, VTK_ARROW_POINT2, VTK_ARROW_BOTH }
enum	{ VTK_ARROW_FILLED = 0, VTK_ARROW_OPEN, VTK_ARROW_HOLLOW }
typedef vtkActor2D	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	HasTranslucentPolygonalGeometry ()
void	ReleaseGraphicsResources (vtkWindow *)
void	ShallowCopy (vtkProp *prop)

virtual void	SetRadius (double)
virtual double	GetRadius ()

virtual void	SetLabel (const char *)
virtual char *	GetLabel ()

virtual void	SetLabelTextProperty (vtkTextProperty *p)
virtual vtkTextProperty *	GetLabelTextProperty ()

virtual void	SetLabelFactor (double)
virtual double	GetLabelFactor ()

virtual void	SetArrowPlacement (int)
virtual int	GetArrowPlacement ()
void	SetArrowPlacementToNone ()
void	SetArrowPlacementToPoint1 ()
void	SetArrowPlacementToPoint2 ()
void	SetArrowPlacementToBoth ()

virtual void	SetArrowStyle (int)
virtual int	GetArrowStyle ()
void	SetArrowStyleToFilled ()
void	SetArrowStyleToOpen ()
void	SetArrowStyleToHollow ()

virtual void	SetArrowLength (double)
virtual double	GetArrowLength ()
virtual void	SetArrowWidth (double)
virtual double	GetArrowWidth ()

virtual void	SetMinimumArrowSize (double)
virtual double	GetMinimumArrowSize ()
virtual void	SetMaximumArrowSize (double)
virtual double	GetMaximumArrowSize ()

virtual void	SetAutoLabel (int)
virtual int	GetAutoLabel ()
virtual void	AutoLabelOn ()
virtual void	AutoLabelOff ()

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

virtual double	GetLength ()
virtual double	GetAngle ()

int	RenderOverlay (vtkViewport *viewport)
int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkLeaderActor2D *	SafeDownCast (vtkObject *o)
static vtkLeaderActor2D *	New ()
Protected Member Functions
	vtkLeaderActor2D ()
	~vtkLeaderActor2D ()
virtual void	BuildLeader (vtkViewport *viewport)
int	SetFontSize (vtkViewport viewport, vtkTextMapper textMapper, int targetSize, double factor, int stringSize)
int	ClipLeader (double xL[3], int stringSize[2], double p1[3], double ray[3], double c1[3], double c2[3])
void	BuildCurvedLeader (double p1[3], double p2[3], double ray[3], double rayLength, double theta, vtkViewport *viewport, int viewportChanged)
int	InStringBox (double center[3], int stringSize[2], double x[3])
Protected Attributes
double	Radius
double	Length
double	Angle
int	AutoLabel
char *	LabelFormat
char *	Label
double	LabelFactor
vtkTextMapper *	LabelMapper
vtkActor2D *	LabelActor
vtkTextProperty *	LabelTextProperty
int	ArrowPlacement
int	ArrowStyle
double	ArrowLength
double	ArrowWidth
double	MinimumArrowSize
double	MaximumArrowSize
vtkPoints *	LeaderPoints
vtkCellArray *	LeaderLines
vtkCellArray *	LeaderArrows
vtkPolyData *	Leader
vtkPolyDataMapper2D *	LeaderMapper
vtkActor2D *	LeaderActor
int	LastPosition [2]
int	LastPosition2 [2]
int	LastSize [2]
vtkTimeStamp	BuildTime

Member Typedef Documentation

typedef vtkActor2D vtkLeaderActor2D::Superclass

Reimplemented from vtkActor2D.

Definition at line 60 of file vtkLeaderActor2D.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

VTK_ARROW_NONE
VTK_ARROW_POINT1
VTK_ARROW_POINT2
VTK_ARROW_BOTH

Definition at line 104 of file vtkLeaderActor2D.h.

anonymous enum

Enumerator:

VTK_ARROW_FILLED
VTK_ARROW_OPEN
VTK_ARROW_HOLLOW

Definition at line 105 of file vtkLeaderActor2D.h.

Constructor & Destructor Documentation

vtkLeaderActor2D::vtkLeaderActor2D ( ) [protected]

vtkLeaderActor2D::~vtkLeaderActor2D ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkActor2D.

static int vtkLeaderActor2D::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

virtual int vtkLeaderActor2D::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

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

Reimplemented from vtkActor2D.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkActor2D.

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

Instantiate object.

Reimplemented from vtkActor2D.

virtual void vtkLeaderActor2D::SetRadius ( double ) [virtual]

Set/Get a radius which can be used to curve the leader. If a radius is specified whose absolute value is greater than one half the distance between the two points defined by the superclasses' Position and Position2 ivars, then the leader will be curved. A positive radius will produce a curve such that the center is to the right of the line from Position and Position2; a negative radius will produce a curve in the opposite sense. By default, the radius is set to zero and thus there is no curvature. Note that the radius is expresses as a multiple of the distance between (Position,Position2); this avoids issues relative to coordinate system transformations.

virtual double vtkLeaderActor2D::GetRadius ( ) [virtual]

Set/Get a radius which can be used to curve the leader. If a radius is specified whose absolute value is greater than one half the distance between the two points defined by the superclasses' Position and Position2 ivars, then the leader will be curved. A positive radius will produce a curve such that the center is to the right of the line from Position and Position2; a negative radius will produce a curve in the opposite sense. By default, the radius is set to zero and thus there is no curvature. Note that the radius is expresses as a multiple of the distance between (Position,Position2); this avoids issues relative to coordinate system transformations.

virtual void vtkLeaderActor2D::SetLabel ( const char * ) [virtual]

Set/Get the label for the leader. If the label is an empty string, then it will not be drawn.

virtual char* vtkLeaderActor2D::GetLabel ( ) [virtual]

Set/Get the label for the leader. If the label is an empty string, then it will not be drawn.

virtual void vtkLeaderActor2D::SetLabelTextProperty ( vtkTextProperty * p ) [virtual]

Set/Get the text property of the label.

virtual vtkTextProperty* vtkLeaderActor2D::GetLabelTextProperty ( ) [virtual]

Set/Get the text property of the label.

virtual void vtkLeaderActor2D::SetLabelFactor ( double ) [virtual]

Set/Get the factor that controls the overall size of the fonts used to label the leader.

virtual double vtkLeaderActor2D::GetLabelFactor ( ) [virtual]

Set/Get the factor that controls the overall size of the fonts used to label the leader.

virtual void vtkLeaderActor2D::SetArrowPlacement ( int ) [virtual]