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

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

#include <vtkAxisActor.h>

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

Public Types

enum  TickLocation { VTK_TICKS_INSIDE = 0, VTK_TICKS_OUTSIDE = 1, VTK_TICKS_BOTH = 2 }
 
enum  AlignLocation { VTK_ALIGN_TOP = 0, VTK_ALIGN_BOTTOM = 1, VTK_ALIGN_POINT1 = 2, VTK_ALIGN_POINT2 = 3 }
 
enum  AxisType { VTK_AXIS_TYPE_X = 0, VTK_AXIS_TYPE_Y = 1, VTK_AXIS_TYPE_Z = 2 }
 
enum  AxisPosition { VTK_AXIS_POS_MINMIN = 0, VTK_AXIS_POS_MINMAX = 1, VTK_AXIS_POS_MAXMAX = 2, VTK_AXIS_POS_MAXMIN = 3 }
 
typedef vtkActor Superclass
 
- Public Types inherited from vtkActor
typedef vtkProp3D Superclass
 
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAxisActorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetTickLocationToInside (void)
 
void SetTickLocationToOutside (void)
 
void SetTickLocationToBoth (void)
 
virtual void SetDrawGridlinesLocation (int)
 
virtual int GetDrawGridlinesLocation ()
 
void SetAxisPositionToMinMin (void)
 
void SetAxisPositionToMinMax (void)
 
void SetAxisPositionToMaxMax (void)
 
void SetAxisPositionToMaxMin (void)
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
double ComputeMaxLabelLength (const double[3])
 
double ComputeTitleLength (const double[3])
 
void SetLabelScale (const double scale)
 
void SetLabelScale (int labelIndex, const double scale)
 
void SetTitleScale (const double scale)
 
void SetLabels (vtkStringArray *labels)
 
void BuildAxis (vtkViewport *viewport, bool)
 
vtkAxisFollower ** GetLabelActors ()
 Get label actors responsigle for drawing label text. More...
 
vtkProp3DAxisFollower ** GetLabelProps3D ()
 Get label actors responsigle for drawing label text. More...
 
virtual vtkCoordinateGetPoint1Coordinate ()
 Specify the position of the first point defining the axis. More...
 
virtual void SetPoint1 (double x[3])
 Specify the position of the first point defining the axis. More...
 
virtual void SetPoint1 (double x, double y, double z)
 Specify the position of the first point defining the axis. More...
 
virtual doubleGetPoint1 ()
 Specify the position of the first point defining the axis. More...
 
virtual vtkCoordinateGetPoint2Coordinate ()
 Specify the position of the second point defining the axis. More...
 
virtual void SetPoint2 (double x[3])
 Specify the position of the second point defining the axis. More...
 
virtual void SetPoint2 (double x, double y, double z)
 Specify the position of the second point defining the axis. More...
 
virtual doubleGetPoint2 ()
 Specify the position of the second point defining the axis. More...
 
virtual void SetRange (double, double)
 Specify the (min,max) axis range. More...
 
void SetRange (double[2])
 Specify the (min,max) axis range. More...
 
virtual doubleGetRange ()
 Specify the (min,max) axis range. More...
 
virtual void GetRange (double data[2])
 Specify the (min,max) axis range. More...
 
void SetBounds (const double bounds[6])
 Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void SetBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
doubleGetBounds (void) override
 Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void GetBounds (double bounds[6])
 Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
virtual void SetLabelFormat (const char *)
 Set/Get the format with which to print the labels on the axis. More...
 
virtual char * GetLabelFormat ()
 Set/Get the format with which to print the labels on the axis. More...
 
virtual void SetUseTextActor3D (int)
 Render text as polygons (vtkVectorText) or as sprites (vtkTextActor3D). More...
 
virtual int GetUseTextActor3D ()
 Render text as polygons (vtkVectorText) or as sprites (vtkTextActor3D). More...
 
virtual void SetMinorTicksVisible (vtkTypeBool)
 Set/Get the flag that controls whether the minor ticks are visible. More...
 
virtual vtkTypeBool GetMinorTicksVisible ()
 Set/Get the flag that controls whether the minor ticks are visible. More...
 
virtual void MinorTicksVisibleOn ()
 Set/Get the flag that controls whether the minor ticks are visible. More...
 
virtual void MinorTicksVisibleOff ()
 Set/Get the flag that controls whether the minor ticks are visible. More...
 
void SetTitle (const char *t)
 Set/Get the title of the axis actor,. More...
 
virtual char * GetTitle ()
 Set/Get the title of the axis actor,. More...
 
void SetExponent (const char *t)
 Set/Get the common exponent of the labels values. More...
 
virtual char * GetExponent ()
 Set/Get the common exponent of the labels values. More...
 
virtual void SetMajorTickSize (double)
 Set/Get the size of the major tick marks. More...
 
virtual double GetMajorTickSize ()
 Set/Get the size of the major tick marks. More...
 
virtual void SetMinorTickSize (double)
 Set/Get the size of the major tick marks. More...
 
virtual double GetMinorTickSize ()
 Set/Get the size of the major tick marks. More...
 
virtual void SetTickLocation (int)
 Set/Get the location of the ticks. More...
 
virtual int GetTickLocation ()
 Set/Get the location of the ticks. More...
 
virtual void SetAxisVisibility (vtkTypeBool)
 Set/Get visibility of the axis line. More...
 
virtual vtkTypeBool GetAxisVisibility ()
 Set/Get visibility of the axis line. More...
 
virtual void AxisVisibilityOn ()
 Set/Get visibility of the axis line. More...
 
virtual void AxisVisibilityOff ()
 Set/Get visibility of the axis line. More...
 
virtual void SetTickVisibility (vtkTypeBool)
 Set/Get visibility of the axis major tick marks. More...
 
virtual vtkTypeBool GetTickVisibility ()
 Set/Get visibility of the axis major tick marks. More...
 
virtual void TickVisibilityOn ()
 Set/Get visibility of the axis major tick marks. More...
 
virtual void TickVisibilityOff ()
 Set/Get visibility of the axis major tick marks. More...
 
virtual void SetLabelVisibility (vtkTypeBool)
 Set/Get visibility of the axis labels. More...
 
virtual vtkTypeBool GetLabelVisibility ()
 Set/Get visibility of the axis labels. More...
 
virtual void LabelVisibilityOn ()
 Set/Get visibility of the axis labels. More...
 
virtual void LabelVisibilityOff ()
 Set/Get visibility of the axis labels. More...
 
virtual void SetTitleVisibility (vtkTypeBool)
 Set/Get visibility of the axis title. More...
 
virtual vtkTypeBool GetTitleVisibility ()
 Set/Get visibility of the axis title. More...
 
virtual void TitleVisibilityOn ()
 Set/Get visibility of the axis title. More...
 
virtual void TitleVisibilityOff ()
 Set/Get visibility of the axis title. More...
 
virtual void SetExponentVisibility (bool)
 Set/Get visibility of the axis detached exponent. More...
 
virtual bool GetExponentVisibility ()
 Set/Get visibility of the axis detached exponent. More...
 
virtual void ExponentVisibilityOn ()
 Set/Get visibility of the axis detached exponent. More...
 
virtual void ExponentVisibilityOff ()
 Set/Get visibility of the axis detached exponent. More...
 
virtual void SetLastMajorTickPointCorrection (bool)
 Set/Get visibility of the axis detached exponent. More...
 
virtual bool GetLastMajorTickPointCorrection ()
 Set/Get visibility of the axis detached exponent. More...
 
virtual void LastMajorTickPointCorrectionOn ()
 Set/Get visibility of the axis detached exponent. More...
 
virtual void LastMajorTickPointCorrectionOff ()
 Set/Get visibility of the axis detached exponent. More...
 
