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

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

#include <vtkLeaderActor2D.h>

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

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 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. More...
 
vtkLeaderActor2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
virtual void SetRadius (double)
 Set/Get a radius which can be used to curve the leader. More...
 
virtual double GetRadius ()
 Set/Get a radius which can be used to curve the leader. More...
 
virtual void SetLabel (const char *)
 Set/Get the label for the leader. More...
 
virtual char * GetLabel ()
 Set/Get the label for the leader. More...
 
virtual void SetLabelTextProperty (vtkTextProperty *p)
 Set/Get the text property of the label. More...
 
virtual vtkTextPropertyGetLabelTextProperty ()
 Set/Get the text property of the label. More...
 
virtual void SetLabelFactor (double)
 Set/Get the factor that controls the overall size of the fonts used to label the leader. More...
 
virtual double GetLabelFactor ()
 Set/Get the factor that controls the overall size of the fonts used to label the leader. More...
 
virtual void SetArrowPlacement (int)
 Control whether arrow heads are drawn on the leader. More...
 
virtual int GetArrowPlacement ()
 Control whether arrow heads are drawn on the leader. More...
 
void SetArrowPlacementToNone ()
 Control whether arrow heads are drawn on the leader. More...
 
void SetArrowPlacementToPoint1 ()
 Control whether arrow heads are drawn on the leader. More...
 
void SetArrowPlacementToPoint2 ()
 Control whether arrow heads are drawn on the leader. More...
 
void SetArrowPlacementToBoth ()
 Control whether arrow heads are drawn on the leader. More...
 
virtual void SetArrowStyle (int)
 Control the appearance of the arrow heads. More...
 
virtual int GetArrowStyle ()
 Control the appearance of the arrow heads. More...
 
void SetArrowStyleToFilled ()
 Control the appearance of the arrow heads. More...
 
void SetArrowStyleToOpen ()
 Control the appearance of the arrow heads. More...
 
void SetArrowStyleToHollow ()
 Control the appearance of the arrow heads. More...
 
virtual void SetArrowLength (double)
 Specify the arrow length and base width (in normalized viewport coordinates). More...
 
virtual double GetArrowLength ()
 Specify the arrow length and base width (in normalized viewport coordinates). More...
 
virtual void SetArrowWidth (double)
 Specify the arrow length and base width (in normalized viewport coordinates). More...
 
virtual double GetArrowWidth ()
 Specify the arrow length and base width (in normalized viewport coordinates). More...
 
virtual void SetMinimumArrowSize (double)
 Limit the minimum and maximum size of the arrows. More...
 
virtual double GetMinimumArrowSize ()
 Limit the minimum and maximum size of the arrows. More...
 
virtual void SetMaximumArrowSize (double)
 Limit the minimum and maximum size of the arrows. More...
 
virtual double GetMaximumArrowSize ()
 Limit the minimum and maximum size of the arrows. More...
 
virtual void SetAutoLabel (vtkTypeBool)
 Enable auto-labelling. More...
 
virtual vtkTypeBool GetAutoLabel ()
 Enable auto-labelling. More...
 
virtual void AutoLabelOn ()
 Enable auto-labelling. More...
 
virtual void AutoLabelOff ()
 Enable auto-labelling. More...
 
virtual void SetLabelFormat (const char *)
 Specify the format to use for auto-labelling. More...
 
virtual char * GetLabelFormat ()
 Specify the format to use for auto-labelling. More...
 
virtual double GetLength ()
 Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes. More...
 
virtual double GetAngle ()
 Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes. More...
 
int RenderOverlay (vtkViewport *viewport) override
 Methods required by vtkProp and vtkActor2D superclasses. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Methods required by vtkProp and vtkActor2D superclasses. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 Methods required by vtkProp and vtkActor2D superclasses. 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
 
vtkTypeBool 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 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. 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 ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool 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...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- 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 ()
 
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. 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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkLeaderActor2DSafeDownCast (vtkObjectBase *o)
 
static vtkLeaderActor2DNew ()
 Instantiate object. More...
 
