draw text label associated with a point More...

#include <vtkCaptionActor2D.h>

Inheritance diagram for vtkCaptionActor2D:

Collaboration diagram for vtkCaptionActor2D:

Public Types
typedef vtkActor2D	Superclass

Public Types inherited from vtkActor2D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCaptionActor2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this scaled text actor.

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?


virtual void	SetCaption (const char *caption)
	Define the text to be placed in the caption.

virtual char *	GetCaption ()
	Define the text to be placed in the caption.


virtual vtkCoordinate *	GetAttachmentPointCoordinate ()
	Set/Get the attachment point for the caption.

virtual void	SetAttachmentPoint (float x[3])
	Set/Get the attachment point for the caption.

virtual void	SetAttachmentPoint (float x, float y, float z)
	Set/Get the attachment point for the caption.

virtual float *	GetAttachmentPoint ()
	Set/Get the attachment point for the caption.


virtual void	SetBorder (vtkTypeBool)
	Enable/disable the placement of a border around the text.

virtual vtkTypeBool	GetBorder ()
	Enable/disable the placement of a border around the text.

virtual void	BorderOn ()
	Enable/disable the placement of a border around the text.

virtual void	BorderOff ()
	Enable/disable the placement of a border around the text.


virtual void	SetLeader (vtkTypeBool)
	Enable/disable drawing a "line" from the caption to the attachment point.

virtual vtkTypeBool	GetLeader ()
	Enable/disable drawing a "line" from the caption to the attachment point.

virtual void	LeaderOn ()
	Enable/disable drawing a "line" from the caption to the attachment point.

virtual void	LeaderOff ()
	Enable/disable drawing a "line" from the caption to the attachment point.


virtual void	SetThreeDimensionalLeader (vtkTypeBool)
	Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

virtual vtkTypeBool	GetThreeDimensionalLeader ()
	Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

virtual void	ThreeDimensionalLeaderOn ()
	Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

virtual void	ThreeDimensionalLeaderOff ()
	Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).


virtual void	SetLeaderGlyphData (vtkPolyData *)
	Specify a glyph to be used as the leader "head".

virtual void	SetLeaderGlyphConnection (vtkAlgorithmOutput *)
	Specify a glyph to be used as the leader "head".

virtual vtkPolyData *	GetLeaderGlyph ()
	Specify a glyph to be used as the leader "head".


virtual void	SetLeaderGlyphSize (double)
	Specify the relative size of the leader head.

virtual double	GetLeaderGlyphSize ()
	Specify the relative size of the leader head.


virtual void	SetMaximumLeaderGlyphSize (int)
	Specify the maximum size of the leader head (if any) in pixels.

virtual int	GetMaximumLeaderGlyphSize ()
	Specify the maximum size of the leader head (if any) in pixels.


virtual void	SetPadding (int)
	Set/Get the padding between the caption and the border.

virtual int	GetPadding ()
	Set/Get the padding between the caption and the border.


virtual vtkTextActor *	GetTextActor ()
	Get the text actor used by the caption.


virtual void	SetCaptionTextProperty (vtkTextProperty *p)
	Set/Get the text property.

virtual vtkTextProperty *	GetCaptionTextProperty ()
	Set/Get the text property.


virtual void	SetAttachEdgeOnly (vtkTypeBool)
	Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual vtkTypeBool	GetAttachEdgeOnly ()
	Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual void	AttachEdgeOnlyOn ()
	Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

virtual void	AttachEdgeOnlyOff ()
	Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.