virtual void SetTitleAlignLocation (int location)
 Get/Set the alignment of the title related to the axis. More...
 
virtual int GetTitleAlignLocation ()
 Get/Set the alignment of the title related to the axis. More...
 
virtual void SetExponentLocation (int location)
 Get/Set the location of the Detached Exponent related to the axis. More...
 
virtual int GetExponentLocation ()
 Get/Set the location of the Detached Exponent related to the axis. More...
 
virtual void SetTitleTextProperty (vtkTextProperty *p)
 Set/Get the axis title text property. More...
 
virtual vtkTextPropertyGetTitleTextProperty ()
 Set/Get the axis title text property. More...
 
virtual void SetLabelTextProperty (vtkTextProperty *p)
 Set/Get the axis labels text property. More...
 
virtual vtkTextPropertyGetLabelTextProperty ()
 Set/Get the axis labels text property. More...
 
void SetAxisLinesProperty (vtkProperty *)
 Get/Set axis actor property (axis and its ticks) (kept for compatibility) More...
 
vtkPropertyGetAxisLinesProperty ()
 Get/Set axis actor property (axis and its ticks) (kept for compatibility) More...
 
void SetAxisMainLineProperty (vtkProperty *)
 Get/Set main line axis actor property. More...
 
vtkPropertyGetAxisMainLineProperty ()
 Get/Set main line axis actor property. More...
 
void SetAxisMajorTicksProperty (vtkProperty *)
 Get/Set axis actor property (axis and its ticks) More...
 
vtkPropertyGetAxisMajorTicksProperty ()
 Get/Set axis actor property (axis and its ticks) More...
 
void SetAxisMinorTicksProperty (vtkProperty *)
 Get/Set axis actor property (axis and its ticks) More...
 
vtkPropertyGetAxisMinorTicksProperty ()
 Get/Set axis actor property (axis and its ticks) More...
 
void SetGridlinesProperty (vtkProperty *)
 Get/Set gridlines actor property (outer grid lines) More...
 
vtkPropertyGetGridlinesProperty ()
 Get/Set gridlines actor property (outer grid lines) More...
 
void SetInnerGridlinesProperty (vtkProperty *)
 Get/Set inner gridlines actor property. More...
 
vtkPropertyGetInnerGridlinesProperty ()
 Get/Set inner gridlines actor property. More...
 
void SetGridpolysProperty (vtkProperty *)
 Get/Set gridPolys actor property (grid quads) More...
 
vtkPropertyGetGridpolysProperty ()
 Get/Set gridPolys actor property (grid quads) More...
 
virtual void SetDrawGridlines (vtkTypeBool)
 Set/Get whether gridlines should be drawn. More...
 
virtual vtkTypeBool GetDrawGridlines ()
 Set/Get whether gridlines should be drawn. More...
 
virtual void DrawGridlinesOn ()
 Set/Get whether gridlines should be drawn. More...
 
virtual void DrawGridlinesOff ()
 Set/Get whether gridlines should be drawn. More...
 
virtual void SetDrawGridlinesOnly (vtkTypeBool)
 Set/Get whether ONLY the gridlines should be drawn. More...
 
virtual vtkTypeBool GetDrawGridlinesOnly ()
 Set/Get whether ONLY the gridlines should be drawn. More...
 
virtual void DrawGridlinesOnlyOn ()
 Set/Get whether ONLY the gridlines should be drawn. More...
 
virtual void DrawGridlinesOnlyOff ()
 Set/Get whether ONLY the gridlines should be drawn. More...
 
virtual void SetDrawInnerGridlines (vtkTypeBool)
 Set/Get whether inner gridlines should be drawn. More...
 
virtual vtkTypeBool GetDrawInnerGridlines ()
 Set/Get whether inner gridlines should be drawn. More...
 
virtual void DrawInnerGridlinesOn ()
 Set/Get whether inner gridlines should be drawn. More...
 
virtual void DrawInnerGridlinesOff ()
 Set/Get whether inner gridlines should be drawn. More...
 
virtual void SetGridlineXLength (double)
 Set/Get the length to use when drawing gridlines. More...
 
virtual double GetGridlineXLength ()
 Set/Get the length to use when drawing gridlines. More...
 
virtual void SetGridlineYLength (double)
 Set/Get the length to use when drawing gridlines. More...
 
virtual double GetGridlineYLength ()
 Set/Get the length to use when drawing gridlines. More...
 
virtual void SetGridlineZLength (double)
 Set/Get the length to use when drawing gridlines. More...
 
virtual double GetGridlineZLength ()
 Set/Get the length to use when drawing gridlines. More...
 
virtual void SetDrawGridpolys (vtkTypeBool)
 Set/Get whether gridpolys should be drawn. More...
 
virtual vtkTypeBool GetDrawGridpolys ()
 Set/Get whether gridpolys should be drawn. More...
 
virtual void DrawGridpolysOn ()
 Set/Get whether gridpolys should be drawn. More...
 
virtual void DrawGridpolysOff ()
 Set/Get whether gridpolys should be drawn. More...
 
virtual void SetAxisType (int)
 Set/Get the type of this axis. More...
 
virtual int GetAxisType ()
 Set/Get the type of this axis. More...
 
void SetAxisTypeToX (void)
 Set/Get the type of this axis. More...
 
void SetAxisTypeToY (void)
 Set/Get the type of this axis. More...
 
void SetAxisTypeToZ (void)
 Set/Get the type of this axis. More...
 
virtual void SetLog (bool)
 Set/Get The type of scale, enable logarithmic scale or linear by default. More...
 
virtual bool GetLog ()
 Set/Get The type of scale, enable logarithmic scale or linear by default. More...
 
virtual void LogOn ()
 Set/Get The type of scale, enable logarithmic scale or linear by default. More...
 
virtual void LogOff ()
 Set/Get The type of scale, enable logarithmic scale or linear by default. More...
 
virtual void SetAxisPosition (int)
 Set/Get the position of this axis (in relation to an an assumed bounding box). More...
 
virtual int GetAxisPosition ()
 Set/Get the position of this axis (in relation to an an assumed bounding box). More...
 
virtual void SetCamera (vtkCamera *)
 Set/Get the camera for this axis. More...
 
virtual vtkCameraGetCamera ()
 Set/Get the camera for this axis. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Draw the axis. More...
 
virtual int RenderTranslucentGeometry (vtkViewport *viewport)
 Draw the axis. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Draw the axis. More...
 
int RenderOverlay (vtkViewport *viewport) override
 Draw the axis. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Draw the axis. More...
 
virtual void SetMinorStart (double)
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
virtual double GetMinorStart ()
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
double GetMajorStart (int axis)
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
void SetMajorStart (int axis, double value)
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
virtual void SetDeltaMinor (double)
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
virtual double GetDeltaMinor ()
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
double GetDeltaMajor (int axis)
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
void SetDeltaMajor (int axis, double value)
 Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing. More...
 
virtual void SetMinorRangeStart (double)
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual double GetMinorRangeStart ()
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual void SetMajorRangeStart (double)
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual double GetMajorRangeStart ()
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual void SetDeltaRangeMinor (double)
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual double GetDeltaRangeMinor ()
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual void SetDeltaRangeMajor (double)
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual double GetDeltaRangeMajor ()
 Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing. More...
 
virtual vtkAxisFollowerGetTitleActor ()
 Get title actor and it is responsible for drawing title text. More...
 
virtual vtkAxisFollowerGetExponentActor ()
 Get exponent follower actor. More...
 
virtual vtkProp3DAxisFollowerGetTitleProp3D ()
 Get title actor and it is responsible for drawing title text. More...
 
virtual vtkProp3DAxisFollowerGetExponentProp3D ()
 Get title actor and it is responsible for drawing title text. More...
 
