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

Create an axis with tick marks and labels. More...

#include <vtkAxisActor2D.h>

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

Public Types

enum  LabelMax { VTK_MAX_LABELS = 25 }
 
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.
 
vtkAxisActor2DNewInstance () 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 an axis actor.
 
virtual vtkCoordinateGetPoint1Coordinate ()
 Specify the position of the first point defining the axis.
 
virtual void SetPoint1 (double x[2])
 Specify the position of the first point defining the axis.
 
virtual void SetPoint1 (double x, double y)
 Specify the position of the first point defining the axis.
 
virtual double * GetPoint1 ()
 Specify the position of the first point defining the axis.
 
virtual vtkCoordinateGetPoint2Coordinate ()
 Specify the position of the second point defining the axis.
 
virtual void SetPoint2 (double x[2])
 Specify the position of the second point defining the axis.
 
virtual void SetPoint2 (double x, double y)
 Specify the position of the second point defining the axis.
 
virtual double * GetPoint2 ()
 Specify the position of the second point defining the axis.
 
virtual void SetRange (double, double)
 Specify the (min,max) axis range.
 
void SetRange (double[2])
 Specify the (min,max) axis range.
 
virtual double * GetRange ()
 Specify the (min,max) axis range.
 
virtual void GetRange (double data[2])
 Specify the (min,max) axis range.
 
virtual void SetRulerMode (vtkTypeBool)
 Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.
 
virtual vtkTypeBool GetRulerMode ()
 Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.
 
virtual void RulerModeOn ()
 Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.
 
virtual void RulerModeOff ()
 Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.
 
virtual void SetRulerDistance (double)
 Specify the RulerDistance which indicates the spacing of the major ticks.
 
virtual double GetRulerDistance ()
 Specify the RulerDistance which indicates the spacing of the major ticks.
 
virtual void SetNumberOfLabels (int)
 Set/Get the number of annotation labels to show.
 
virtual int GetNumberOfLabels ()
 Set/Get the number of annotation labels to show.
 
virtual void SetLabelFormat (const char *)
 Set/Get the format with which to print the labels on the scalar bar.
 
virtual char * GetLabelFormat ()
 Set/Get the format with which to print the labels on the scalar bar.
 
virtual void SetAdjustLabels (vtkTypeBool)
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual vtkTypeBool GetAdjustLabels ()
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual void AdjustLabelsOn ()
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual void AdjustLabelsOff ()
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual double * GetAdjustedRange ()
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual void GetAdjustedRange (double &_arg1, double &_arg2)
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual void GetAdjustedRange (double _arg[2])
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual int GetAdjustedNumberOfLabels ()
 Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.
 
virtual void SetTitle (const char *)
 Set/Get the title of the scalar bar actor,.
 
virtual char * GetTitle ()
 Set/Get the title of the scalar bar actor,.
 
virtual void SetTitleTextProperty (vtkTextProperty *p)
 Set/Get the title text property.
 
virtual vtkTextPropertyGetTitleTextProperty ()
 Set/Get the title text property.
 
virtual void SetLabelTextProperty (vtkTextProperty *p)
 Set/Get the labels text property.
 
virtual vtkTextPropertyGetLabelTextProperty ()
 Set/Get the labels text property.
 
virtual void SetTickLength (int)
 Set/Get the length of the tick marks (expressed in pixels or display coordinates).
 
virtual int GetTickLength ()
 Set/Get the length of the tick marks (expressed in pixels or display coordinates).
 
virtual void SetNumberOfMinorTicks (int)
 Number of minor ticks to be displayed between each tick.
 
virtual int GetNumberOfMinorTicks ()
 Number of minor ticks to be displayed between each tick.
 
virtual void SetMinorTickLength (int)
 Set/Get the length of the minor tick marks (expressed in pixels or display coordinates).
 
virtual int GetMinorTickLength ()
 Set/Get the length of the minor tick marks (expressed in pixels or display coordinates).
 
virtual void SetTickOffset (int)
 Set/Get the offset of the labels (expressed in pixels or display coordinates).
 
virtual int GetTickOffset ()
 Set/Get the offset of the labels (expressed in pixels or display coordinates).
 
virtual void SetAxisVisibility (vtkTypeBool)
 Set/Get visibility of the axis line.
 
virtual vtkTypeBool GetAxisVisibility ()
 Set/Get visibility of the axis line.
 
virtual void AxisVisibilityOn ()
 Set/Get visibility of the axis line.
 
virtual void AxisVisibilityOff ()
 Set/Get visibility of the axis line.
 
virtual void SetTickVisibility (vtkTypeBool)
 Set/Get visibility of the axis tick marks.
 