- Static Public Member Functions inherited from vtkActor2D
static vtkTypeBool 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 vtkTypeBool 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
 
 vtkLeaderActor2D ()
 
 ~vtkLeaderActor2D () override
 
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 () 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=nullptr)
 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

double Radius
 
double Length
 
double Angle
 
vtkTypeBool AutoLabel
 
char * LabelFormat
 
char * Label
 
double LabelFactor
 
vtkTextMapperLabelMapper
 
vtkActor2DLabelActor
 
vtkTextPropertyLabelTextProperty
 
int ArrowPlacement
 
int ArrowStyle
 
double ArrowLength
 
double ArrowWidth
 
double MinimumArrowSize
 
double MaximumArrowSize
 
vtkPointsLeaderPoints
 
vtkCellArrayLeaderLines
 
vtkCellArrayLeaderArrows
 
vtkPolyDataLeader
 
vtkPolyDataMapper2DLeaderMapper
 
vtkActor2DLeaderActor
 
int LastPosition [2]
 
int LastPosition2 [2]
 
int LastSize [2]
 
vtkTimeStamp BuildTime
 
- Protected Attributes inherited from vtkActor2D
vtkMapper2DMapper
 
int LayerNumber
 
vtkProperty2DProperty
 
vtkCoordinatePositionCoordinate
 
vtkCoordinatePosition2Coordinate
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- 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 59 of file vtkLeaderActor2D.h.

Member Typedef Documentation

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

anonymous enum
Enumerator
VTK_ARROW_FILLED 
VTK_ARROW_OPEN 
VTK_ARROW_HOLLOW 

Definition at line 116 of file vtkLeaderActor2D.h.

Constructor & Destructor Documentation

vtkLeaderActor2D::vtkLeaderActor2D ( )
protected
vtkLeaderActor2D::~vtkLeaderActor2D ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkLeaderActor2D::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool 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 
)
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 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

Control whether arrow heads are drawn on the leader.

Arrows may be drawn on one end, both ends, or not at all.

virtual int vtkLeaderActor2D::GetArrowPlacement ( )
virtual

Control whether arrow heads are drawn on the leader.

Arrows may be drawn on one end, both ends, or not at all.

void vtkLeaderActor2D::SetArrowPlacementToNone ( )
inline

Control whether arrow heads are drawn on the leader.

Arrows may be drawn on one end, both ends, or not at all.

Definition at line 125 of file vtkLeaderActor2D.h.

void vtkLeaderActor2D::SetArrowPlacementToPoint1 ( )
inline

Control whether arrow heads are drawn on the leader.

Arrows may be drawn on one end, both ends, or not at all.

Definition at line 126 of file vtkLeaderActor2D.h.

void vtkLeaderActor2D::SetArrowPlacementToPoint2 ( )
inline

Control whether arrow heads are drawn on the leader.

Arrows may be drawn on one end, both ends, or not at all.

Definition at line 127 of file vtkLeaderActor2D.h.

void vtkLeaderActor2D::SetArrowPlacementToBoth ( )
inline

Control whether arrow heads are drawn on the leader.

Arrows may be drawn on one end, both ends, or not at all.

Definition at line 128 of file vtkLeaderActor2D.h.

virtual void vtkLeaderActor2D::SetArrowStyle ( int  )
virtual

Control the appearance of the arrow heads.

A solid arrow head is a filled triangle; a open arrow looks like a "V"; and a hollow arrow looks like a non-filled triangle.

virtual int vtkLeaderActor2D::GetArrowStyle ( )
virtual

Control the appearance of the arrow heads.

A solid arrow head is a filled triangle; a open arrow looks like a "V"; and a hollow arrow looks like a non-filled triangle.

void vtkLeaderActor2D::SetArrowStyleToFilled ( )
inline

Control the appearance of the arrow heads.

A solid arrow head is a filled triangle; a open arrow looks like a "V"; and a hollow arrow looks like a non-filled triangle.

Definition at line 139 of file vtkLeaderActor2D.h.

void vtkLeaderActor2D::SetArrowStyleToOpen ( )
inline

Control the appearance of the arrow heads.