int	RenderOpaqueGeometry (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

int	RenderOverlay (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkActor2D *	NewInstance () const

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry?

vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D.

virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D.

void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates.

vtkMTimeType	GetMTime () override
	Return this objects MTime.

void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D.

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor.

virtual vtkCoordinate *	GetActualPositionCoordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor.

int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods.

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods.

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods.

virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn.

virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn.

virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render.

virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render.

virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate.

virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate.

virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate.

virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate.

virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable.

virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable.

virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable.

virtual float *	GetPosition2 ()
	Access the Position2 instance variable.

void	SetWidth (double w)
	Set/Get the height and width of the Actor2D.

double	GetWidth ()
	Set/Get the height and width of the Actor2D.

void	SetHeight (double h)
	Set/Get the height and width of the Actor2D.

double	GetHeight ()
	Set/Get the height and width of the Actor2D.

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked.

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.

virtual void	PickableOn ()
	Set/Get the pickable instance variable.

virtual void	PickableOff ()
	Set/Get the pickable instance variable.

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor.

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

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

static vtkCaptionActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkCaptionActor2D *	New ()

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

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0.

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items.

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCaptionActor2D ()

	~vtkCaptionActor2D () override

Protected Member Functions inherited from vtkActor2D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkActor2D ()

	~vtkActor2D () override

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCoordinate *	AttachmentPointCoordinate

vtkTypeBool	Border

vtkTypeBool	Leader

vtkTypeBool	ThreeDimensionalLeader

double	LeaderGlyphSize

int	MaximumLeaderGlyphSize

int	Padding

vtkTypeBool	AttachEdgeOnly

Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

draw text label associated with a point

vtkCaptionActor2D is a hybrid 2D/3D actor that is used to associate text with a point (the AttachmentPoint) in the scene. The caption can be drawn with a rectangular border and a leader connecting the caption to the attachment point. Optionally, the leader can be glyphed at its endpoint to create arrow heads or other indicators.

To use the caption actor, you normally specify the Position and Position2 coordinates (these are inherited from the vtkActor2D superclass). (Note that Position2 can be set using vtkActor2D's SetWidth() and SetHeight() methods.) Position and Position2 define the size of the caption, and a third point, the AttachmentPoint, defines a point that the caption is associated with. You must also define the caption text, whether you want a border around the caption, and whether you want a leader from the caption to the attachment point. The font attributes of the text can be set through the vtkTextProperty associated to this actor. You also indicate whether you want the leader to be 2D or 3D. (2D leaders are always drawn over the underlying geometry. 3D leaders may be occluded by the geometry.) The leader may also be terminated by an optional glyph (e.g., arrow).

The trickiest part about using this class is setting Position, Position2, and AttachmentPoint correctly. These instance variables are vtkCoordinates, and can be set up in various ways. In default usage, the AttachmentPoint is defined in the world coordinate system, Position is the lower-left corner of the caption and relative to AttachmentPoint (defined in display coordaintes, i.e., pixels), and Position2 is relative to Position and is the upper-right corner (also in display coordinates). However, the user has full control over the coordinates, and can do things like place the caption in a fixed position in the renderer, with the leader moving with the AttachmentPoint.

See also: vtkLegendBoxActor vtkTextMapper vtkTextActor vtkTextProperty vtkCoordinate

Online Examples:

AnatomicalOrientation

CaptionWidget

Definition at line 143 of file vtkCaptionActor2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkActor2D vtkCaptionActor2D::Superclass

Definition at line 146 of file vtkCaptionActor2D.h.

Constructor & Destructor Documentation

◆ vtkCaptionActor2D()

vtkCaptionActor2D::vtkCaptionActor2D ( )

protected

◆ ~vtkCaptionActor2D()

vtkCaptionActor2D::~vtkCaptionActor2D ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkCaptionActor2D::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkCaptionActor2D::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.

◆ SafeDownCast()

static vtkCaptionActor2D * vtkCaptionActor2D::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCaptionActor2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

◆ NewInstance()

vtkCaptionActor2D * vtkCaptionActor2D::NewInstance ( ) const

◆ PrintSelf()

void vtkCaptionActor2D::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ New()

static vtkCaptionActor2D * vtkCaptionActor2D::New ( )

static

◆ SetCaption()

virtual void vtkCaptionActor2D::SetCaption ( const char * caption )

virtual

Define the text to be placed in the caption.

The text can be multiple lines (separated by "\n").

◆ GetCaption()

virtual char * vtkCaptionActor2D::GetCaption ( )

virtual

Define the text to be placed in the caption.

The text can be multiple lines (separated by "\n").

◆ GetAttachmentPointCoordinate()

virtual vtkCoordinate * vtkCaptionActor2D::GetAttachmentPointCoordinate ( )

virtual

Set/Get the attachment point for the caption.

By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

◆ SetAttachmentPoint() [1/2]

virtual void vtkCaptionActor2D::SetAttachmentPoint ( float x[3] )

virtual

Set/Get the attachment point for the caption.

By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

◆ SetAttachmentPoint() [2/2]

virtual void vtkCaptionActor2D::SetAttachmentPoint	(	float	x,
		float	y,
		float	z
	)

virtual

Set/Get the attachment point for the caption.

By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

◆ GetAttachmentPoint()

virtual float * vtkCaptionActor2D::GetAttachmentPoint ( )

virtual

Set/Get the attachment point for the caption.

By default, the attachment point is defined in world coordinates, but this can be changed using vtkCoordinate methods.

◆ SetBorder()

virtual void vtkCaptionActor2D::SetBorder ( vtkTypeBool )

virtual

Enable/disable the placement of a border around the text.

◆ GetBorder()

virtual vtkTypeBool vtkCaptionActor2D::GetBorder ( )

virtual

Enable/disable the placement of a border around the text.

◆ BorderOn()

virtual void vtkCaptionActor2D::BorderOn ( )

virtual

Enable/disable the placement of a border around the text.

◆ BorderOff()

virtual void vtkCaptionActor2D::BorderOff ( )

virtual

Enable/disable the placement of a border around the text.

◆ SetLeader()

virtual void vtkCaptionActor2D::SetLeader ( vtkTypeBool )

virtual

Enable/disable drawing a "line" from the caption to the attachment point.

◆ GetLeader()

virtual vtkTypeBool vtkCaptionActor2D::GetLeader ( )

virtual

Enable/disable drawing a "line" from the caption to the attachment point.

◆ LeaderOn()

virtual void vtkCaptionActor2D::LeaderOn ( )

virtual

Enable/disable drawing a "line" from the caption to the attachment point.

◆ LeaderOff()

virtual void vtkCaptionActor2D::LeaderOff ( )

virtual

Enable/disable drawing a "line" from the caption to the attachment point.

◆ SetThreeDimensionalLeader()

virtual void vtkCaptionActor2D::SetThreeDimensionalLeader ( vtkTypeBool )

virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

◆ GetThreeDimensionalLeader()

virtual vtkTypeBool vtkCaptionActor2D::GetThreeDimensionalLeader ( )

virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

◆ ThreeDimensionalLeaderOn()

virtual void vtkCaptionActor2D::ThreeDimensionalLeaderOn ( )

virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

◆ ThreeDimensionalLeaderOff()

virtual void vtkCaptionActor2D::ThreeDimensionalLeaderOff ( )

virtual

Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered).

◆ SetLeaderGlyphData()

virtual void vtkCaptionActor2D::SetLeaderGlyphData ( vtkPolyData * )

virtual

Specify a glyph to be used as the leader "head".

This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin. SetLeaderGlyphData() directly uses the polydata without setting a pipeline connection. SetLeaderGlyphConnection() sets up a pipeline connection and causes an update to the input during render.

◆ SetLeaderGlyphConnection()

virtual void vtkCaptionActor2D::SetLeaderGlyphConnection ( vtkAlgorithmOutput * )

virtual

Specify a glyph to be used as the leader "head".

This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin. SetLeaderGlyphData() directly uses the polydata without setting a pipeline connection. SetLeaderGlyphConnection() sets up a pipeline connection and causes an update to the input during render.

◆ GetLeaderGlyph()

virtual vtkPolyData * vtkCaptionActor2D::GetLeaderGlyph ( )

virtual

Specify a glyph to be used as the leader "head".

This could be something like an arrow or sphere. If not specified, no glyph is drawn. Note that the glyph is assumed to be aligned along the x-axis and is rotated about the origin. SetLeaderGlyphData() directly uses the polydata without setting a pipeline connection. SetLeaderGlyphConnection() sets up a pipeline connection and causes an update to the input during render.

◆ SetLeaderGlyphSize()

virtual void vtkCaptionActor2D::SetLeaderGlyphSize ( double )

virtual

Specify the relative size of the leader head.

This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.

◆ GetLeaderGlyphSize()

virtual double vtkCaptionActor2D::GetLeaderGlyphSize ( )

virtual

Specify the relative size of the leader head.

This is expressed as a fraction of the size (diagonal length) of the renderer. The leader head is automatically scaled so that window resize, zooming or other camera motion results in proportional changes in size to the leader glyph.

◆ SetMaximumLeaderGlyphSize()

virtual void vtkCaptionActor2D::SetMaximumLeaderGlyphSize ( int )

virtual

Specify the maximum size of the leader head (if any) in pixels.

This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

◆ GetMaximumLeaderGlyphSize()

virtual int vtkCaptionActor2D::GetMaximumLeaderGlyphSize ( )

virtual

Specify the maximum size of the leader head (if any) in pixels.

This is used in conjunction with LeaderGlyphSize to cap the maximum size of the LeaderGlyph.

◆ SetPadding()

virtual void vtkCaptionActor2D::SetPadding ( int )

virtual

Set/Get the padding between the caption and the border.

The value is specified in pixels.

◆ GetPadding()

virtual int vtkCaptionActor2D::GetPadding ( )

virtual

Set/Get the padding between the caption and the border.

The value is specified in pixels.

◆ GetTextActor()

virtual vtkTextActor * vtkCaptionActor2D::GetTextActor ( )

virtual

Get the text actor used by the caption.

This is useful if you want to control justification and other characteristics of the text actor.

◆ SetCaptionTextProperty()

virtual void vtkCaptionActor2D::SetCaptionTextProperty ( vtkTextProperty * p )

virtual

Set/Get the text property.

◆ GetCaptionTextProperty()

virtual vtkTextProperty * vtkCaptionActor2D::GetCaptionTextProperty ( )

virtual

Set/Get the text property.

◆ ShallowCopy()

void vtkCaptionActor2D::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy of this scaled text actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

◆ SetAttachEdgeOnly()

virtual void vtkCaptionActor2D::SetAttachEdgeOnly ( vtkTypeBool )

virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

◆ GetAttachEdgeOnly()

virtual vtkTypeBool vtkCaptionActor2D::GetAttachEdgeOnly ( )

virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

◆ AttachEdgeOnlyOn()

virtual void vtkCaptionActor2D::AttachEdgeOnlyOn ( )

virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

◆ AttachEdgeOnlyOff()

virtual void vtkCaptionActor2D::AttachEdgeOnlyOff ( )

virtual

Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border.

◆ ReleaseGraphicsResources()

void vtkCaptionActor2D::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkCaptionActor2D::RenderOpaqueGeometry ( vtkViewport * viewport )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the legend box to the screen.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkCaptionActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport * )

inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the legend box to the screen.

Reimplemented from vtkProp.

Definition at line 290 of file vtkCaptionActor2D.h.

◆ RenderOverlay()

int vtkCaptionActor2D::RenderOverlay ( vtkViewport * viewport )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the legend box to the screen.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkCaptionActor2D::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

Member Data Documentation

◆ AttachmentPointCoordinate

vtkCoordinate* vtkCaptionActor2D::AttachmentPointCoordinate

protected

Definition at line 303 of file vtkCaptionActor2D.h.

◆ Border

vtkTypeBool vtkCaptionActor2D::Border

protected

Definition at line 305 of file vtkCaptionActor2D.h.

◆ Leader

vtkTypeBool vtkCaptionActor2D::Leader

protected

Definition at line 306 of file vtkCaptionActor2D.h.

◆ ThreeDimensionalLeader

vtkTypeBool vtkCaptionActor2D::ThreeDimensionalLeader

protected

Definition at line 307 of file vtkCaptionActor2D.h.

◆ LeaderGlyphSize

double vtkCaptionActor2D::LeaderGlyphSize

protected

Definition at line 308 of file vtkCaptionActor2D.h.

◆ MaximumLeaderGlyphSize

int vtkCaptionActor2D::MaximumLeaderGlyphSize

protected

Definition at line 309 of file vtkCaptionActor2D.h.

◆ Padding

int vtkCaptionActor2D::Padding

protected

Definition at line 311 of file vtkCaptionActor2D.h.

◆ AttachEdgeOnly

vtkTypeBool vtkCaptionActor2D::AttachEdgeOnly

protected

Definition at line 312 of file vtkCaptionActor2D.h.

The documentation for this class was generated from the following file:

Rendering/Annotation/vtkCaptionActor2D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCaptionActor2D()

◆ ~vtkCaptionActor2D()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetCaption()

◆ GetCaption()

◆ GetAttachmentPointCoordinate()

◆ SetAttachmentPoint() [1/2]

◆ SetAttachmentPoint() [2/2]

◆ GetAttachmentPoint()

◆ SetBorder()

◆ GetBorder()

◆ BorderOn()

◆ BorderOff()

◆ SetLeader()

◆ GetLeader()

◆ LeaderOn()

◆ LeaderOff()

◆ SetThreeDimensionalLeader()

◆ GetThreeDimensionalLeader()

◆ ThreeDimensionalLeaderOn()

◆ ThreeDimensionalLeaderOff()

◆ SetLeaderGlyphData()

◆ SetLeaderGlyphConnection()

◆ GetLeaderGlyph()

◆ SetLeaderGlyphSize()

◆ GetLeaderGlyphSize()

◆ SetMaximumLeaderGlyphSize()

◆ GetMaximumLeaderGlyphSize()

◆ SetPadding()

◆ GetPadding()

◆ GetTextActor()

◆ SetCaptionTextProperty()

◆ GetCaptionTextProperty()

◆ ShallowCopy()

◆ SetAttachEdgeOnly()

◆ GetAttachEdgeOnly()

◆ AttachEdgeOnlyOn()

◆ AttachEdgeOnlyOff()

◆ ReleaseGraphicsResources()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ RenderOverlay()

◆ HasTranslucentPolygonalGeometry()

Member Data Documentation

◆ AttachmentPointCoordinate

◆ Border

◆ Leader

◆ ThreeDimensionalLeader

◆ LeaderGlyphSize

◆ MaximumLeaderGlyphSize

◆ Padding

◆ AttachEdgeOnly