virtual vtkTypeBool GetTickVisibility ()
 Set/Get visibility of the axis tick marks.
 
virtual void TickVisibilityOn ()
 Set/Get visibility of the axis tick marks.
 
virtual void TickVisibilityOff ()
 Set/Get visibility of the axis tick marks.
 
virtual void SetLabelVisibility (vtkTypeBool)
 Set/Get visibility of the axis labels.
 
virtual vtkTypeBool GetLabelVisibility ()
 Set/Get visibility of the axis labels.
 
virtual void LabelVisibilityOn ()
 Set/Get visibility of the axis labels.
 
virtual void LabelVisibilityOff ()
 Set/Get visibility of the axis labels.
 
virtual void SetTitleVisibility (vtkTypeBool)
 Set/Get visibility of the axis title.
 
virtual vtkTypeBool GetTitleVisibility ()
 Set/Get visibility of the axis title.
 
virtual void TitleVisibilityOn ()
 Set/Get visibility of the axis title.
 
virtual void TitleVisibilityOff ()
 Set/Get visibility of the axis title.
 
virtual void SetTitlePosition (double)
 Set/Get position of the axis title.
 
virtual double GetTitlePosition ()
 Set/Get position of the axis title.
 
virtual void SetFontFactor (double)
 Set/Get the factor that controls the overall size of the fonts used to label and title the axes.
 
virtual double GetFontFactor ()
 Set/Get the factor that controls the overall size of the fonts used to label and title the axes.
 
virtual void SetLabelFactor (double)
 Set/Get the factor that controls the relative size of the axis labels to the axis title.
 
virtual double GetLabelFactor ()
 Set/Get the factor that controls the relative size of the axis labels to the axis title.
 
int RenderOverlay (vtkViewport *viewport) override
 Draw the axis.
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Draw the axis.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 Draw the axis.
 
virtual void SetSizeFontRelativeToAxis (vtkTypeBool)
 Specify whether to size the fonts relative to the viewport or relative to length of the axis.
 
virtual vtkTypeBool GetSizeFontRelativeToAxis ()
 Specify whether to size the fonts relative to the viewport or relative to length of the axis.
 
virtual void SizeFontRelativeToAxisOn ()
 Specify whether to size the fonts relative to the viewport or relative to length of the axis.
 
virtual void SizeFontRelativeToAxisOff ()
 Specify whether to size the fonts relative to the viewport or relative to length of the axis.
 
virtual void SetUseFontSizeFromProperty (vtkTypeBool)
 By default the AxisActor controls the font size of the axis label.
 
virtual vtkTypeBool GetUseFontSizeFromProperty ()
 By default the AxisActor controls the font size of the axis label.
 
virtual void UseFontSizeFromPropertyOn ()
 By default the AxisActor controls the font size of the axis label.
 
virtual void UseFontSizeFromPropertyOff ()
 By default the AxisActor controls the font size of the axis label.
 
- Public Member Functions inherited from vtkActor2D
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkActor2DNewInstance () const
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry?
 
vtkProperty2DGetProperty ()
 Returns this actor's vtkProperty2D.
 
virtual void SetProperty (vtkProperty2D *)
 Set this vtkProp's vtkProperty2D.
 
void SetDisplayPosition (int, int)
 Set the Prop2D's position in display coordinates.
 
vtkMTimeType GetMTime () override
 Return this objects MTime.
 
void GetActors2D (vtkPropCollection *pc) override
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkActor2D.
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor.
 
virtual vtkCoordinateGetActualPositionCoordinate (void)
 Return the actual vtkCoordinate reference that the mapper should use to position the actor.
 
virtual vtkCoordinateGetActualPosition2Coordinate (void)
 Return the actual vtkCoordinate reference that the mapper should use to position the actor.
 
int RenderOverlay (vtkViewport *viewport) override
 Support the standard render methods.
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Support the standard render methods.
 
virtual void SetMapper (vtkMapper2D *mapper)
 Set/Get the vtkMapper2D which defines the data to be drawn.
 
virtual vtkMapper2DGetMapper ()
 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 vtkCoordinateGetPositionCoordinate ()
 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 vtkCoordinateGetPosition2Coordinate ()
 Access the Position2 instance variable.
 
virtual void SetPosition2 (float x[2])
 Access the Position2 instance variable.
 
virtual void SetPosition2 (float x, float y)
 Access the Position2 instance variable.
 
virtual float * GetPosition2 ()
 Access the Position2 instance variable.
 
void SetWidth (double w)
 Set/Get the height and width of the Actor2D.
 
double GetWidth ()
 Set/Get the height and width of the Actor2D.
 
void SetHeight (double h)
 Set/Get the height and width of the Actor2D.
 
double GetHeight ()
 Set/Get the height and width of the Actor2D.
 
