VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCaptionActor2D Class Reference

draw text label associated with a point More...

#include <vtkCaptionActor2D.h>

Inheritance diagram for vtkCaptionActor2D:
[legend]
Collaboration diagram for vtkCaptionActor2D:
[legend]

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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCaptionActor2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this scaled text actor. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
int HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
virtual void SetCaption (const char *caption)
 Define the text to be placed in the caption. More...
 
virtual char * GetCaption ()
 Define the text to be placed in the caption. More...
 
virtual vtkCoordinateGetAttachmentPointCoordinate ()
 Set/Get the attachment point for the caption. More...
 
virtual void SetAttachmentPoint (float x[3])
 Set/Get the attachment point for the caption. More...
 
virtual void SetAttachmentPoint (float x, float y, float z)
 Set/Get the attachment point for the caption. More...
 
virtual floatGetAttachmentPoint ()
 Set/Get the attachment point for the caption. More...
 
virtual void SetBorder (int)
 Enable/disable the placement of a border around the text. More...
 
virtual int GetBorder ()
 Enable/disable the placement of a border around the text. More...
 
virtual void BorderOn ()
 Enable/disable the placement of a border around the text. More...
 
virtual void BorderOff ()
 Enable/disable the placement of a border around the text. More...
 
virtual void SetLeader (int)
 Enable/disable drawing a "line" from the caption to the attachment point. More...
 
virtual int GetLeader ()
 Enable/disable drawing a "line" from the caption to the attachment point. More...
 
virtual void LeaderOn ()
 Enable/disable drawing a "line" from the caption to the attachment point. More...
 
virtual void LeaderOff ()
 Enable/disable drawing a "line" from the caption to the attachment point. More...
 
virtual void SetThreeDimensionalLeader (int)
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered). More...
 
virtual int GetThreeDimensionalLeader ()
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered). More...
 
virtual void ThreeDimensionalLeaderOn ()
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered). More...
 
virtual void ThreeDimensionalLeaderOff ()
 Indicate whether the leader is 2D (no hidden line) or 3D (z-buffered). More...
 
virtual void SetLeaderGlyphData (vtkPolyData *)
 Specify a glyph to be used as the leader "head". More...
 
virtual void SetLeaderGlyphConnection (vtkAlgorithmOutput *)
 Specify a glyph to be used as the leader "head". More...
 
virtual vtkPolyDataGetLeaderGlyph ()
 Specify a glyph to be used as the leader "head". More...
 
virtual void SetLeaderGlyphSize (double)
 Specify the relative size of the leader head. More...
 
virtual double GetLeaderGlyphSize ()
 Specify the relative size of the leader head. More...
 
virtual void SetMaximumLeaderGlyphSize (int)
 Specify the maximum size of the leader head (if any) in pixels. More...
 
virtual int GetMaximumLeaderGlyphSize ()
 Specify the maximum size of the leader head (if any) in pixels. More...
 
virtual void SetPadding (int)
 Set/Get the padding between the caption and the border. More...
 
virtual int GetPadding ()
 Set/Get the padding between the caption and the border. More...
 
virtual vtkTextActorGetTextActor ()
 Get the text actor used by the caption. More...
 
virtual void SetCaptionTextProperty (vtkTextProperty *p)
 Set/Get the text property. More...
 
virtual vtkTextPropertyGetCaptionTextProperty ()
 Set/Get the text property. More...
 
virtual void SetAttachEdgeOnly (int)
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border. More...
 
virtual int GetAttachEdgeOnly ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border. More...
 
virtual void AttachEdgeOnlyOn ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border. More...
 
virtual void AttachEdgeOnlyOff ()
 Enable/disable whether to attach the arrow only to the edge, NOT the vertices of the caption border. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
int RenderOverlay (vtkViewport *viewport) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
- 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. More...
 
vtkActor2DNewInstance () const
 
int HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
vtkProperty2DGetProperty ()
 Returns this actor's vtkProperty2D. More...
 
virtual void SetProperty (vtkProperty2D *)
 Set this vtkProp's vtkProperty2D. More...
 
void SetDisplayPosition (int, int)
 Set the Prop2D's position in display coordinates. More...
 
vtkMTimeType GetMTime () override
 Return this objects MTime. More...
 
void GetActors2D (vtkPropCollection *pc) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkActor2D. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
virtual vtkCoordinateGetActualPositionCoordinate (void)
 Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...
 
virtual vtkCoordinateGetActualPosition2Coordinate (void)
 Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...
 