virtual int GetNumberOfLabelsBuilt ()
 Get total number of labels built. More...
 
virtual void SetCalculateTitleOffset (vtkTypeBool)
 Set/Get flag whether to calculate title offset. More...
 
virtual vtkTypeBool GetCalculateTitleOffset ()
 Set/Get flag whether to calculate title offset. More...
 
virtual void CalculateTitleOffsetOn ()
 Set/Get flag whether to calculate title offset. More...
 
virtual void CalculateTitleOffsetOff ()
 Set/Get flag whether to calculate title offset. More...
 
virtual void SetCalculateLabelOffset (vtkTypeBool)
 Set/Get flag whether to calculate label offset. More...
 
virtual vtkTypeBool GetCalculateLabelOffset ()
 Set/Get flag whether to calculate label offset. More...
 
virtual void CalculateLabelOffsetOn ()
 Set/Get flag whether to calculate label offset. More...
 
virtual void CalculateLabelOffsetOff ()
 Set/Get flag whether to calculate label offset. More...
 
virtual void SetUse2DMode (int)
 Set/Get the 2D mode. More...
 
virtual int GetUse2DMode ()
 Set/Get the 2D mode. More...
 
virtual void SetVerticalOffsetXTitle2D (double)
 Set/Get the 2D mode the vertical offset for X title in 2D mode. More...
 
virtual double GetVerticalOffsetXTitle2D ()
 Set/Get the 2D mode the vertical offset for X title in 2D mode. More...
 
virtual void SetHorizontalOffsetYTitle2D (double)
 Set/Get the 2D mode the horizontal offset for Y title in 2D mode. More...
 
virtual double GetHorizontalOffsetYTitle2D ()
 Set/Get the 2D mode the horizontal offset for Y title in 2D mode. More...
 
virtual void SetSaveTitlePosition (int)
 Set/Get whether title position must be saved in 2D mode. More...
 
virtual int GetSaveTitlePosition ()
 Set/Get whether title position must be saved in 2D mode. More...
 
virtual void SetAxisBaseForX (double, double, double)
 Provide real vector for non aligned axis. More...
 
virtual void SetAxisBaseForX (double[3])
 Provide real vector for non aligned axis. More...
 
virtual doubleGetAxisBaseForX ()
 Provide real vector for non aligned axis. More...
 
virtual void GetAxisBaseForX (double &, double &, double &)
 Provide real vector for non aligned axis. More...
 
virtual void GetAxisBaseForX (double[3])
 Provide real vector for non aligned axis. More...
 
virtual void SetAxisBaseForY (double, double, double)
 Provide real vector for non aligned axis. More...
 
virtual void SetAxisBaseForY (double[3])
 Provide real vector for non aligned axis. More...
 
virtual doubleGetAxisBaseForY ()
 Provide real vector for non aligned axis. More...
 
virtual void GetAxisBaseForY (double &, double &, double &)
 Provide real vector for non aligned axis. More...
 
virtual void GetAxisBaseForY (double[3])
 Provide real vector for non aligned axis. More...
 
virtual void SetAxisBaseForZ (double, double, double)
 Provide real vector for non aligned axis. More...
 
virtual void SetAxisBaseForZ (double[3])
 Provide real vector for non aligned axis. More...
 
virtual doubleGetAxisBaseForZ ()
 Provide real vector for non aligned axis. More...
 
virtual void GetAxisBaseForZ (double &, double &, double &)
 Provide real vector for non aligned axis. More...
 
virtual void GetAxisBaseForZ (double[3])
 Provide real vector for non aligned axis. More...
 
virtual void SetAxisOnOrigin (int)
 Notify the axes that is not part of a cube anymore. More...
 
virtual int GetAxisOnOrigin ()
 Notify the axes that is not part of a cube anymore. More...
 
virtual void SetLabelOffset (double)
 Set/Get the offsets used to position texts. More...
 
virtual double GetLabelOffset ()
 Set/Get the offsets used to position texts. More...
 
virtual void SetTitleOffset (double)
 Set/Get the offsets used to position texts. More...
 
virtual double GetTitleOffset ()
 Set/Get the offsets used to position texts. More...
 
virtual void SetExponentOffset (double)
 Set/Get the offsets used to position texts. More...
 
virtual double GetExponentOffset ()
 Set/Get the offsets used to position texts. More...
 
virtual void SetScreenSize (double)
 Set/Get the offsets used to position texts. More...
 
virtual double GetScreenSize ()
 Set/Get the offsets used to position texts. More...
 
- Public Member Functions inherited from vtkActor
vtkActorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void Render (vtkRenderer *, vtkMapper *)
 This causes the actor to be rendered. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of an actor. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
virtual vtkPropertyMakeProperty ()
 Create a new property suitable for use with this type of Actor. More...
 
virtual void SetMapper (vtkMapper *)
 This is the method that is used to connect an actor to the end of a visualization pipeline, i.e. More...
 
doubleGetBounds () override
 Return a reference to the Prop3D's composite transform. More...
 
virtual void ApplyProperties ()
 Apply the current properties to all parts that compose this actor. More...
 
vtkMTimeType GetMTime () override
 Get the actors mtime plus consider its properties and texture if set. More...
 
vtkMTimeType GetRedrawMTime () override
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
bool GetSupportsSelection () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
void ProcessSelectorPixelBuffers (vtkHardwareSelector *sel, std::vector< unsigned int > &pixeloffsets) override
 allows a prop to update a selections color buffers Default just forwards to the Mapper More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some opaque/translucent polygonal geometry? More...
 
vtkTypeBool HasOpaqueGeometry () override
 Does this prop have some opaque/translucent polygonal geometry? More...
 
void SetProperty (vtkProperty *lut)
 Set/Get the property object that controls this actors surface properties. More...
 
vtkPropertyGetProperty ()
 Set/Get the property object that controls this actors surface properties. More...
 
void SetBackfaceProperty (vtkProperty *lut)
 Set/Get the property object that controls this actors backface surface properties. More...
 
virtual vtkPropertyGetBackfaceProperty ()
 Set/Get the property object that controls this actors backface surface properties. More...
 
virtual void SetTexture (vtkTexture *)
 Set/Get the texture object to control rendering texture maps. More...
 
virtual vtkTextureGetTexture ()
 Set/Get the texture object to control rendering texture maps. More...
 
virtual vtkMapperGetMapper ()
 Returns the Mapper that this actor is getting its data from. More...
 
virtual bool GetForceOpaque ()
 Force the actor to be treated as opaque or translucent. More...
 
virtual void SetForceOpaque (bool)
 Force the actor to be treated as opaque or translucent. More...
 
virtual void ForceOpaqueOn ()
 Force the actor to be treated as opaque or translucent. More...
 
virtual void ForceOpaqueOff ()
 Force the actor to be treated as opaque or translucent. More...
 
virtual bool GetForceTranslucent ()
 Force the actor to be treated as opaque or translucent. More...
 
virtual void SetForceTranslucent (bool)
 Force the actor to be treated as opaque or translucent. More...
 
virtual void ForceTranslucentOn ()
 Force the actor to be treated as opaque or translucent. More...
 
virtual void ForceTranslucentOff ()
 Force the actor to be treated as opaque or translucent. More...
 
bool IsRenderingTranslucentPolygonalGeometry () override
 
void SetIsRenderingTranslucentPolygonalGeometry (bool val)
 
- Public Member Functions inherited from vtkProp3D
vtkProp3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp3D. More...
 
virtual void SetPosition (double pos[3])
 
virtual doubleGetPosition ()
 
virtual void GetPosition (double data[3])
 
void AddPosition (double deltaPosition[3])
 
void AddPosition (double deltaX, double deltaY, double deltaZ)
 