- Public Member Functions inherited from vtkProp
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked.
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently.
 
virtual double * GetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
 
virtual void ShallowCopy (vtkProp *prop)
 Shallow copy of this vtkProp.
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys.
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys.
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail.
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value.
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved.
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this.
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time.
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal.
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp.
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp.
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable.
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable.
 
virtual void PickableOn ()
 Set/Get the pickable instance variable.
 
virtual void PickableOff ()
 Set/Get the pickable instance variable.
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable.
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable.
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera().
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkAssemblyPathGetNextPath ()
 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 vtkInformationGetPropertyKeys ()
 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,.
 
vtkObjectGetConsumer (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 vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property.
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAxisActor2DSafeDownCast (vtkObjectBase *o)
 
static vtkAxisActor2DNew ()
 Instantiate object.
 
static void ComputeRange (double inRange[2], double outRange[2], int inNumTicks, int &outNumTicks, double &interval)
 This method computes the range of the axis given an input range.
 
static int SetMultipleFontSize (vtkViewport *viewport, vtkTextMapper **textMappers, int nbOfMappers, int *targetSize, double factor, int *stringSize)
 General method to computes font size from a representative size on the viewport (given by size[2]).
 
- 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.
 
- 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.
 
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.
 
- 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkAxisActor2D ()
 
 ~vtkAxisActor2D () override
 
virtual void BuildAxis (vtkViewport *viewport)
 
virtual void UpdateAdjustedRange ()
 
- Protected Member Functions inherited from vtkActor2D
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkActor2D ()
 
 ~vtkActor2D () override
 
- Protected Member Functions inherited from vtkProp
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static double ComputeStringOffset (double width, double height, double theta)
 
static void SetOffsetPosition (double xTick[3], double theta, int stringWidth, int stringHeight, int offset, vtkActor2D *actor)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

vtkTextPropertyTitleTextProperty
 
vtkTextPropertyLabelTextProperty
 
char * Title
 
double Range [2]
 
double TitlePosition
 
vtkTypeBool RulerMode
 
double RulerDistance
 
int NumberOfLabels
 
char * LabelFormat
 
vtkTypeBool AdjustLabels
 
double FontFactor
 
double LabelFactor
 
int TickLength
 
int MinorTickLength
 
int TickOffset
 
int NumberOfMinorTicks
 
double AdjustedRange [2]
 
int AdjustedNumberOfLabels
 
int NumberOfLabelsBuilt
 
vtkTypeBool AxisVisibility
 
vtkTypeBool TickVisibility
 
vtkTypeBool LabelVisibility
 
vtkTypeBool TitleVisibility
 
int LastPosition [2]
 
int LastPosition2 [2]
 
int LastSize [2]
 
int LastMaxLabelSize [2]
 
int SizeFontRelativeToAxis
 
vtkTypeBool UseFontSizeFromProperty
 
vtkTextMapperTitleMapper
 
vtkActor2DTitleActor
 
vtkTextMapper ** LabelMappers
 
vtkActor2D ** LabelActors
 
vtkPolyDataAxis
 
vtkPolyDataMapper2DAxisMapper
 
vtkActor2DAxisActor
 
vtkTimeStamp AdjustedRangeBuildTime
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Create an axis with tick marks and labels.

vtkAxisActor2D creates an axis with tick marks, labels, and/or a title, depending on the particular instance variable settings. vtkAxisActor2D is a 2D actor; 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), the number of labels, and the data range (min,max). You can also control what parts of the axis are visible including the line, the tick marks, the labels, and the title. You can also specify the label format (a printf style format).

This class decides what font size to use and how to locate the labels. It also decides how to create reasonable tick marks and labels. The number of labels and the range of values may not match the number specified, but should be close.

Labels are drawn on the "right" side of the axis. The "right" side is the side of the axis on the right as you move from Position to Position2. The way the labels and title line up with the axis and tick marks depends on whether the line is considered horizontal or vertical.

The vtkActor2D instance variables Position and Position2 are instances of vtkCoordinate. Note that the Position2 is an absolute position in that class (it was by default relative to Position in vtkActor2D).

What this means is that you can specify the axis in a variety of coordinate systems. Also, the axis does not have to be either horizontal or vertical. The tick marks are created so that they are perpendicular to the axis.

Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated to this actor.

See also
vtkCubeAxesActor2D can be used to create axes in world coordinate space.
vtkActor2D vtkTextMapper vtkPolyDataMapper2D vtkScalarBarActor vtkCoordinate vtkTextProperty

Definition at line 69 of file vtkAxisActor2D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 72 of file vtkAxisActor2D.h.

Member Enumeration Documentation

◆ LabelMax

