VTK
9.2.6
|
create a leader with optional label and arrows More...
#include <vtkLeaderActor2D.h>
Public Types | |
enum | { VTK_ARROW_NONE = 0 , VTK_ARROW_POINT1 , VTK_ARROW_POINT2 , VTK_ARROW_BOTH } |
enum | { VTK_ARROW_FILLED = 0 , VTK_ARROW_OPEN , VTK_ARROW_HOLLOW } |
typedef vtkActor2D | Superclass |
Public 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. | |
vtkLeaderActor2D * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
vtkTypeBool | HasTranslucentPolygonalGeometry () override |
Does this prop have some translucent polygonal geometry? | |
void | ReleaseGraphicsResources (vtkWindow *) override |
Release any graphics resources that are being consumed by this actor. | |
void | ShallowCopy (vtkProp *prop) override |
Shallow copy of this vtkActor2D. | |
virtual void | SetRadius (double) |
Set/Get a radius which can be used to curve the leader. | |
virtual double | GetRadius () |
Set/Get a radius which can be used to curve the leader. | |
virtual void | SetLabel (const char *) |
Set/Get the label for the leader. | |
virtual char * | GetLabel () |
Set/Get the label for the leader. | |
virtual void | SetLabelTextProperty (vtkTextProperty *p) |
Set/Get the text property of the label. | |
virtual vtkTextProperty * | GetLabelTextProperty () |
Set/Get the text property of the label. | |
virtual void | SetLabelFactor (double) |
Set/Get the factor that controls the overall size of the fonts used to label the leader. | |
virtual double | GetLabelFactor () |
Set/Get the factor that controls the overall size of the fonts used to label the leader. | |
virtual void | SetArrowPlacement (int) |
Control whether arrow heads are drawn on the leader. | |
virtual int | GetArrowPlacement () |
Control whether arrow heads are drawn on the leader. | |
void | SetArrowPlacementToNone () |
Control whether arrow heads are drawn on the leader. | |
void | SetArrowPlacementToPoint1 () |
Control whether arrow heads are drawn on the leader. | |
void | SetArrowPlacementToPoint2 () |
Control whether arrow heads are drawn on the leader. | |
void | SetArrowPlacementToBoth () |
Control whether arrow heads are drawn on the leader. | |
virtual void | SetArrowStyle (int) |
Control the appearance of the arrow heads. | |
virtual int | GetArrowStyle () |
Control the appearance of the arrow heads. | |
void | SetArrowStyleToFilled () |
Control the appearance of the arrow heads. | |
void | SetArrowStyleToOpen () |
Control the appearance of the arrow heads. | |
void | SetArrowStyleToHollow () |
Control the appearance of the arrow heads. | |
virtual void | SetArrowLength (double) |
Specify the arrow length and base width (in normalized viewport coordinates). | |
virtual double | GetArrowLength () |
Specify the arrow length and base width (in normalized viewport coordinates). | |
virtual void | SetArrowWidth (double) |
Specify the arrow length and base width (in normalized viewport coordinates). | |
virtual double | GetArrowWidth () |
Specify the arrow length and base width (in normalized viewport coordinates). | |
virtual void | SetMinimumArrowSize (double) |
Limit the minimum and maximum size of the arrows. | |
virtual double | GetMinimumArrowSize () |
Limit the minimum and maximum size of the arrows. | |
virtual void | SetMaximumArrowSize (double) |
Limit the minimum and maximum size of the arrows. | |
virtual double | GetMaximumArrowSize () |
Limit the minimum and maximum size of the arrows. | |
virtual void | SetAutoLabel (vtkTypeBool) |
Enable auto-labelling. | |
virtual vtkTypeBool | GetAutoLabel () |
Enable auto-labelling. | |
virtual void | AutoLabelOn () |
Enable auto-labelling. | |
virtual void | AutoLabelOff () |
Enable auto-labelling. | |
virtual void | SetLabelFormat (const char *) |
Specify the format to use for auto-labelling. | |
virtual char * | GetLabelFormat () |
Specify the format to use for auto-labelling. | |
virtual double | GetLength () |
Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes. | |
virtual double | GetAngle () |
Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes. | |
int | RenderOverlay (vtkViewport *viewport) override |
Methods required by vtkProp and vtkActor2D superclasses. | |
int | RenderOpaqueGeometry (vtkViewport *viewport) override |
Methods required by vtkProp and vtkActor2D superclasses. | |
int | RenderTranslucentPolygonalGeometry (vtkViewport *) override |
Methods required by vtkProp and vtkActor2D superclasses. | |
virtual void | SetUseFontSizeFromProperty (vtkTypeBool) |
By default the LeaderActor2D controls the font size of the label. | |
virtual vtkTypeBool | GetUseFontSizeFromProperty () |
By default the LeaderActor2D controls the font size of the label. | |
virtual void | UseFontSizeFromPropertyOn () |
By default the LeaderActor2D controls the font size of the label. | |
virtual void | UseFontSizeFromPropertyOff () |
By default the LeaderActor2D controls the font size of the label. | |
Public Member Functions inherited from vtkActor2D | |
vtkActor2D * | NewInstance () const |
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. | |
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. | |
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 | |
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 | 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 | 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 | RenderVolumetricGeometry (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 | 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? | |
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. | |
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) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
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. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
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. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkLeaderActor2D * | SafeDownCast (vtkObjectBase *o) |
static vtkLeaderActor2D * | New () |
Instantiate object. | |
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 |
vtkLeaderActor2D () | |
~vtkLeaderActor2D () override | |
virtual void | BuildLeader (vtkViewport *viewport) |
int | SetFontSize (vtkViewport *viewport, vtkTextMapper *textMapper, const 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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 59 of file vtkLeaderActor2D.h.
Definition at line 62 of file vtkLeaderActor2D.h.
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 122 of file vtkLeaderActor2D.h.
|
protected |
|
overrideprotected |
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkActor2D.
vtkLeaderActor2D * vtkLeaderActor2D::NewInstance | ( | ) | const |
|
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 vtkActor2D.
|
static |
Instantiate object.
|
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 |
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 |
Set/Get the label for the leader.
If the label is an empty string, then it will not be drawn.
|
virtual |
Set/Get the label for the leader.
If the label is an empty string, then it will not be drawn.
|
virtual |
Set/Get the text property of the label.
|
virtual |
Set/Get the text property of the label.
|
virtual |
Set/Get the factor that controls the overall size of the fonts used to label the leader.
|
virtual |
Set/Get the factor that controls the overall size of the fonts used to label the leader.
|
virtual |
Control whether arrow heads are drawn on the leader.
Arrows may be drawn on one end, both ends, or not at all.
|
virtual |
Control whether arrow heads are drawn on the leader.
Arrows may be drawn on one end, both ends, or not at all.
|
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 136 of file vtkLeaderActor2D.h.
|
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 137 of file vtkLeaderActor2D.h.
|
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 138 of file vtkLeaderActor2D.h.
|
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 139 of file vtkLeaderActor2D.h.
|
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 |
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.
|
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 150 of file vtkLeaderActor2D.h.
|
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 151 of file vtkLeaderActor2D.h.
|
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 152 of file vtkLeaderActor2D.h.
|
virtual |
Specify the arrow length and base width (in normalized viewport coordinates).
|
virtual |
Specify the arrow length and base width (in normalized viewport coordinates).
|
virtual |
Specify the arrow length and base width (in normalized viewport coordinates).
|
virtual |
Specify the arrow length and base width (in normalized viewport coordinates).
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Specify the format to use for auto-labelling.
|
virtual |
Specify the format to use for auto-labelling.
|
virtual |
Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes.
|
virtual |
Obtain the length of the leader if the leader is not curved, otherwise obtain the angle that the leader circumscribes.
|
overridevirtual |
Methods required by vtkProp and vtkActor2D superclasses.
Reimplemented from vtkActor2D.
|
overridevirtual |
Methods required by vtkProp and vtkActor2D superclasses.
Reimplemented from vtkActor2D.
|
inlineoverridevirtual |
Methods required by vtkProp and vtkActor2D superclasses.
Reimplemented from vtkActor2D.
Definition at line 214 of file vtkLeaderActor2D.h.
|
overridevirtual |
Does this prop have some translucent polygonal geometry?
Reimplemented from vtkActor2D.
|
overridevirtual |
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 vtkActor2D.
|
overridevirtual |
Shallow copy of this vtkActor2D.
Overloads the virtual vtkProp method.
Reimplemented from vtkActor2D.
|
virtual |
By default the LeaderActor2D controls the font size of the label.
If this option is set to true, it will instead use whatever font size is set in the vtkTextProperty, allowing external control of the font size.
|
virtual |
By default the LeaderActor2D controls the font size of the label.
If this option is set to true, it will instead use whatever font size is set in the vtkTextProperty, allowing external control of the font size.
|
virtual |
By default the LeaderActor2D controls the font size of the label.
If this option is set to true, it will instead use whatever font size is set in the vtkTextProperty, allowing external control of the font size.
|
virtual |
By default the LeaderActor2D controls the font size of the label.
If this option is set to true, it will instead use whatever font size is set in the vtkTextProperty, allowing external control of the font size.
|
protectedvirtual |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 251 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 252 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 253 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 255 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 256 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 257 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 258 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 259 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 260 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 261 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 263 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 265 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 266 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 267 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 268 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 269 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 270 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 272 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 273 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 274 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 275 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 276 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 277 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 280 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 281 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 282 of file vtkLeaderActor2D.h.
|
protected |
Definition at line 283 of file vtkLeaderActor2D.h.