A solid arrow head is a filled triangle; a open arrow looks like a "V"; and a hollow arrow looks like a non-filled triangle.

Definition at line 140 of file vtkLeaderActor2D.h.

void vtkLeaderActor2D::SetArrowStyleToHollow ( )
inline

Control the appearance of the arrow heads.

A solid arrow head is a filled triangle; a open arrow looks like a "V"; and a hollow arrow looks like a non-filled triangle.

Definition at line 141 of file vtkLeaderActor2D.h.

virtual void vtkLeaderActor2D::SetArrowLength ( double  )
virtual

Specify the arrow length and base width (in normalized viewport coordinates).

virtual double vtkLeaderActor2D::GetArrowLength ( )
virtual

Specify the arrow length and base width (in normalized viewport coordinates).

virtual void vtkLeaderActor2D::SetArrowWidth ( double  )
virtual

Specify the arrow length and base width (in normalized viewport coordinates).

virtual double vtkLeaderActor2D::GetArrowWidth ( )
virtual

Specify the arrow length and base width (in normalized viewport coordinates).

virtual void vtkLeaderActor2D::SetMinimumArrowSize ( double  )
virtual

Limit the minimum and maximum size of the arrows.

These values are expressed in pixels and clamp the minimum/maximum possible size for the width/length of the arrow head. (When clamped, the ratio between length and width is preserved.)

virtual double vtkLeaderActor2D::GetMinimumArrowSize ( )
virtual

Limit the minimum and maximum size of the arrows.

These values are expressed in pixels and clamp the minimum/maximum possible size for the width/length of the arrow head. (When clamped, the ratio between length and width is preserved.)

virtual void vtkLeaderActor2D::SetMaximumArrowSize ( double  )
virtual

Limit the minimum and maximum size of the arrows.

These values are expressed in pixels and clamp the minimum/maximum possible size for the width/length of the arrow head. (When clamped, the ratio between length and width is preserved.)

virtual double vtkLeaderActor2D::GetMaximumArrowSize ( )
virtual

Limit the minimum and maximum size of the arrows.

These values are expressed in pixels and clamp the minimum/maximum possible size for the width/length of the arrow head. (When clamped, the ratio between length and width is preserved.)

virtual void vtkLeaderActor2D::SetAutoLabel ( vtkTypeBool  )
virtual

Enable auto-labelling.

In this mode, the label is automatically updated based on distance (in world coordinates) between the two end points; or if a curved leader is being generated, the angle in degrees between the two points.

virtual vtkTypeBool vtkLeaderActor2D::GetAutoLabel ( )
virtual

Enable auto-labelling.

In this mode, the label is automatically updated based on distance (in world coordinates) between the two end points; or if a curved leader is being generated, the angle in degrees between the two points.

virtual void vtkLeaderActor2D::AutoLabelOn ( )
virtual

Enable auto-labelling.

In this mode, the label is automatically updated based on distance (in world coordinates) between the two end points; or if a curved leader is being generated, the angle in degrees between the two points.

virtual void vtkLeaderActor2D::AutoLabelOff ( )
virtual

Enable auto-labelling.

In this mode, the label is automatically updated based on distance (in world coordinates) between the two end points; or if a curved leader is being generated, the angle in degrees between the two points.

virtual void vtkLeaderActor2D::SetLabelFormat ( const char *  )
virtual

Specify the format to use for auto-labelling.

virtual char* vtkLeaderActor2D::GetLabelFormat ( )
virtual

Specify the format to use for auto-labelling.

virtual double vtkLeaderActor2D::GetLength ( )
virtual

Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes.

virtual double vtkLeaderActor2D::GetAngle ( )
virtual

Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes.

int vtkLeaderActor2D::RenderOverlay ( vtkViewport viewport)
overridevirtual

Methods required by vtkProp and vtkActor2D superclasses.

Reimplemented from vtkProp.

int vtkLeaderActor2D::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Methods required by vtkProp and vtkActor2D superclasses.

Reimplemented from vtkProp.

int vtkLeaderActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport )
inlineoverridevirtual

Methods required by vtkProp and vtkActor2D superclasses.