Enumerator
VTK_MAX_LABELS 

Definition at line 133 of file vtkAxisActor2D.h.

Constructor & Destructor Documentation

◆ vtkAxisActor2D()

vtkAxisActor2D::vtkAxisActor2D ( )
protected

◆ ~vtkAxisActor2D()

vtkAxisActor2D::~vtkAxisActor2D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAxisActor2D::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAxisActor2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkActor2D.

◆ NewInstance()

vtkAxisActor2D * vtkAxisActor2D::NewInstance ( ) const

◆ PrintSelf()

void vtkAxisActor2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ New()

static vtkAxisActor2D * vtkAxisActor2D::New ( )
static

Instantiate object.

◆ GetPoint1Coordinate()

virtual vtkCoordinate * vtkAxisActor2D::GetPoint1Coordinate ( )
inlinevirtual

Specify the position of the first point defining the axis.

Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 85 of file vtkAxisActor2D.h.

◆ SetPoint1() [1/2]

virtual void vtkAxisActor2D::SetPoint1 ( double  x[2])
inlinevirtual

Specify the position of the first point defining the axis.

Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 86 of file vtkAxisActor2D.h.

◆ SetPoint1() [2/2]

virtual void vtkAxisActor2D::SetPoint1 ( double  x,
double  y 
)
inlinevirtual

Specify the position of the first point defining the axis.

Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 87 of file vtkAxisActor2D.h.

◆ GetPoint1()

virtual double * vtkAxisActor2D::GetPoint1 ( )
inlinevirtual

Specify the position of the first point defining the axis.

Note: backward compatibility only, use vtkActor2D's Position instead.

Definition at line 88 of file vtkAxisActor2D.h.

◆ GetPoint2Coordinate()

virtual vtkCoordinate * vtkAxisActor2D::GetPoint2Coordinate ( )
inlinevirtual

Specify the position of the second point defining the axis.

Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.

Definition at line 98 of file vtkAxisActor2D.h.

◆ SetPoint2() [1/2]

virtual void vtkAxisActor2D::SetPoint2 ( double  x[2])
inlinevirtual

Specify the position of the second point defining the axis.

Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.

Definition at line 99 of file vtkAxisActor2D.h.

◆ SetPoint2() [2/2]

virtual void vtkAxisActor2D::SetPoint2 ( double  x,
double  y 
)
inlinevirtual

Specify the position of the second point defining the axis.

Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.

Definition at line 100 of file vtkAxisActor2D.h.

◆ GetPoint2()

virtual double * vtkAxisActor2D::GetPoint2 ( )
inlinevirtual

Specify the position of the second point defining the axis.

Note that the order from Point1 to Point2 controls which side the tick marks are drawn on (ticks are drawn on the right, if visible). Note: backward compatibility only, use vtkActor2D's Position2 instead.

Definition at line 101 of file vtkAxisActor2D.h.

◆ SetRange() [1/2]

virtual void vtkAxisActor2D::SetRange ( double  ,
double   
)
virtual

Specify the (min,max) axis range.

This will be used in the generation of labels, if labels are visible.

◆ SetRange() [2/2]

void vtkAxisActor2D::SetRange ( double  [2])

Specify the (min,max) axis range.

This will be used in the generation of labels, if labels are visible.

◆ GetRange() [1/2]

virtual double * vtkAxisActor2D::GetRange ( )
virtual

Specify the (min,max) axis range.

This will be used in the generation of labels, if labels are visible.

◆ GetRange() [2/2]

virtual void vtkAxisActor2D::GetRange ( double  data[2])
virtual

Specify the (min,max) axis range.

This will be used in the generation of labels, if labels are visible.

◆ SetRulerMode()

virtual void vtkAxisActor2D::SetRulerMode ( vtkTypeBool  )
virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.

If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

◆ GetRulerMode()

virtual vtkTypeBool vtkAxisActor2D::GetRulerMode ( )
virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.

If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

◆ RulerModeOn()

virtual void vtkAxisActor2D::RulerModeOn ( )
virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.

If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

◆ RulerModeOff()

virtual void vtkAxisActor2D::RulerModeOff ( )
virtual

Specify whether this axis should act like a measuring tape (or ruler) with specified major tick spacing.

If enabled, the distance between major ticks is controlled by the RulerDistance ivar.

◆ SetRulerDistance()

virtual void vtkAxisActor2D::SetRulerDistance ( double  )
virtual

Specify the RulerDistance which indicates the spacing of the major ticks.

This ivar only has effect when the RulerMode is on.

◆ GetRulerDistance()

virtual double vtkAxisActor2D::GetRulerDistance ( )
virtual

Specify the RulerDistance which indicates the spacing of the major ticks.

This ivar only has effect when the RulerMode is on.

