create a leader with optional label and arrows More...

#include <vtkLeaderActor2D.h>

Inheritance diagram for vtkLeaderActor2D:

Collaboration diagram for vtkLeaderActor2D:

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 Types inherited from vtkActor2D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkLeaderActor2D *	NewInstance () const

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 *)

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent)

vtkActor2D *	NewInstance () const

vtkProperty2D *	GetProperty ()

virtual void	SetProperty (vtkProperty2D *)

void	SetDisplayPosition (int, int)

virtual unsigned long	GetMTime ()

virtual void	GetActors2D (vtkPropCollection *pc)

virtual void	SetMapper (vtkMapper2D *mapper)

virtual vtkMapper2D *	GetMapper ()

virtual void	SetLayerNumber (int)

virtual int	GetLayerNumber ()

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 ()

void	SetWidth (double w)

double	GetWidth ()

void	SetHeight (double h)

double	GetHeight ()

virtual vtkCoordinate *	GetActualPositionCoordinate (void)

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkLeaderActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkLeaderActor2D *	New ()

Static Public Member Functions inherited from vtkActor2D
static int	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	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 Member Functions inherited from vtkActor2D
	vtkActor2D ()

	~vtkActor2D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 58 of file vtkLeaderActor2D.h.

Member Typedef Documentation

typedef vtkActor2D vtkLeaderActor2D::Superclass

Definition at line 61 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 105 of file vtkLeaderActor2D.h.

anonymous enum

Enumerator
VTK_ARROW_FILLED
VTK_ARROW_OPEN
VTK_ARROW_HOLLOW

Definition at line 106 of file vtkLeaderActor2D.h.

Constructor & Destructor Documentation

vtkLeaderActor2D::vtkLeaderActor2D ( )

protected

vtkLeaderActor2D::~vtkLeaderActor2D ( )

protected

Member Function Documentation

static int vtkLeaderActor2D::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkLeaderActor2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

vtkLeaderActor2D* vtkLeaderActor2D::NewInstance ( ) const

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 vtkObject.

static vtkLeaderActor2D* vtkLeaderActor2D::New ( )

static

Instantiate object.

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