int RenderOverlay (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
virtual void SetMapper (vtkMapper2D *mapper)
 Set/Get the vtkMapper2D which defines the data to be drawn. More...
 
virtual vtkMapper2DGetMapper ()
 Set/Get the vtkMapper2D which defines the data to be drawn. More...
 
virtual void SetLayerNumber (int)
 Set/Get the layer number in the overlay planes into which to render. More...
 
virtual int GetLayerNumber ()
 Set/Get the layer number in the overlay planes into which to render. More...
 
virtual vtkCoordinateGetPositionCoordinate ()
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual void SetPosition (float x[2])
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual void SetPosition (float x, float y)
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual floatGetPosition ()
 Get the PositionCoordinate instance of vtkCoordinate. More...
 
virtual vtkCoordinateGetPosition2Coordinate ()
 Access the Position2 instance variable. More...
 
virtual void SetPosition2 (float x[2])
 Access the Position2 instance variable. More...
 
virtual void SetPosition2 (float x, float y)
 Access the Position2 instance variable. More...
 
virtual floatGetPosition2 ()
 Access the Position2 instance variable. More...
 
void SetWidth (double w)
 Set/Get the height and width of the Actor2D. More...
 
double GetWidth ()
 Set/Get the height and width of the Actor2D. More...
 
void SetHeight (double h)
 Set/Get the height and width of the Actor2D. More...
 
double GetHeight ()
 Set/Get the height and width of the Actor2D. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual doubleGetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetVisibility (int)
 Set/Get visibility of this vtkProp. More...
 
virtual int GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (int)
 Set/Get the pickable instance variable. More...
 
virtual int GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (int)
 Set/Get the value of the dragable instance variable. More...
 
virtual int GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
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(). More...
 
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(). More...
 
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(). More...
 
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(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
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. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCaptionActor2DSafeDownCast (vtkObjectBase *o)
 
static vtkCaptionActor2DNew ()
 
- Static Public Member Functions inherited from vtkActor2D
static int IsTypeOf (const char *type)
 
static vtkActor2DSafeDownCast (vtkObjectBase *o)
 
static vtkActor2DNew ()
 Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. More...
 
- Static Public Member Functions inherited from vtkProp
static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCaptionActor2D ()
 
 ~vtkCaptionActor2D () override
 
- Protected Member Functions inherited from vtkActor2D
 vtkActor2D ()
 
 ~vtkActor2D () override
 
- Protected Member Functions inherited from vtkProp
 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

vtkCoordinateAttachmentPointCoordinate
 
int Border
 
int Leader
 
int ThreeDimensionalLeader
 
double LeaderGlyphSize
 
int MaximumLeaderGlyphSize
 
int Padding
 
int AttachEdgeOnly
 
- Protected Attributes inherited from vtkActor2D
vtkMapper2DMapper
 
int LayerNumber
 
vtkProperty2DProperty
 
vtkCoordinatePositionCoordinate
 
vtkCoordinatePosition2Coordinate
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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
Tests:
vtkCaptionActor2D (Tests)

Definition at line 77 of file vtkCaptionActor2D.h.

Member Typedef Documentation

Definition at line 80 of file vtkCaptionActor2D.h.

Constructor & Destructor Documentation

vtkCaptionActor2D::vtkCaptionActor2D ( )
protected
vtkCaptionActor2D::~vtkCaptionActor2D ( )
overrideprotected

Member Function Documentation

static int vtkCaptionActor2D::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkCaptionActor2D* vtkCaptionActor2D::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCaptionActor2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkActor2D.

vtkCaptionActor2D* vtkCaptionActor2D::NewInstance ( ) const
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.

static vtkCaptionActor2D* vtkCaptionActor2D::New ( )
static
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").

virtual char* vtkCaptionActor2D::GetCaption ( )
virtual

Define the text to be placed in the caption.

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

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.

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.

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.

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.

virtual void vtkCaptionActor2D::SetBorder ( int  )
virtual

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

virtual int vtkCaptionActor2D::GetBorder ( )
virtual

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

virtual void vtkCaptionActor2D::BorderOn ( )
virtual

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

virtual void vtkCaptionActor2D::BorderOff ( )
virtual

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

virtual void vtkCaptionActor2D::SetLeader ( int  )
virtual

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

virtual int vtkCaptionActor2D::GetLeader ( )
virtual

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

virtual void vtkCaptionActor2D::LeaderOn ( )
virtual

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

virtual void vtkCaptionActor2D::LeaderOff ( )
virtual

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

virtual void vtkCaptionActor2D::SetThreeDimensionalLeader ( int  )
virtual

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

virtual int vtkCaptionActor2D::GetThreeDimensionalLeader ( )
virtual

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

virtual void vtkCaptionActor2D::ThreeDimensionalLeaderOn ( )
virtual

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

virtual void vtkCaptionActor2D::ThreeDimensionalLeaderOff ( )
virtual

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

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.

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.

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.

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.

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.

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.

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.

virtual void vtkCaptionActor2D::SetPadding ( int  )
virtual

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

The value is specified in pixels.

virtual int vtkCaptionActor2D::GetPadding ( )
virtual

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

The value is specified in pixels.

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.

virtual void vtkCaptionActor2D::SetCaptionTextProperty ( vtkTextProperty p)
virtual

Set/Get the text property.

virtual vtkTextProperty* vtkCaptionActor2D::GetCaptionTextProperty ( )
virtual

Set/Get the text property.

void vtkCaptionActor2D::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this scaled text actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

virtual void vtkCaptionActor2D::SetAttachEdgeOnly ( int  )
virtual

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

virtual int vtkCaptionActor2D::GetAttachEdgeOnly ( )
virtual

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

virtual void vtkCaptionActor2D::AttachEdgeOnlyOn ( )
virtual

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

virtual void vtkCaptionActor2D::AttachEdgeOnlyOff ( )
virtual

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

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.

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.

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 224 of file vtkCaptionActor2D.h.

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.

int vtkCaptionActor2D::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

Member Data Documentation

vtkCoordinate* vtkCaptionActor2D::AttachmentPointCoordinate
protected

Definition at line 237 of file vtkCaptionActor2D.h.

int vtkCaptionActor2D::Border
protected

Definition at line 239 of file vtkCaptionActor2D.h.

int vtkCaptionActor2D::Leader
protected

Definition at line 240 of file vtkCaptionActor2D.h.

int vtkCaptionActor2D::ThreeDimensionalLeader
protected

Definition at line 241 of file vtkCaptionActor2D.h.

double vtkCaptionActor2D::LeaderGlyphSize
protected

Definition at line 242 of file vtkCaptionActor2D.h.

int vtkCaptionActor2D::MaximumLeaderGlyphSize
protected

Definition at line 243 of file vtkCaptionActor2D.h.

int vtkCaptionActor2D::Padding
protected

Definition at line 245 of file vtkCaptionActor2D.h.

int vtkCaptionActor2D::AttachEdgeOnly
protected

Definition at line 246 of file vtkCaptionActor2D.h.


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