◆ SetNumberOfLabels()

virtual void vtkAxisActor2D::SetNumberOfLabels ( int  )
virtual

Set/Get the number of annotation labels to show.

This also controls the number of major ticks shown. Note that this ivar only holds meaning if the RulerMode is off.

◆ GetNumberOfLabels()

virtual int vtkAxisActor2D::GetNumberOfLabels ( )
virtual

Set/Get the number of annotation labels to show.

This also controls the number of major ticks shown. Note that this ivar only holds meaning if the RulerMode is off.

◆ SetLabelFormat()

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

Set/Get the format with which to print the labels on the scalar bar.

◆ GetLabelFormat()

virtual char * vtkAxisActor2D::GetLabelFormat ( )
virtual

Set/Get the format with which to print the labels on the scalar bar.

◆ SetAdjustLabels()

virtual void vtkAxisActor2D::SetAdjustLabels ( vtkTypeBool  )
virtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

◆ GetAdjustLabels()

virtual vtkTypeBool vtkAxisActor2D::GetAdjustLabels ( )
virtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

◆ AdjustLabelsOn()

virtual void vtkAxisActor2D::AdjustLabelsOn ( )
virtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

◆ AdjustLabelsOff()

virtual void vtkAxisActor2D::AdjustLabelsOff ( )
virtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

◆ GetAdjustedRange() [1/3]

virtual double * vtkAxisActor2D::GetAdjustedRange ( )
inlinevirtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 169 of file vtkAxisActor2D.h.

◆ GetAdjustedRange() [2/3]

virtual void vtkAxisActor2D::GetAdjustedRange ( double &  _arg1,
double &  _arg2 
)
inlinevirtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 174 of file vtkAxisActor2D.h.

◆ GetAdjustedRange() [3/3]

virtual void vtkAxisActor2D::GetAdjustedRange ( double  _arg[2])
inlinevirtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 180 of file vtkAxisActor2D.h.

◆ GetAdjustedNumberOfLabels()

virtual int vtkAxisActor2D::GetAdjustedNumberOfLabels ( )
inlinevirtual

Set/Get the flag that controls whether the labels and ticks are adjusted for "nice" numerical values to make it easier to read the labels.

The adjustment is based in the Range instance variable. Call GetAdjustedRange and GetAdjustedNumberOfLabels to get the adjusted range and number of labels. Note that if RulerMode is on, then the number of labels is a function of the range and ruler distance.

Definition at line 181 of file vtkAxisActor2D.h.

◆ SetTitle()

virtual void vtkAxisActor2D::SetTitle ( const char *  )
virtual

Set/Get the title of the scalar bar actor,.

◆ GetTitle()

virtual char * vtkAxisActor2D::GetTitle ( )
virtual

Set/Get the title of the scalar bar actor,.

◆ SetTitleTextProperty()

virtual void vtkAxisActor2D::SetTitleTextProperty ( vtkTextProperty p)
virtual

Set/Get the title text property.

◆ GetTitleTextProperty()

virtual vtkTextProperty * vtkAxisActor2D::GetTitleTextProperty ( )
virtual

Set/Get the title text property.

◆ SetLabelTextProperty()

virtual void vtkAxisActor2D::SetLabelTextProperty ( vtkTextProperty p)
virtual

Set/Get the labels text property.

◆ GetLabelTextProperty()

virtual vtkTextProperty * vtkAxisActor2D::GetLabelTextProperty ( )
virtual

Set/Get the labels text property.

◆ SetTickLength()

virtual void vtkAxisActor2D::SetTickLength ( int  )
virtual

Set/Get the length of the tick marks (expressed in pixels or display coordinates).

◆ GetTickLength()

virtual int vtkAxisActor2D::GetTickLength ( )
virtual

Set/Get the length of the tick marks (expressed in pixels or display coordinates).

◆ SetNumberOfMinorTicks()

virtual void vtkAxisActor2D::SetNumberOfMinorTicks ( int  )
virtual

Number of minor ticks to be displayed between each tick.

Default is 0.

◆ GetNumberOfMinorTicks()

virtual int vtkAxisActor2D::GetNumberOfMinorTicks ( )
virtual

Number of minor ticks to be displayed between each tick.

Default is 0.

◆ SetMinorTickLength()

virtual void vtkAxisActor2D::SetMinorTickLength ( int  )
virtual

Set/Get the length of the minor tick marks (expressed in pixels or display coordinates).

◆ GetMinorTickLength()

virtual int vtkAxisActor2D::GetMinorTickLength ( )
virtual

Set/Get the length of the minor tick marks (expressed in pixels or display coordinates).

◆ SetTickOffset()

virtual void vtkAxisActor2D::SetTickOffset ( int  )
virtual