Reimplemented from vtkProp.

Definition at line 203 of file vtkLeaderActor2D.h.

vtkTypeBool vtkLeaderActor2D::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

void vtkLeaderActor2D::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE 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.

void vtkLeaderActor2D::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this vtkProp.

Reimplemented from vtkProp.

virtual void vtkLeaderActor2D::BuildLeader ( vtkViewport viewport)
protectedvirtual
int vtkLeaderActor2D::SetFontSize ( vtkViewport viewport,
vtkTextMapper textMapper,
int targetSize,
double  factor,
int stringSize 
)
protected
int vtkLeaderActor2D::ClipLeader ( double  xL[3],
int  stringSize[2],
double  p1[3],
double  ray[3],
double  c1[3],
double  c2[3] 
)
protected
void vtkLeaderActor2D::BuildCurvedLeader ( double  p1[3],
double  p2[3],
double  ray[3],
double  rayLength,
double  theta,
vtkViewport viewport,
int  viewportChanged 
)
protected
int vtkLeaderActor2D::InStringBox ( double  center[3],
int  stringSize[2],
double  x[3] 
)
protected

Member Data Documentation

double vtkLeaderActor2D::Radius
protected

Definition at line 230 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::Length
protected

Definition at line 231 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::Angle
protected

Definition at line 232 of file vtkLeaderActor2D.h.

vtkTypeBool vtkLeaderActor2D::AutoLabel
protected

Definition at line 234 of file vtkLeaderActor2D.h.

char* vtkLeaderActor2D::LabelFormat
protected

Definition at line 235 of file vtkLeaderActor2D.h.

char* vtkLeaderActor2D::Label
protected

Definition at line 236 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::LabelFactor
protected

Definition at line 237 of file vtkLeaderActor2D.h.

vtkTextMapper* vtkLeaderActor2D::LabelMapper
protected

Definition at line 238 of file vtkLeaderActor2D.h.

vtkActor2D* vtkLeaderActor2D::LabelActor
protected

Definition at line 239 of file vtkLeaderActor2D.h.

vtkTextProperty* vtkLeaderActor2D::LabelTextProperty
protected

Definition at line 240 of file vtkLeaderActor2D.h.

int vtkLeaderActor2D::ArrowPlacement
protected

Definition at line 242 of file vtkLeaderActor2D.h.

int vtkLeaderActor2D::ArrowStyle
protected

Definition at line 243 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::ArrowLength
protected

Definition at line 244 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::ArrowWidth
protected

Definition at line 245 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::MinimumArrowSize
protected

Definition at line 246 of file vtkLeaderActor2D.h.

double vtkLeaderActor2D::MaximumArrowSize
protected

Definition at line 247 of file vtkLeaderActor2D.h.

vtkPoints* vtkLeaderActor2D::LeaderPoints
protected

Definition at line 249 of file vtkLeaderActor2D.h.

vtkCellArray* vtkLeaderActor2D::LeaderLines
protected

Definition at line 250 of file vtkLeaderActor2D.h.

vtkCellArray* vtkLeaderActor2D::LeaderArrows
protected

Definition at line 251 of file vtkLeaderActor2D.h.

vtkPolyData* vtkLeaderActor2D::Leader
protected

Definition at line 252 of file vtkLeaderActor2D.h.

vtkPolyDataMapper2D* vtkLeaderActor2D::LeaderMapper
protected

Definition at line 253 of file vtkLeaderActor2D.h.

vtkActor2D* vtkLeaderActor2D::LeaderActor
protected

Definition at line 254 of file vtkLeaderActor2D.h.

int vtkLeaderActor2D::LastPosition[2]
protected

Definition at line 257 of file vtkLeaderActor2D.h.

int vtkLeaderActor2D::LastPosition2[2]
protected

Definition at line 258 of file vtkLeaderActor2D.h.

int vtkLeaderActor2D::LastSize[2]
protected

Definition at line 259 of file vtkLeaderActor2D.h.

vtkTimeStamp vtkLeaderActor2D::BuildTime
protected

Definition at line 260 of file vtkLeaderActor2D.h.


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