void SetScale (double s)
 Method to set the scale isotropically. More...
 
doubleGetCenter ()
 Get the center of the bounding box in world coordinates. More...
 
doubleGetXRange ()
 Get the Prop3D's x range in world coordinates. More...
 
doubleGetYRange ()
 Get the Prop3D's y range in world coordinates. More...
 
doubleGetZRange ()
 Get the Prop3D's z range in world coordinates. More...
 
double GetLength ()
 Get the length of the diagonal of the bounding box. More...
 
void RotateX (double)
 Rotate the Prop3D in degrees about the X axis using the right hand rule. More...
 
void RotateY (double)
 Rotate the Prop3D in degrees about the Y axis using the right hand rule. More...
 
void RotateZ (double)
 Rotate the Prop3D in degrees about the Z axis using the right hand rule. More...
 
void RotateWXYZ (double w, double x, double y, double z)
 Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments. More...
 
void SetOrientation (double x, double y, double z)
 Sets the orientation of the Prop3D. More...
 
void SetOrientation (double orientation[3])
 Sets the orientation of the Prop3D. More...
 
doubleGetOrientationWXYZ ()
 Returns the WXYZ orientation of the Prop3D. More...
 
void AddOrientation (double x, double y, double z)
 Add to the current orientation. More...
 
void AddOrientation (double orentation[3])
 Add to the current orientation. More...
 
void PokeMatrix (vtkMatrix4x4 *matrix) override
 This method modifies the vtkProp3D so that its transformation state is set to the matrix specified. More...
 
void InitPathTraversal () override
 Overload vtkProp's method for setting up assembly paths. More...
 
vtkMTimeType GetMTime () override
 Get the vtkProp3D's mtime. More...
 
vtkMTimeType GetUserTransformMatrixMTime ()
 Get the modified time of the user matrix or user transform. More...
 
virtual void ComputeMatrix ()
 Generate the matrix based on ivars. More...
 