Set/Get the offset of the labels (expressed in pixels or display coordinates).

The offset is the distance of labels from tick marks or other objects.

◆ GetTickOffset()

virtual int vtkAxisActor2D::GetTickOffset ( )
virtual

Set/Get the offset of the labels (expressed in pixels or display coordinates).

The offset is the distance of labels from tick marks or other objects.

◆ SetAxisVisibility()

virtual void vtkAxisActor2D::SetAxisVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis line.

◆ GetAxisVisibility()

virtual vtkTypeBool vtkAxisActor2D::GetAxisVisibility ( )
virtual

Set/Get visibility of the axis line.

◆ AxisVisibilityOn()

virtual void vtkAxisActor2D::AxisVisibilityOn ( )
virtual

Set/Get visibility of the axis line.

◆ AxisVisibilityOff()

virtual void vtkAxisActor2D::AxisVisibilityOff ( )
virtual

Set/Get visibility of the axis line.

◆ SetTickVisibility()

virtual void vtkAxisActor2D::SetTickVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis tick marks.

◆ GetTickVisibility()

virtual vtkTypeBool vtkAxisActor2D::GetTickVisibility ( )
virtual

Set/Get visibility of the axis tick marks.

◆ TickVisibilityOn()

virtual void vtkAxisActor2D::TickVisibilityOn ( )
virtual

Set/Get visibility of the axis tick marks.

◆ TickVisibilityOff()

virtual void vtkAxisActor2D::TickVisibilityOff ( )
virtual

Set/Get visibility of the axis tick marks.

◆ SetLabelVisibility()

virtual void vtkAxisActor2D::SetLabelVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis labels.

◆ GetLabelVisibility()

virtual vtkTypeBool vtkAxisActor2D::GetLabelVisibility ( )
virtual

Set/Get visibility of the axis labels.

◆ LabelVisibilityOn()

virtual void vtkAxisActor2D::LabelVisibilityOn ( )
virtual

Set/Get visibility of the axis labels.

◆ LabelVisibilityOff()

virtual void vtkAxisActor2D::LabelVisibilityOff ( )
virtual

Set/Get visibility of the axis labels.

◆ SetTitleVisibility()

virtual void vtkAxisActor2D::SetTitleVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis title.

◆ GetTitleVisibility()

virtual vtkTypeBool vtkAxisActor2D::GetTitleVisibility ( )
virtual

Set/Get visibility of the axis title.

◆ TitleVisibilityOn()

virtual void vtkAxisActor2D::TitleVisibilityOn ( )
virtual

Set/Get visibility of the axis title.

◆ TitleVisibilityOff()

virtual void vtkAxisActor2D::TitleVisibilityOff ( )
virtual

Set/Get visibility of the axis title.

◆ SetTitlePosition()

virtual void vtkAxisActor2D::SetTitlePosition ( double  )
virtual

Set/Get position of the axis title.

0 is at the start of the axis whereas 1 is at the end.

◆ GetTitlePosition()

virtual double vtkAxisActor2D::GetTitlePosition ( )
virtual

Set/Get position of the axis title.

0 is at the start of the axis whereas 1 is at the end.

◆ SetFontFactor()

virtual void vtkAxisActor2D::SetFontFactor ( double  )
virtual

Set/Get the factor that controls the overall size of the fonts used to label and title the axes.

This ivar used in conjunction with the LabelFactor can be used to control font sizes.

◆ GetFontFactor()

virtual double vtkAxisActor2D::GetFontFactor ( )
virtual

Set/Get the factor that controls the overall size of the fonts used to label and title the axes.

This ivar used in conjunction with the LabelFactor can be used to control font sizes.

◆ SetLabelFactor()

virtual void vtkAxisActor2D::SetLabelFactor ( double  )
virtual

Set/Get the factor that controls the relative size of the axis labels to the axis title.

◆ GetLabelFactor()

virtual double vtkAxisActor2D::GetLabelFactor ( )
virtual

Set/Get the factor that controls the relative size of the axis labels to the axis title.

◆ RenderOverlay()

int vtkAxisActor2D::RenderOverlay ( vtkViewport viewport)
overridevirtual

Draw the axis.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkAxisActor2D::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Draw the axis.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkAxisActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport )
inlineoverridevirtual

Draw the axis.

Reimplemented from vtkProp.

Definition at line 319 of file vtkAxisActor2D.h.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkAxisActor2D::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkAxisActor2D::ReleaseGraphicsResources ( vtkWindow )
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 vtkProp.

◆ ComputeRange()

static void vtkAxisActor2D::ComputeRange ( double  inRange[2],
double  outRange[2],
int  inNumTicks,
int &  outNumTicks,
double &  interval 
)
static

This method computes the range of the axis given an input range.

It also computes the number of tick marks given a suggested number. (The number of tick marks includes end ticks as well.) The number of tick marks computed (in conjunction with the output range) will yield "nice" tick values. For example, if the input range is (0.25,96.7) and the number of ticks requested is 10, the output range will be (0,100) with the number of computed ticks to 11 to yield tick values of (0,10,20,...,100).

◆ SetMultipleFontSize()

static int vtkAxisActor2D::SetMultipleFontSize ( vtkViewport viewport,
vtkTextMapper **  textMappers,
int  nbOfMappers,
int *  targetSize,
double  factor,
int *  stringSize 
)
static

General method to computes font size from a representative size on the viewport (given by size[2]).

The method returns the font size (in points) and the string height/width (in pixels). It also sets the font size of the instance of vtkTextMapper provided. The factor is used when you're trying to create text of different size-factor (it is usually = 1 but you can adjust the font size by making factor larger or smaller).

◆ SetSizeFontRelativeToAxis()

virtual void vtkAxisActor2D::SetSizeFontRelativeToAxis ( vtkTypeBool  )
virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis.

By default, fonts are resized relative to the viewport.

◆ GetSizeFontRelativeToAxis()

virtual vtkTypeBool vtkAxisActor2D::GetSizeFontRelativeToAxis ( )
virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis.

By default, fonts are resized relative to the viewport.

◆ SizeFontRelativeToAxisOn()

virtual void vtkAxisActor2D::SizeFontRelativeToAxisOn ( )
virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis.

By default, fonts are resized relative to the viewport.

◆ SizeFontRelativeToAxisOff()

virtual void vtkAxisActor2D::SizeFontRelativeToAxisOff ( )
virtual

Specify whether to size the fonts relative to the viewport or relative to length of the axis.

By default, fonts are resized relative to the viewport.

◆ SetUseFontSizeFromProperty()

virtual void vtkAxisActor2D::SetUseFontSizeFromProperty ( vtkTypeBool  )
virtual

By default the AxisActor controls the font size of the axis 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 axis size.

◆ GetUseFontSizeFromProperty()

virtual vtkTypeBool vtkAxisActor2D::GetUseFontSizeFromProperty ( )
virtual

By default the AxisActor controls the font size of the axis 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 axis size.

◆ UseFontSizeFromPropertyOn()

virtual void vtkAxisActor2D::UseFontSizeFromPropertyOn ( )
virtual

By default the AxisActor controls the font size of the axis 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 axis size.

◆ UseFontSizeFromPropertyOff()

virtual void vtkAxisActor2D::UseFontSizeFromPropertyOff ( )
virtual

By default the AxisActor controls the font size of the axis 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 axis size.

◆ ShallowCopy()

void vtkAxisActor2D::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of an axis actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

◆ BuildAxis()

virtual void vtkAxisActor2D::BuildAxis ( vtkViewport viewport)
protectedvirtual

◆ ComputeStringOffset()

static double vtkAxisActor2D::ComputeStringOffset ( double  width,
double  height,
double  theta 
)
staticprotected

◆ SetOffsetPosition()

static void vtkAxisActor2D::SetOffsetPosition ( double  xTick[3],
double  theta,
int  stringWidth,
int  stringHeight,
int  offset,
vtkActor2D actor 
)
staticprotected

◆ UpdateAdjustedRange()

virtual void vtkAxisActor2D::UpdateAdjustedRange ( )
protectedvirtual

Member Data Documentation

◆ TitleTextProperty

vtkTextProperty* vtkAxisActor2D::TitleTextProperty
protected

Definition at line 388 of file vtkAxisActor2D.h.

◆ LabelTextProperty

vtkTextProperty* vtkAxisActor2D::LabelTextProperty
protected

Definition at line 389 of file vtkAxisActor2D.h.

◆ Title

char* vtkAxisActor2D::Title
protected

Definition at line 391 of file vtkAxisActor2D.h.

◆ Range

double vtkAxisActor2D::Range[2]
protected

Definition at line 392 of file vtkAxisActor2D.h.

◆ TitlePosition

double vtkAxisActor2D::TitlePosition
protected

Definition at line 393 of file vtkAxisActor2D.h.

◆ RulerMode

vtkTypeBool vtkAxisActor2D::RulerMode
protected

Definition at line 394 of file vtkAxisActor2D.h.

◆ RulerDistance

double vtkAxisActor2D::RulerDistance
protected

Definition at line 395 of file vtkAxisActor2D.h.

◆ NumberOfLabels

int vtkAxisActor2D::NumberOfLabels
protected

Definition at line 396 of file vtkAxisActor2D.h.

◆ LabelFormat