virtual void SetPosition (double x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates. More...
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D. More...
 
virtual void SetOrigin (const double pos[3])
 Set/Get the origin of the Prop3D. More...
 
virtual doubleGetOrigin ()
 Set/Get the origin of the Prop3D. More...
 
virtual void GetOrigin (double data[3])
 Set/Get the origin of the Prop3D. More...
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor. More...
 
virtual void SetScale (double scale[3])
 Set/Get the scale of the actor. More...
 
virtual doubleGetScale ()
 Set/Get the scale of the actor. More...
 
virtual void GetScale (double data[3])
 Set/Get the scale of the actor. More...
 
void SetUserTransform (vtkLinearTransform *transform)
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
virtual vtkLinearTransformGetUserTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform. More...
 
vtkMatrix4x4GetUserMatrix ()
 The UserMatrix can be used in place of UserTransform. More...
 
virtual void GetMatrix (vtkMatrix4x4 *m)
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
virtual void GetMatrix (double m[16])
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform. More...
 
doubleGetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
void GetOrientation (double orentation[3])
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
vtkMatrix4x4GetMatrix () override
 Get a pointer to an internal vtkMatrix4x4. More...
 
virtual int GetIsIdentity ()
 Is the matrix for this actor identity. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAxisActorSafeDownCast (vtkObjectBase *o)
 
static vtkAxisActorNew ()
 Instantiate object. More...
 
- Static Public Member Functions inherited from vtkActor
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkActorSafeDownCast (vtkObjectBase *o)
 
static vtkActorNew ()
 Creates an actor with the following defaults: origin(0,0,0) position=(0,0,0) scale=(1,1,1) visibility=1 pickable=1 dragable=1 orientation=(0,0,0). More...
 
- Static Public Member Functions inherited from vtkProp3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAxisActor ()
 
 ~vtkAxisActor () override
 
- Protected Member Functions inherited from vtkActor
 vtkActor ()
 
 ~vtkActor () override
 
int GetIsOpaque ()
 
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 
 ~vtkProp3D () override
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * Title
 
char * Exponent
 
double Range [2]
 
double LastRange [2]
 
char * LabelFormat
 
int UseTextActor3D
 
int NumberOfLabelsBuilt
 
vtkTypeBool MinorTicksVisible
 
int LastMinorTicksVisible
 
int TickLocation
 The location of the ticks. More...
 
int TitleAlignLocation
 Hold the alignment property of the title related to the axis. More...
 
int ExponentLocation
 Hold the alignment property of the exponent coming from the label values. More...
 
vtkTypeBool DrawGridlines
 
vtkTypeBool DrawGridlinesOnly
 
int LastDrawGridlines
 
int DrawGridlinesLocation
 
int LastDrawGridlinesLocation
 
double GridlineXLength
 
double GridlineYLength
 
double GridlineZLength
 
vtkTypeBool DrawInnerGridlines
 
int LastDrawInnerGridlines
 
vtkTypeBool DrawGridpolys
 
int LastDrawGridpolys
 
vtkTypeBool AxisVisibility
 
vtkTypeBool TickVisibility
 
int LastTickVisibility
 
vtkTypeBool LabelVisibility
 
vtkTypeBool TitleVisibility
 
bool ExponentVisibility
 
bool LastMajorTickPointCorrection
 
bool Log
 
int AxisType
 
int AxisPosition
 
double AxisBaseForX [3]
 
double AxisBaseForY [3]
 
double AxisBaseForZ [3]
 
- Protected Attributes inherited from vtkActor
bool ForceOpaque
 
bool ForceTranslucent
 
bool InTranslucentPass
 
vtkPropertyProperty
 
vtkPropertyBackfaceProperty
 
vtkTextureTexture
 
vtkMapperMapper
 
double MapperBounds [6]
 
vtkTimeStamp BoundsMTime
 
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
 
vtkMatrix4x4UserMatrix
 
vtkMatrix4x4Matrix
 
vtkTimeStamp MatrixMTime
 
double Origin [3]
 
double Position [3]
 
double Orientation [3]
 
double Scale [3]
 
double Center [3]
 
vtkTransformTransform
 
double Bounds [6]
 
vtkProp3DCachedProp3D
 
int IsIdentity
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Create an axis with tick marks and labels.

vtkAxisActor creates an axis with tick marks, labels, and/or a title, depending on the particular instance variable settings. It is assumed that the axes is part of a bounding box and is orthogonal to one of the coordinate axes. To use this class, you typically specify two points defining the start and end points of the line (xyz definition using vtkCoordinate class), the axis type (X, Y or Z), the axis location in relation to the bounding box, the bounding box, 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. It is also possible to control gridlines, and specify on which 'side' the tickmarks are drawn (again with respect to the underlying assumed bounding box). You can also specify the label format (a printf style format).

This class decides how to locate the labels, and how to create reasonable tick marks and labels.

Labels follow the camera so as to be legible from any viewpoint.

The instance variables Point1 and Point2 are instances of vtkCoordinate. All calculations and references are in World Coordinates.

Thanks:
This class was written by: Hank Childs, Kathleen Bonnell, Amy Squillacote, Brad Whitlock, Eric Brugger, Claire Guilbaud, Nicolas Dolegieviez, Will Schroeder, Karthik Krishnan, Aashish Chaudhary, Philippe Pebay, David Gobbi, David Partyka, Utkarsh Ayachit David Cole, Francois Bertel, and Mark Olesen Part of this work was supported by CEA/DIF - Commissariat a l'Energie Atomique, Centre DAM Ile-De-France, BP12, F-91297 Arpajon, France.
See also
vtkActor vtkVectorText vtkPolyDataMapper vtkAxisActor2D vtkCoordinate
Tests:
vtkAxisActor (Tests)

Definition at line 74 of file vtkAxisActor.h.

Member Typedef Documentation

Definition at line 77 of file vtkAxisActor.h.

Member Enumeration Documentation

Enumerator
VTK_TICKS_INSIDE 
VTK_TICKS_OUTSIDE 
VTK_TICKS_BOTH 

Definition at line 185 of file vtkAxisActor.h.

Enumerator
VTK_ALIGN_TOP 
VTK_ALIGN_BOTTOM 
VTK_ALIGN_POINT1 
VTK_ALIGN_POINT2 

Definition at line 260 of file vtkAxisActor.h.

Enumerator
VTK_AXIS_TYPE_X 
VTK_AXIS_TYPE_Y 
VTK_AXIS_TYPE_Z 

Definition at line 411 of file vtkAxisActor.h.

Enumerator
VTK_AXIS_POS_MINMIN 
VTK_AXIS_POS_MINMAX 
VTK_AXIS_POS_MAXMAX 
VTK_AXIS_POS_MAXMIN 

Definition at line 429 of file vtkAxisActor.h.

Constructor & Destructor Documentation

vtkAxisActor::vtkAxisActor ( )
protected
vtkAxisActor::~vtkAxisActor ( )
overrideprotected

Member Function Documentation

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

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

Reimplemented from vtkActor.

vtkAxisActor* vtkAxisActor::NewInstance ( ) const
void vtkAxisActor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

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

Reimplemented from vtkObject.

static vtkAxisActor* vtkAxisActor::New ( )
static

Instantiate object.

virtual vtkCoordinate* vtkAxisActor::GetPoint1Coordinate ( )
virtual

Specify the position of the first point defining the axis.

virtual void vtkAxisActor::SetPoint1 ( double  x[3])
inlinevirtual

Specify the position of the first point defining the axis.

Definition at line 90 of file vtkAxisActor.h.

virtual void vtkAxisActor::SetPoint1 ( double  x,
double  y,
double  z 
)
virtual

Specify the position of the first point defining the axis.

virtual double* vtkAxisActor::GetPoint1 ( )
virtual

Specify the position of the first point defining the axis.

virtual vtkCoordinate* vtkAxisActor::GetPoint2Coordinate ( )
virtual

Specify the position of the second point defining the axis.

virtual void vtkAxisActor::SetPoint2 ( double  x[3])
inlinevirtual

Specify the position of the second point defining the axis.

Definition at line 100 of file vtkAxisActor.h.

virtual void vtkAxisActor::SetPoint2 ( double  x,
double  y,
double  z 
)
virtual

Specify the position of the second point defining the axis.

virtual double* vtkAxisActor::GetPoint2 ( )
virtual

Specify the position of the second point defining the axis.

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

Specify the (min,max) axis range.

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

void vtkAxisActor::SetRange ( double  [2])

Specify the (min,max) axis range.

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

virtual double* vtkAxisActor::GetRange ( )
virtual

Specify the (min,max) axis range.

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

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

Specify the (min,max) axis range.

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

void vtkAxisActor::SetBounds ( const double  bounds[6])

Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

void vtkAxisActor::SetBounds ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

double* vtkAxisActor::GetBounds ( void  )
overridevirtual

Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Implements vtkProp3D.

void vtkAxisActor::GetBounds ( double  bounds[6])

Set or get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

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

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

virtual char* vtkAxisActor::GetLabelFormat ( )
virtual

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

virtual void vtkAxisActor::SetUseTextActor3D ( int  )
virtual

Render text as polygons (vtkVectorText) or as sprites (vtkTextActor3D).

In 2D mode, the value is ignored and text is rendered as vtkTextActor. False(0) by default. See Also: GetUse2DMode(), SetUse2DMode

virtual int vtkAxisActor::GetUseTextActor3D ( )
virtual

Render text as polygons (vtkVectorText) or as sprites (vtkTextActor3D).

In 2D mode, the value is ignored and text is rendered as vtkTextActor. False(0) by default. See Also: GetUse2DMode(), SetUse2DMode

virtual void vtkAxisActor::SetMinorTicksVisible ( vtkTypeBool  )
virtual

Set/Get the flag that controls whether the minor ticks are visible.

virtual vtkTypeBool vtkAxisActor::GetMinorTicksVisible ( )
virtual

Set/Get the flag that controls whether the minor ticks are visible.

virtual void vtkAxisActor::MinorTicksVisibleOn ( )
virtual

Set/Get the flag that controls whether the minor ticks are visible.

virtual void vtkAxisActor::MinorTicksVisibleOff ( )
virtual

Set/Get the flag that controls whether the minor ticks are visible.

void vtkAxisActor::SetTitle ( const char *  t)

Set/Get the title of the axis actor,.

virtual char* vtkAxisActor::GetTitle ( )
virtual

Set/Get the title of the axis actor,.

void vtkAxisActor::SetExponent ( const char *  t)

Set/Get the common exponent of the labels values.

virtual char* vtkAxisActor::GetExponent ( )
virtual

Set/Get the common exponent of the labels values.

virtual void vtkAxisActor::SetMajorTickSize ( double  )
virtual

Set/Get the size of the major tick marks.

virtual double vtkAxisActor::GetMajorTickSize ( )
virtual

Set/Get the size of the major tick marks.

virtual void vtkAxisActor::SetMinorTickSize ( double  )
virtual

Set/Get the size of the major tick marks.

virtual double vtkAxisActor::GetMinorTickSize ( )
virtual

Set/Get the size of the major tick marks.

virtual void vtkAxisActor::SetTickLocation ( int  )
virtual

Set/Get the location of the ticks.

Inside: tick end toward positive direction of perpendicular axes. Outside: tick end toward negative direction of perpendicular axes.

virtual int vtkAxisActor::GetTickLocation ( )
virtual

Set/Get the location of the ticks.

Inside: tick end toward positive direction of perpendicular axes. Outside: tick end toward negative direction of perpendicular axes.

void vtkAxisActor::SetTickLocationToInside ( void  )
inline

Definition at line 202 of file vtkAxisActor.h.

void vtkAxisActor::SetTickLocationToOutside ( void  )
inline

Definition at line 203 of file vtkAxisActor.h.

void vtkAxisActor::SetTickLocationToBoth ( void  )
inline

Definition at line 204 of file vtkAxisActor.h.

virtual void vtkAxisActor::SetAxisVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis line.

virtual vtkTypeBool vtkAxisActor::GetAxisVisibility ( )
virtual

Set/Get visibility of the axis line.

virtual void vtkAxisActor::AxisVisibilityOn ( )
virtual

Set/Get visibility of the axis line.

virtual void vtkAxisActor::AxisVisibilityOff ( )
virtual

Set/Get visibility of the axis line.

virtual void vtkAxisActor::SetTickVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis major tick marks.

virtual vtkTypeBool vtkAxisActor::GetTickVisibility ( )
virtual

Set/Get visibility of the axis major tick marks.

virtual void vtkAxisActor::TickVisibilityOn ( )
virtual

Set/Get visibility of the axis major tick marks.

virtual void vtkAxisActor::TickVisibilityOff ( )
virtual

Set/Get visibility of the axis major tick marks.

virtual void vtkAxisActor::SetLabelVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis labels.

virtual vtkTypeBool vtkAxisActor::GetLabelVisibility ( )
virtual

Set/Get visibility of the axis labels.

virtual void vtkAxisActor::LabelVisibilityOn ( )
virtual

Set/Get visibility of the axis labels.

virtual void vtkAxisActor::LabelVisibilityOff ( )
virtual

Set/Get visibility of the axis labels.

virtual void vtkAxisActor::SetTitleVisibility ( vtkTypeBool  )
virtual

Set/Get visibility of the axis title.

virtual vtkTypeBool vtkAxisActor::GetTitleVisibility ( )
virtual

Set/Get visibility of the axis title.

virtual void vtkAxisActor::TitleVisibilityOn ( )
virtual

Set/Get visibility of the axis title.

virtual void vtkAxisActor::TitleVisibilityOff ( )
virtual

Set/Get visibility of the axis title.

virtual void vtkAxisActor::SetExponentVisibility ( bool  )
virtual

Set/Get visibility of the axis detached exponent.

virtual bool vtkAxisActor::GetExponentVisibility ( )
virtual

Set/Get visibility of the axis detached exponent.

virtual void vtkAxisActor::ExponentVisibilityOn ( )
virtual

Set/Get visibility of the axis detached exponent.

virtual void vtkAxisActor::ExponentVisibilityOff ( )
virtual

Set/Get visibility of the axis detached exponent.

virtual void vtkAxisActor::SetLastMajorTickPointCorrection ( bool  )
virtual

Set/Get visibility of the axis detached exponent.

virtual bool vtkAxisActor::GetLastMajorTickPointCorrection ( )
virtual

Set/Get visibility of the axis detached exponent.

virtual void vtkAxisActor::LastMajorTickPointCorrectionOn ( )
virtual

Set/Get visibility of the axis detached exponent.

virtual void vtkAxisActor::LastMajorTickPointCorrectionOff ( )
virtual

Set/Get visibility of the axis detached exponent.

virtual void vtkAxisActor::SetTitleAlignLocation ( int  location)
virtual

Get/Set the alignment of the title related to the axis.

Possible Alignment: VTK_ALIGN_TOP, VTK_ALIGN_BOTTOM, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2

virtual int vtkAxisActor::GetTitleAlignLocation ( )
virtual

Get/Set the alignment of the title related to the axis.

Possible Alignment: VTK_ALIGN_TOP, VTK_ALIGN_BOTTOM, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2

virtual void vtkAxisActor::SetExponentLocation ( int  location)
virtual

Get/Set the location of the Detached Exponent related to the axis.

Possible Location: VTK_ALIGN_TOP, VTK_ALIGN_BOTTOM, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2

virtual int vtkAxisActor::GetExponentLocation ( )
virtual

Get/Set the location of the Detached Exponent related to the axis.

Possible Location: VTK_ALIGN_TOP, VTK_ALIGN_BOTTOM, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2

virtual void vtkAxisActor::SetTitleTextProperty ( vtkTextProperty p)
virtual

Set/Get the axis title text property.

virtual vtkTextProperty* vtkAxisActor::GetTitleTextProperty ( )
virtual

Set/Get the axis title text property.

virtual void vtkAxisActor::SetLabelTextProperty ( vtkTextProperty p)
virtual

Set/Get the axis labels text property.

virtual vtkTextProperty* vtkAxisActor::GetLabelTextProperty ( )
virtual

Set/Get the axis labels text property.

void vtkAxisActor::SetAxisLinesProperty ( vtkProperty )

Get/Set axis actor property (axis and its ticks) (kept for compatibility)

vtkProperty* vtkAxisActor::GetAxisLinesProperty ( )

Get/Set axis actor property (axis and its ticks) (kept for compatibility)

void vtkAxisActor::SetAxisMainLineProperty ( vtkProperty )

Get/Set main line axis actor property.

vtkProperty* vtkAxisActor::GetAxisMainLineProperty ( )

Get/Set main line axis actor property.

void vtkAxisActor::SetAxisMajorTicksProperty ( vtkProperty )

Get/Set axis actor property (axis and its ticks)

vtkProperty* vtkAxisActor::GetAxisMajorTicksProperty ( )

Get/Set axis actor property (axis and its ticks)

void vtkAxisActor::SetAxisMinorTicksProperty ( vtkProperty )

Get/Set axis actor property (axis and its ticks)

vtkProperty* vtkAxisActor::GetAxisMinorTicksProperty ( )

Get/Set axis actor property (axis and its ticks)

void vtkAxisActor::SetGridlinesProperty ( vtkProperty )

Get/Set gridlines actor property (outer grid lines)

vtkProperty* vtkAxisActor::GetGridlinesProperty ( )

Get/Set gridlines actor property (outer grid lines)

void vtkAxisActor::SetInnerGridlinesProperty ( vtkProperty )

Get/Set inner gridlines actor property.

vtkProperty* vtkAxisActor::GetInnerGridlinesProperty ( )

Get/Set inner gridlines actor property.

void vtkAxisActor::SetGridpolysProperty ( vtkProperty )

Get/Set gridPolys actor property (grid quads)

vtkProperty* vtkAxisActor::GetGridpolysProperty ( )

Get/Set gridPolys actor property (grid quads)

virtual void vtkAxisActor::SetDrawGridlines ( vtkTypeBool  )
virtual

Set/Get whether gridlines should be drawn.

virtual vtkTypeBool vtkAxisActor::GetDrawGridlines ( )
virtual

Set/Get whether gridlines should be drawn.

virtual void vtkAxisActor::DrawGridlinesOn ( )
virtual

Set/Get whether gridlines should be drawn.

virtual void vtkAxisActor::DrawGridlinesOff ( )
virtual

Set/Get whether gridlines should be drawn.

virtual void vtkAxisActor::SetDrawGridlinesOnly ( vtkTypeBool  )
virtual

Set/Get whether ONLY the gridlines should be drawn.

This will only draw GridLines and will skip any other part of the rendering such as Axis/Tick/Title/...

virtual vtkTypeBool vtkAxisActor::GetDrawGridlinesOnly ( )
virtual

Set/Get whether ONLY the gridlines should be drawn.

This will only draw GridLines and will skip any other part of the rendering such as Axis/Tick/Title/...

virtual void vtkAxisActor::DrawGridlinesOnlyOn ( )
virtual

Set/Get whether ONLY the gridlines should be drawn.

This will only draw GridLines and will skip any other part of the rendering such as Axis/Tick/Title/...

virtual void vtkAxisActor::DrawGridlinesOnlyOff ( )
virtual

Set/Get whether ONLY the gridlines should be drawn.

This will only draw GridLines and will skip any other part of the rendering such as Axis/Tick/Title/...

virtual void vtkAxisActor::SetDrawGridlinesLocation ( int  )
virtual
virtual int vtkAxisActor::GetDrawGridlinesLocation ( )
virtual
virtual void vtkAxisActor::SetDrawInnerGridlines ( vtkTypeBool  )
virtual

Set/Get whether inner gridlines should be drawn.

virtual vtkTypeBool vtkAxisActor::GetDrawInnerGridlines ( )
virtual

Set/Get whether inner gridlines should be drawn.

virtual void vtkAxisActor::DrawInnerGridlinesOn ( )
virtual

Set/Get whether inner gridlines should be drawn.

virtual void vtkAxisActor::DrawInnerGridlinesOff ( )
virtual

Set/Get whether inner gridlines should be drawn.

virtual void vtkAxisActor::SetGridlineXLength ( double  )
virtual

Set/Get the length to use when drawing gridlines.

virtual double vtkAxisActor::GetGridlineXLength ( )
virtual

Set/Get the length to use when drawing gridlines.

virtual void vtkAxisActor::SetGridlineYLength ( double  )
virtual

Set/Get the length to use when drawing gridlines.

virtual double vtkAxisActor::GetGridlineYLength ( )
virtual

Set/Get the length to use when drawing gridlines.

virtual void vtkAxisActor::SetGridlineZLength ( double  )
virtual

Set/Get the length to use when drawing gridlines.

virtual double vtkAxisActor::GetGridlineZLength ( )
virtual

Set/Get the length to use when drawing gridlines.

virtual void vtkAxisActor::SetDrawGridpolys ( vtkTypeBool  )
virtual

Set/Get whether gridpolys should be drawn.

virtual vtkTypeBool vtkAxisActor::GetDrawGridpolys ( )
virtual

Set/Get whether gridpolys should be drawn.

virtual void vtkAxisActor::DrawGridpolysOn ( )
virtual

Set/Get whether gridpolys should be drawn.

virtual void vtkAxisActor::DrawGridpolysOff ( )
virtual

Set/Get whether gridpolys should be drawn.

virtual void vtkAxisActor::SetAxisType ( int  )
virtual

Set/Get the type of this axis.

virtual int vtkAxisActor::GetAxisType ( )
virtual

Set/Get the type of this axis.

void vtkAxisActor::SetAxisTypeToX ( void  )
inline

Set/Get the type of this axis.

Definition at line 424 of file vtkAxisActor.h.

void vtkAxisActor::SetAxisTypeToY ( void  )
inline

Set/Get the type of this axis.

Definition at line 425 of file vtkAxisActor.h.

void vtkAxisActor::SetAxisTypeToZ ( void  )
inline

Set/Get the type of this axis.

Definition at line 426 of file vtkAxisActor.h.

virtual void vtkAxisActor::SetLog ( bool  )
virtual

Set/Get The type of scale, enable logarithmic scale or linear by default.

virtual bool vtkAxisActor::GetLog ( )
virtual

Set/Get The type of scale, enable logarithmic scale or linear by default.

virtual void vtkAxisActor::LogOn ( )
virtual

Set/Get The type of scale, enable logarithmic scale or linear by default.

virtual void vtkAxisActor::LogOff ( )
virtual

Set/Get The type of scale, enable logarithmic scale or linear by default.

virtual void vtkAxisActor::SetAxisPosition ( int  )
virtual

Set/Get the position of this axis (in relation to an an assumed bounding box).

For an x-type axis, MINMIN corresponds to the x-edge in the bounding box where Y values are minimum and Z values are minimum. For a y-type axis, MAXMIN corresponds to the y-edge where X values are maximum and Z values are minimum.

virtual int vtkAxisActor::GetAxisPosition ( )
virtual

Set/Get the position of this axis (in relation to an an assumed bounding box).

For an x-type axis, MINMIN corresponds to the x-edge in the bounding box where Y values are minimum and Z values are minimum. For a y-type axis, MAXMIN corresponds to the y-edge where X values are maximum and Z values are minimum.

void vtkAxisActor::SetAxisPositionToMinMin ( void  )
inline

Definition at line 458 of file vtkAxisActor.h.

void vtkAxisActor::SetAxisPositionToMinMax ( void  )
inline

Definition at line 459 of file vtkAxisActor.h.

void vtkAxisActor::SetAxisPositionToMaxMax ( void  )
inline

Definition at line 460 of file vtkAxisActor.h.

void vtkAxisActor::SetAxisPositionToMaxMin ( void  )
inline

Definition at line 461 of file vtkAxisActor.h.

virtual void vtkAxisActor::SetCamera ( vtkCamera )
virtual

Set/Get the camera for this axis.

The camera is used by the labels to 'follow' the camera and be legible from any viewpoint.

virtual vtkCamera* vtkAxisActor::GetCamera ( )
virtual

Set/Get the camera for this axis.

The camera is used by the labels to 'follow' the camera and be legible from any viewpoint.

int vtkAxisActor::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Draw the axis.

Reimplemented from vtkProp.

virtual int vtkAxisActor::RenderTranslucentGeometry ( vtkViewport viewport)
virtual

Draw the axis.

int vtkAxisActor::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Draw the axis.

Reimplemented from vtkProp.

int vtkAxisActor::RenderOverlay ( vtkViewport viewport)
overridevirtual

Draw the axis.

Reimplemented from vtkProp.

vtkTypeBool vtkAxisActor::HasTranslucentPolygonalGeometry ( )
overridevirtual

Draw the axis.

Reimplemented from vtkProp.

void vtkAxisActor::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.

double vtkAxisActor::ComputeMaxLabelLength ( const double  [3])
double vtkAxisActor::ComputeTitleLength ( const double  [3])
void vtkAxisActor::SetLabelScale ( const double  scale)
void vtkAxisActor::SetLabelScale ( int  labelIndex,
const double  scale 
)
void vtkAxisActor::SetTitleScale ( const double  scale)
virtual void vtkAxisActor::SetMinorStart ( double  )
virtual

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

virtual double vtkAxisActor::GetMinorStart ( )
virtual

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

double vtkAxisActor::GetMajorStart ( int  axis)

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

void vtkAxisActor::SetMajorStart ( int  axis,
double  value 
)

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

virtual void vtkAxisActor::SetDeltaMinor ( double  )
virtual

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

virtual double vtkAxisActor::GetDeltaMinor ( )
virtual

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

double vtkAxisActor::GetDeltaMajor ( int  axis)

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

void vtkAxisActor::SetDeltaMajor ( int  axis,
double  value 
)

Set/Get the starting position for minor and major tick points, and the delta values that determine their spacing.

virtual void vtkAxisActor::SetMinorRangeStart ( double  )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual double vtkAxisActor::GetMinorRangeStart ( )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual void vtkAxisActor::SetMajorRangeStart ( double  )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual double vtkAxisActor::GetMajorRangeStart ( )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual void vtkAxisActor::SetDeltaRangeMinor ( double  )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual double vtkAxisActor::GetDeltaRangeMinor ( )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual void vtkAxisActor::SetDeltaRangeMajor ( double  )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

virtual double vtkAxisActor::GetDeltaRangeMajor ( )
virtual

Set/Get the starting position for minor and major tick points on the range and the delta values that determine their spacing.

The range and the position need not be identical. ie the displayed values need not match the actual positions in 3D space.

void vtkAxisActor::SetLabels ( vtkStringArray labels)
void vtkAxisActor::BuildAxis ( vtkViewport viewport,
bool   
)
virtual vtkAxisFollower* vtkAxisActor::GetTitleActor ( )
virtual

Get title actor and it is responsible for drawing title text.

virtual vtkAxisFollower* vtkAxisActor::GetExponentActor ( )
virtual

Get exponent follower actor.

vtkAxisFollower** vtkAxisActor::GetLabelActors ( )
inline

Get label actors responsigle for drawing label text.

Definition at line 555 of file vtkAxisActor.h.

virtual vtkProp3DAxisFollower* vtkAxisActor::GetTitleProp3D ( )
virtual

Get title actor and it is responsible for drawing title text.

vtkProp3DAxisFollower** vtkAxisActor::GetLabelProps3D ( )
inline

Get label actors responsigle for drawing label text.

Definition at line 568 of file vtkAxisActor.h.

virtual vtkProp3DAxisFollower* vtkAxisActor::GetExponentProp3D ( )
virtual

Get title actor and it is responsible for drawing title text.

virtual int vtkAxisActor::GetNumberOfLabelsBuilt ( )
virtual

Get total number of labels built.

Once built this count does not change.

virtual void vtkAxisActor::SetCalculateTitleOffset ( vtkTypeBool  )
virtual

Set/Get flag whether to calculate title offset.

Default is true.

virtual vtkTypeBool vtkAxisActor::GetCalculateTitleOffset ( )
virtual

Set/Get flag whether to calculate title offset.

Default is true.

virtual void vtkAxisActor::CalculateTitleOffsetOn ( )
virtual

Set/Get flag whether to calculate title offset.

Default is true.

virtual void vtkAxisActor::CalculateTitleOffsetOff ( )
virtual

Set/Get flag whether to calculate title offset.

Default is true.

virtual void vtkAxisActor::SetCalculateLabelOffset ( vtkTypeBool  )
virtual

Set/Get flag whether to calculate label offset.

Default is true.

virtual vtkTypeBool vtkAxisActor::GetCalculateLabelOffset ( )
virtual

Set/Get flag whether to calculate label offset.

Default is true.

virtual void vtkAxisActor::CalculateLabelOffsetOn ( )
virtual

Set/Get flag whether to calculate label offset.

Default is true.

virtual void vtkAxisActor::CalculateLabelOffsetOff ( )
virtual

Set/Get flag whether to calculate label offset.

Default is true.

virtual void vtkAxisActor::SetUse2DMode ( int  )
virtual

Set/Get the 2D mode.

virtual int vtkAxisActor::GetUse2DMode ( )
virtual

Set/Get the 2D mode.

virtual void vtkAxisActor::SetVerticalOffsetXTitle2D ( double  )
virtual

Set/Get the 2D mode the vertical offset for X title in 2D mode.

virtual double vtkAxisActor::GetVerticalOffsetXTitle2D ( )
virtual

Set/Get the 2D mode the vertical offset for X title in 2D mode.

virtual void vtkAxisActor::SetHorizontalOffsetYTitle2D ( double  )
virtual

Set/Get the 2D mode the horizontal offset for Y title in 2D mode.

virtual double vtkAxisActor::GetHorizontalOffsetYTitle2D ( )
virtual

Set/Get the 2D mode the horizontal offset for Y title in 2D mode.

virtual void vtkAxisActor::SetSaveTitlePosition ( int  )
virtual

Set/Get whether title position must be saved in 2D mode.

virtual int vtkAxisActor::GetSaveTitlePosition ( )
virtual

Set/Get whether title position must be saved in 2D mode.

virtual void vtkAxisActor::SetAxisBaseForX ( double  ,
double  ,
double   
)
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::SetAxisBaseForX ( double  [3])
virtual

Provide real vector for non aligned axis.

virtual double* vtkAxisActor::GetAxisBaseForX ( )
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::GetAxisBaseForX ( double ,
double ,
double  
)
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::GetAxisBaseForX ( double  [3])
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::SetAxisBaseForY ( double  ,
double  ,
double   
)
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::SetAxisBaseForY ( double  [3])
virtual

Provide real vector for non aligned axis.

virtual double* vtkAxisActor::GetAxisBaseForY ( )
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::GetAxisBaseForY ( double ,
double ,
double  
)
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::GetAxisBaseForY ( double  [3])
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::SetAxisBaseForZ ( double  ,
double  ,
double   
)
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::SetAxisBaseForZ ( double  [3])
virtual

Provide real vector for non aligned axis.

virtual double* vtkAxisActor::GetAxisBaseForZ ( )
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::GetAxisBaseForZ ( double ,
double ,
double  
)
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::GetAxisBaseForZ ( double  [3])
virtual

Provide real vector for non aligned axis.

virtual void vtkAxisActor::SetAxisOnOrigin ( int  )
virtual

Notify the axes that is not part of a cube anymore.

virtual int vtkAxisActor::GetAxisOnOrigin ( )
virtual

Notify the axes that is not part of a cube anymore.

virtual void vtkAxisActor::SetLabelOffset ( double  )
virtual

Set/Get the offsets used to position texts.

virtual double vtkAxisActor::GetLabelOffset ( )
virtual

Set/Get the offsets used to position texts.

virtual void vtkAxisActor::SetTitleOffset ( double  )
virtual

Set/Get the offsets used to position texts.

virtual double vtkAxisActor::GetTitleOffset ( )
virtual

Set/Get the offsets used to position texts.

virtual void vtkAxisActor::SetExponentOffset ( double  )
virtual

Set/Get the offsets used to position texts.

virtual double vtkAxisActor::GetExponentOffset ( )
virtual

Set/Get the offsets used to position texts.

virtual void vtkAxisActor::SetScreenSize ( double  )
virtual

Set/Get the offsets used to position texts.

virtual double vtkAxisActor::GetScreenSize ( )
virtual

Set/Get the offsets used to position texts.

Member Data Documentation

char* vtkAxisActor::Title
protected

Definition at line 688 of file vtkAxisActor.h.

char* vtkAxisActor::Exponent
protected

Definition at line 689 of file vtkAxisActor.h.

double vtkAxisActor::Range[2]
protected

Definition at line 690 of file vtkAxisActor.h.

double vtkAxisActor::LastRange[2]
protected

Definition at line 691 of file vtkAxisActor.h.

char* vtkAxisActor::LabelFormat
protected

Definition at line 692 of file vtkAxisActor.h.

int vtkAxisActor::UseTextActor3D
protected

Definition at line 693 of file vtkAxisActor.h.

int vtkAxisActor::NumberOfLabelsBuilt
protected

Definition at line 694 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::MinorTicksVisible
protected

Definition at line 695 of file vtkAxisActor.h.

int vtkAxisActor::LastMinorTicksVisible
protected

Definition at line 696 of file vtkAxisActor.h.

The location of the ticks.

Inside: tick end toward positive direction of perpendicular axes. Outside: tick end toward negative direction of perpendicular axes.

Definition at line 703 of file vtkAxisActor.h.

int vtkAxisActor::TitleAlignLocation
protected

Hold the alignment property of the title related to the axis.

Possible Alignment: VTK_ALIGN_BOTTOM, VTK_ALIGN_TOP, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2.

Definition at line 709 of file vtkAxisActor.h.

int vtkAxisActor::ExponentLocation
protected

Hold the alignment property of the exponent coming from the label values.

Possible Alignment: VTK_ALIGN_BOTTOM, VTK_ALIGN_TOP, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2.

Definition at line 715 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::DrawGridlines
protected

Definition at line 717 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::DrawGridlinesOnly
protected

Definition at line 718 of file vtkAxisActor.h.

int vtkAxisActor::LastDrawGridlines
protected

Definition at line 719 of file vtkAxisActor.h.

int vtkAxisActor::DrawGridlinesLocation
protected

Definition at line 720 of file vtkAxisActor.h.

int vtkAxisActor::LastDrawGridlinesLocation
protected

Definition at line 721 of file vtkAxisActor.h.

double vtkAxisActor::GridlineXLength
protected

Definition at line 722 of file vtkAxisActor.h.

double vtkAxisActor::GridlineYLength
protected

Definition at line 723 of file vtkAxisActor.h.

double vtkAxisActor::GridlineZLength
protected

Definition at line 724 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::DrawInnerGridlines
protected

Definition at line 726 of file vtkAxisActor.h.

int vtkAxisActor::LastDrawInnerGridlines
protected

Definition at line 727 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::DrawGridpolys
protected

Definition at line 729 of file vtkAxisActor.h.

int vtkAxisActor::LastDrawGridpolys
protected

Definition at line 730 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::AxisVisibility
protected

Definition at line 732 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::TickVisibility
protected

Definition at line 733 of file vtkAxisActor.h.

int vtkAxisActor::LastTickVisibility
protected

Definition at line 734 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::LabelVisibility
protected

Definition at line 735 of file vtkAxisActor.h.

vtkTypeBool vtkAxisActor::TitleVisibility
protected

Definition at line 736 of file vtkAxisActor.h.

bool vtkAxisActor::ExponentVisibility
protected

Definition at line 737 of file vtkAxisActor.h.

bool vtkAxisActor::LastMajorTickPointCorrection
protected

Definition at line 738 of file vtkAxisActor.h.

bool vtkAxisActor::Log
protected

Definition at line 740 of file vtkAxisActor.h.

Definition at line 741 of file vtkAxisActor.h.

Definition at line 742 of file vtkAxisActor.h.

double vtkAxisActor::AxisBaseForX[3]
protected

Definition at line 745 of file vtkAxisActor.h.

double vtkAxisActor::AxisBaseForY[3]
protected

Definition at line 746 of file vtkAxisActor.h.

double vtkAxisActor::AxisBaseForZ[3]
protected

Definition at line 747 of file vtkAxisActor.h.


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