char* vtkAxisActor2D::LabelFormat
protected

Definition at line 397 of file vtkAxisActor2D.h.

◆ AdjustLabels

vtkTypeBool vtkAxisActor2D::AdjustLabels
protected

Definition at line 398 of file vtkAxisActor2D.h.

◆ FontFactor

double vtkAxisActor2D::FontFactor
protected

Definition at line 399 of file vtkAxisActor2D.h.

◆ LabelFactor

double vtkAxisActor2D::LabelFactor
protected

Definition at line 400 of file vtkAxisActor2D.h.

◆ TickLength

int vtkAxisActor2D::TickLength
protected

Definition at line 401 of file vtkAxisActor2D.h.

◆ MinorTickLength

int vtkAxisActor2D::MinorTickLength
protected

Definition at line 402 of file vtkAxisActor2D.h.

◆ TickOffset

int vtkAxisActor2D::TickOffset
protected

Definition at line 403 of file vtkAxisActor2D.h.

◆ NumberOfMinorTicks

int vtkAxisActor2D::NumberOfMinorTicks
protected

Definition at line 404 of file vtkAxisActor2D.h.

◆ AdjustedRange

double vtkAxisActor2D::AdjustedRange[2]
protected

Definition at line 406 of file vtkAxisActor2D.h.

◆ AdjustedNumberOfLabels

int vtkAxisActor2D::AdjustedNumberOfLabels
protected

Definition at line 407 of file vtkAxisActor2D.h.

◆ NumberOfLabelsBuilt

int vtkAxisActor2D::NumberOfLabelsBuilt
protected

Definition at line 408 of file vtkAxisActor2D.h.

◆ AxisVisibility

vtkTypeBool vtkAxisActor2D::AxisVisibility
protected

Definition at line 410 of file vtkAxisActor2D.h.

◆ TickVisibility

vtkTypeBool vtkAxisActor2D::TickVisibility
protected

Definition at line 411 of file vtkAxisActor2D.h.

◆ LabelVisibility

vtkTypeBool vtkAxisActor2D::LabelVisibility
protected

Definition at line 412 of file vtkAxisActor2D.h.

◆ TitleVisibility

vtkTypeBool vtkAxisActor2D::TitleVisibility
protected

Definition at line 413 of file vtkAxisActor2D.h.

◆ LastPosition

int vtkAxisActor2D::LastPosition[2]
protected

Definition at line 415 of file vtkAxisActor2D.h.

◆ LastPosition2

int vtkAxisActor2D::LastPosition2[2]
protected

Definition at line 416 of file vtkAxisActor2D.h.

◆ LastSize

int vtkAxisActor2D::LastSize[2]
protected

Definition at line 418 of file vtkAxisActor2D.h.

◆ LastMaxLabelSize

int vtkAxisActor2D::LastMaxLabelSize[2]
protected

Definition at line 419 of file vtkAxisActor2D.h.

◆ SizeFontRelativeToAxis

int vtkAxisActor2D::SizeFontRelativeToAxis
protected

Definition at line 421 of file vtkAxisActor2D.h.

◆ UseFontSizeFromProperty

vtkTypeBool vtkAxisActor2D::UseFontSizeFromProperty
protected

Definition at line 422 of file vtkAxisActor2D.h.

◆ TitleMapper

vtkTextMapper* vtkAxisActor2D::TitleMapper
protected

Definition at line 430 of file vtkAxisActor2D.h.

◆ TitleActor

vtkActor2D* vtkAxisActor2D::TitleActor
protected

Definition at line 431 of file vtkAxisActor2D.h.

◆ LabelMappers

vtkTextMapper** vtkAxisActor2D::LabelMappers
protected

Definition at line 433 of file vtkAxisActor2D.h.

◆ LabelActors

vtkActor2D** vtkAxisActor2D::LabelActors
protected

Definition at line 434 of file vtkAxisActor2D.h.

◆ Axis

vtkPolyData* vtkAxisActor2D::Axis
protected

Definition at line 436 of file vtkAxisActor2D.h.

◆ AxisMapper

vtkPolyDataMapper2D* vtkAxisActor2D::AxisMapper
protected

Definition at line 437 of file vtkAxisActor2D.h.

◆ AxisActor

vtkActor2D* vtkAxisActor2D::AxisActor
protected

Definition at line 438 of file vtkAxisActor2D.h.

◆ AdjustedRangeBuildTime

vtkTimeStamp vtkAxisActor2D::AdjustedRangeBuildTime
protected

Definition at line 440 of file vtkAxisActor2D.h.

◆ BuildTime

vtkTimeStamp vtkAxisActor2D::BuildTime
protected

Definition at line 441 of file vtkAxisActor2D.h.


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