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

a 3D axes representation More...

#include <vtkAxesActor.h>

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

Public Types

enum  { CYLINDER_SHAFT, LINE_SHAFT, USER_DEFINED_SHAFT }
 
enum  { CONE_TIP, SPHERE_TIP, USER_DEFINED_TIP }
 
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...
 
vtkAxesActorNewInstance () 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...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
int RenderOverlay (vtkViewport *viewport) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some translucent polygonal geometry? More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of an axes actor. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor. More...
 
void GetBounds (double bounds[6])
 Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
double * GetBounds () override
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). 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...
 
void SetTotalLength (double v[3])
 Set the total length of the axes in 3 dimensions. More...
 
void SetTotalLength (double x, double y, double z)
 
virtual double * GetTotalLength ()
 
virtual void GetTotalLength (double data[3])
 
void SetNormalizedShaftLength (double v[3])
 Set the normalized (0-1) length of the shaft. More...
 
void SetNormalizedShaftLength (double x, double y, double z)
 
virtual double * GetNormalizedShaftLength ()
 
virtual void GetNormalizedShaftLength (double data[3])
 
void SetNormalizedTipLength (double v[3])
 Set the normalized (0-1) length of the tip. More...
 
void SetNormalizedTipLength (double x, double y, double z)
 
virtual double * GetNormalizedTipLength ()
 
virtual void GetNormalizedTipLength (double data[3])
 
void SetNormalizedLabelPosition (double v[3])
 Set the normalized (0-1) position of the label along the length of the shaft. More...
 
void SetNormalizedLabelPosition (double x, double y, double z)
 
virtual double * GetNormalizedLabelPosition ()
 
virtual void GetNormalizedLabelPosition (double data[3])
 
virtual void SetConeResolution (int)
 Set/get the resolution of the pieces of the axes actor. More...
 
virtual int GetConeResolution ()
 
virtual void SetSphereResolution (int)
 
virtual int GetSphereResolution ()
 
virtual void SetCylinderResolution (int)
 
virtual int GetCylinderResolution ()
 
virtual void SetConeRadius (double)
 Set/get the radius of the pieces of the axes actor. More...
 
virtual double GetConeRadius ()
 
virtual void SetSphereRadius (double)
 
virtual double GetSphereRadius ()
 
virtual void SetCylinderRadius (double)
 
virtual double GetCylinderRadius ()
 
void SetShaftType (int type)
 Set the type of the shaft to a cylinder, line, or user defined geometry. More...
 
void SetShaftTypeToCylinder ()
 
void SetShaftTypeToLine ()
 
void SetShaftTypeToUserDefined ()
 
virtual int GetShaftType ()
 
void SetTipType (int type)
 Set the type of the tip to a cone, sphere, or user defined geometry. More...
 
void SetTipTypeToCone ()
 
void SetTipTypeToSphere ()
 
void SetTipTypeToUserDefined ()
 
virtual int GetTipType ()
 
void SetUserDefinedTip (vtkPolyData *)
 Set the user defined tip polydata. More...
 
virtual vtkPolyDataGetUserDefinedTip ()
 
void SetUserDefinedShaft (vtkPolyData *)
 Set the user defined shaft polydata. More...
 
virtual vtkPolyDataGetUserDefinedShaft ()
 
vtkPropertyGetXAxisTipProperty ()
 Get the tip properties. More...
 
vtkPropertyGetYAxisTipProperty ()
 
vtkPropertyGetZAxisTipProperty ()
 
vtkPropertyGetXAxisShaftProperty ()
 Get the shaft properties. More...
 
vtkPropertyGetYAxisShaftProperty ()
 
vtkPropertyGetZAxisShaftProperty ()
 
vtkCaptionActor2DGetXAxisCaptionActor2D ()
 Retrieve handles to the X, Y and Z axis (so that you can set their text properties for example) More...
 
vtkCaptionActor2DGetYAxisCaptionActor2D ()
 
vtkCaptionActor2DGetZAxisCaptionActor2D ()
 
virtual void SetXAxisLabelText (const char *)
 Set/get the label text. More...
 
virtual char * GetXAxisLabelText ()
 
virtual void SetYAxisLabelText (const char *)
 
virtual char * GetYAxisLabelText ()
 
virtual void SetZAxisLabelText (const char *)
 
virtual char * GetZAxisLabelText ()
 
virtual void SetAxisLabels (vtkTypeBool)
 Enable/disable drawing the axis labels. More...
 
virtual vtkTypeBool GetAxisLabels ()
 
virtual void AxisLabelsOn ()
 
virtual void AxisLabelsOff ()
 
- 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 x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates. More...
 
virtual void SetPosition (double pos[3])
 
virtual double * GetPosition ()
 
virtual void GetPosition (double data[3])
 
void AddPosition (double deltaPosition[3])
 
void AddPosition (double deltaX, double deltaY, double deltaZ)
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D. More...
 
virtual void SetOrigin (const double pos[3])
 
virtual double * GetOrigin ()
 
virtual void GetOrigin (double data[3])
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor. More...
 
virtual void SetScale (double scale[3])
 
virtual double * GetScale ()
 
virtual void GetScale (double data[3])
 
void SetScale (double s)
 Method to set the scale isotropically. 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 ()
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform. More...
 
vtkMatrix4x4GetUserMatrix ()
 
virtual void GetMatrix (vtkMatrix4x4 *m)
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
virtual void GetMatrix (double m[16])
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform. More...
 
double * GetCenter ()
 Get the center of the bounding box in world coordinates. More...
 
double * GetXRange ()
 Get the Prop3D's x range in world coordinates. More...
 
double * GetYRange ()
 Get the Prop3D's y range in world coordinates. More...
 
double * GetZRange ()
 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...
 
double * GetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
void GetOrientation (double orentation[3])
 
double * GetOrientationWXYZ ()
 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...
 
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 SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
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 ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
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 vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
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...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual 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)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkAxesActorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAxesActorSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkAxesActor ()
 
 ~vtkAxesActor () override
 
void UpdateProps ()
 
- 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 ()
 
- 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

vtkCylinderSourceCylinderSource
 
vtkLineSourceLineSource
 
vtkConeSourceConeSource
 
vtkSphereSourceSphereSource
 
vtkActorXAxisShaft
 
vtkActorYAxisShaft
 
vtkActorZAxisShaft
 
vtkActorXAxisTip
 
vtkActorYAxisTip
 
vtkActorZAxisTip
 
double TotalLength [3]
 
double NormalizedShaftLength [3]
 
double NormalizedTipLength [3]
 
double NormalizedLabelPosition [3]
 
int ShaftType
 
int TipType
 
vtkPolyDataUserDefinedTip
 
vtkPolyDataUserDefinedShaft
 
char * XAxisLabelText
 
char * YAxisLabelText
 
char * ZAxisLabelText
 
vtkCaptionActor2DXAxisLabel
 
vtkCaptionActor2DYAxisLabel
 
vtkCaptionActor2DZAxisLabel
 
vtkTypeBool AxisLabels
 
int ConeResolution
 
int SphereResolution
 
int CylinderResolution
 
double ConeRadius
 
double SphereRadius
 
double CylinderRadius
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a 3D axes representation

vtkAxesActor is a hybrid 2D/3D actor used to represent 3D axes in a scene. The user can define the geometry to use for the shaft or the tip, and the user can set the text for the three axes. The text will appear to follow the camera since it is implemented by means of vtkCaptionActor2D. All of the functionality of the underlying vtkCaptionActor2D objects are accessible so that, for instance, the font attributes of the axes text can be manipulated through vtkTextProperty. Since this class inherits from vtkProp3D, one can apply a user transform to the underlying geometry and the positioning of the labels. For example, a rotation transform could be used to generate a left-handed axes representation.

Thanks:
Thanks to Goodwin Lawlor for posting a tcl script which featured the use of vtkCaptionActor2D to implement the text labels. This class is based on Paraview's vtkPVAxesActor.
Warning
vtkAxesActor is primarily intended for use with vtkOrientationMarkerWidget. The bounds of this actor are calculated as though the geometry of the axes were symmetric: that is, although only positive axes are visible, bounds are calculated as though negative axes are present too. This is done intentionally to implement functionality of the camera update mechanism in vtkOrientationMarkerWidget.
See also
vtkAnnotatedCubeActor vtkOrientationMarkerWidget vtkCaptionActor2D vtkTextProperty

Definition at line 65 of file vtkAxesActor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 69 of file vtkAxesActor.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CYLINDER_SHAFT 
LINE_SHAFT 
USER_DEFINED_SHAFT 

Definition at line 277 of file vtkAxesActor.h.

◆ anonymous enum

anonymous enum
Enumerator
CONE_TIP 
SPHERE_TIP 
USER_DEFINED_TIP 

Definition at line 284 of file vtkAxesActor.h.

Constructor & Destructor Documentation

◆ vtkAxesActor()

vtkAxesActor::vtkAxesActor ( )
protected

◆ ~vtkAxesActor()

vtkAxesActor::~vtkAxesActor ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkAxesActor* vtkAxesActor::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAxesActor::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 vtkProp3D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAxesActor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProp3D.

◆ NewInstance()

vtkAxesActor* vtkAxesActor::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetActors()

void vtkAxesActor::GetActors ( vtkPropCollection )
overridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkAxesActor::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkAxesActor::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkAxesActor::RenderOverlay ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkAxesActor::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

◆ ShallowCopy()

void vtkAxesActor::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of an axes actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

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

◆ GetBounds() [1/2]

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

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

(The method GetBounds(double bounds[6]) is available from the superclass.)

◆ GetBounds() [2/2]

double* vtkAxesActor::GetBounds ( void  )
overridevirtual

Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

in world coordinates. NULL means that the bounds are not defined.

Implements vtkProp3D.

◆ GetMTime()

vtkMTimeType vtkAxesActor::GetMTime ( )
overridevirtual

Get the actors mtime plus consider its properties and texture if set.

Reimplemented from vtkObject.

◆ GetRedrawMTime()

vtkMTimeType vtkAxesActor::GetRedrawMTime ( )
overridevirtual

Return the mtime of anything that would cause the rendered image to appear differently.

Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, textures etc.

Reimplemented from vtkProp.

◆ SetTotalLength() [1/2]

void vtkAxesActor::SetTotalLength ( double  v[3])
inline

Set the total length of the axes in 3 dimensions.

Definition at line 131 of file vtkAxesActor.h.

◆ SetTotalLength() [2/2]

void vtkAxesActor::SetTotalLength ( double  x,
double  y,
double  z 
)

◆ GetTotalLength() [1/2]

virtual double* vtkAxesActor::GetTotalLength ( )
virtual

◆ GetTotalLength() [2/2]

virtual void vtkAxesActor::GetTotalLength ( double  data[3])
virtual

◆ SetNormalizedShaftLength() [1/2]

void vtkAxesActor::SetNormalizedShaftLength ( double  v[3])
inline

Set the normalized (0-1) length of the shaft.

Definition at line 140 of file vtkAxesActor.h.

◆ SetNormalizedShaftLength() [2/2]

void vtkAxesActor::SetNormalizedShaftLength ( double  x,
double  y,
double  z 
)

◆ GetNormalizedShaftLength() [1/2]

virtual double* vtkAxesActor::GetNormalizedShaftLength ( )
virtual

◆ GetNormalizedShaftLength() [2/2]

virtual void vtkAxesActor::GetNormalizedShaftLength ( double  data[3])
virtual

◆ SetNormalizedTipLength() [1/2]

void vtkAxesActor::SetNormalizedTipLength ( double  v[3])
inline

Set the normalized (0-1) length of the tip.

Normally, this would be 1 - the normalized length of the shaft.

Definition at line 150 of file vtkAxesActor.h.

◆ SetNormalizedTipLength() [2/2]

void vtkAxesActor::SetNormalizedTipLength ( double  x,
double  y,
double  z 
)

◆ GetNormalizedTipLength() [1/2]

virtual double* vtkAxesActor::GetNormalizedTipLength ( )
virtual

◆ GetNormalizedTipLength() [2/2]

virtual void vtkAxesActor::GetNormalizedTipLength ( double  data[3])
virtual

◆ SetNormalizedLabelPosition() [1/2]

void vtkAxesActor::SetNormalizedLabelPosition ( double  v[3])
inline

Set the normalized (0-1) position of the label along the length of the shaft.

A value > 1 is permissible.

Definition at line 160 of file vtkAxesActor.h.

◆ SetNormalizedLabelPosition() [2/2]

void vtkAxesActor::SetNormalizedLabelPosition ( double  x,
double  y,
double  z 
)

◆ GetNormalizedLabelPosition() [1/2]

virtual double* vtkAxesActor::GetNormalizedLabelPosition ( )
virtual

◆ GetNormalizedLabelPosition() [2/2]

virtual void vtkAxesActor::GetNormalizedLabelPosition ( double  data[3])
virtual

◆ SetConeResolution()

virtual void vtkAxesActor::SetConeResolution ( int  )
virtual

Set/get the resolution of the pieces of the axes actor.

◆ GetConeResolution()

virtual int vtkAxesActor::GetConeResolution ( )
virtual

◆ SetSphereResolution()

virtual void vtkAxesActor::SetSphereResolution ( int  )
virtual

◆ GetSphereResolution()

virtual int vtkAxesActor::GetSphereResolution ( )
virtual

◆ SetCylinderResolution()

virtual void vtkAxesActor::SetCylinderResolution ( int  )
virtual

◆ GetCylinderResolution()

virtual int vtkAxesActor::GetCylinderResolution ( )
virtual

◆ SetConeRadius()

virtual void vtkAxesActor::SetConeRadius ( double  )
virtual

Set/get the radius of the pieces of the axes actor.

◆ GetConeRadius()

virtual double vtkAxesActor::GetConeRadius ( )
virtual

◆ SetSphereRadius()

virtual void vtkAxesActor::SetSphereRadius ( double  )
virtual

◆ GetSphereRadius()

virtual double vtkAxesActor::GetSphereRadius ( )
virtual

◆ SetCylinderRadius()

virtual void vtkAxesActor::SetCylinderRadius ( double  )
virtual

◆ GetCylinderRadius()

virtual double vtkAxesActor::GetCylinderRadius ( )
virtual

◆ SetShaftType()

void vtkAxesActor::SetShaftType ( int  type)

Set the type of the shaft to a cylinder, line, or user defined geometry.

◆ SetShaftTypeToCylinder()

void vtkAxesActor::SetShaftTypeToCylinder ( )
inline

Definition at line 197 of file vtkAxesActor.h.

◆ SetShaftTypeToLine()

void vtkAxesActor::SetShaftTypeToLine ( )
inline

Definition at line 198 of file vtkAxesActor.h.

◆ SetShaftTypeToUserDefined()

void vtkAxesActor::SetShaftTypeToUserDefined ( )
inline

Definition at line 199 of file vtkAxesActor.h.

◆ GetShaftType()

virtual int vtkAxesActor::GetShaftType ( )
virtual

◆ SetTipType()

void vtkAxesActor::SetTipType ( int  type)

Set the type of the tip to a cone, sphere, or user defined geometry.

◆ SetTipTypeToCone()

void vtkAxesActor::SetTipTypeToCone ( )
inline

Definition at line 208 of file vtkAxesActor.h.

◆ SetTipTypeToSphere()

void vtkAxesActor::SetTipTypeToSphere ( )
inline

Definition at line 209 of file vtkAxesActor.h.

◆ SetTipTypeToUserDefined()

void vtkAxesActor::SetTipTypeToUserDefined ( )
inline

Definition at line 210 of file vtkAxesActor.h.

◆ GetTipType()

virtual int vtkAxesActor::GetTipType ( )
virtual

◆ SetUserDefinedTip()

void vtkAxesActor::SetUserDefinedTip ( vtkPolyData )

Set the user defined tip polydata.

◆ GetUserDefinedTip()

virtual vtkPolyData* vtkAxesActor::GetUserDefinedTip ( )
virtual

◆ SetUserDefinedShaft()

void vtkAxesActor::SetUserDefinedShaft ( vtkPolyData )

Set the user defined shaft polydata.

◆ GetUserDefinedShaft()

virtual vtkPolyData* vtkAxesActor::GetUserDefinedShaft ( )
virtual

◆ GetXAxisTipProperty()

vtkProperty* vtkAxesActor::GetXAxisTipProperty ( )

Get the tip properties.

◆ GetYAxisTipProperty()

vtkProperty* vtkAxesActor::GetYAxisTipProperty ( )

◆ GetZAxisTipProperty()

vtkProperty* vtkAxesActor::GetZAxisTipProperty ( )

◆ GetXAxisShaftProperty()

vtkProperty* vtkAxesActor::GetXAxisShaftProperty ( )

Get the shaft properties.

◆ GetYAxisShaftProperty()

vtkProperty* vtkAxesActor::GetYAxisShaftProperty ( )

◆ GetZAxisShaftProperty()

vtkProperty* vtkAxesActor::GetZAxisShaftProperty ( )

◆ GetXAxisCaptionActor2D()

vtkCaptionActor2D* vtkAxesActor::GetXAxisCaptionActor2D ( )
inline

Retrieve handles to the X, Y and Z axis (so that you can set their text properties for example)

Definition at line 252 of file vtkAxesActor.h.

◆ GetYAxisCaptionActor2D()

vtkCaptionActor2D* vtkAxesActor::GetYAxisCaptionActor2D ( )
inline

Definition at line 253 of file vtkAxesActor.h.

◆ GetZAxisCaptionActor2D()

vtkCaptionActor2D* vtkAxesActor::GetZAxisCaptionActor2D ( )
inline

Definition at line 254 of file vtkAxesActor.h.

◆ SetXAxisLabelText()

virtual void vtkAxesActor::SetXAxisLabelText ( const char *  )
virtual

Set/get the label text.

◆ GetXAxisLabelText()

virtual char* vtkAxesActor::GetXAxisLabelText ( )
virtual

◆ SetYAxisLabelText()

virtual void vtkAxesActor::SetYAxisLabelText ( const char *  )
virtual

◆ GetYAxisLabelText()

virtual char* vtkAxesActor::GetYAxisLabelText ( )
virtual

◆ SetZAxisLabelText()

virtual void vtkAxesActor::SetZAxisLabelText ( const char *  )
virtual

◆ GetZAxisLabelText()

virtual char* vtkAxesActor::GetZAxisLabelText ( )
virtual

◆ SetAxisLabels()

virtual void vtkAxesActor::SetAxisLabels ( vtkTypeBool  )
virtual

Enable/disable drawing the axis labels.

◆ GetAxisLabels()

virtual vtkTypeBool vtkAxesActor::GetAxisLabels ( )
virtual

◆ AxisLabelsOn()

virtual void vtkAxesActor::AxisLabelsOn ( )
virtual

◆ AxisLabelsOff()

virtual void vtkAxesActor::AxisLabelsOff ( )
virtual

◆ UpdateProps()

void vtkAxesActor::UpdateProps ( )
protected

Member Data Documentation

◆ CylinderSource

vtkCylinderSource* vtkAxesActor::CylinderSource
protected

Definition at line 295 of file vtkAxesActor.h.

◆ LineSource

vtkLineSource* vtkAxesActor::LineSource
protected

Definition at line 296 of file vtkAxesActor.h.

◆ ConeSource

vtkConeSource* vtkAxesActor::ConeSource
protected

Definition at line 297 of file vtkAxesActor.h.

◆ SphereSource

vtkSphereSource* vtkAxesActor::SphereSource
protected

Definition at line 298 of file vtkAxesActor.h.

◆ XAxisShaft

vtkActor* vtkAxesActor::XAxisShaft
protected

Definition at line 300 of file vtkAxesActor.h.

◆ YAxisShaft

vtkActor* vtkAxesActor::YAxisShaft
protected

Definition at line 301 of file vtkAxesActor.h.

◆ ZAxisShaft

vtkActor* vtkAxesActor::ZAxisShaft
protected

Definition at line 302 of file vtkAxesActor.h.

◆ XAxisTip

vtkActor* vtkAxesActor::XAxisTip
protected

Definition at line 304 of file vtkAxesActor.h.

◆ YAxisTip

vtkActor* vtkAxesActor::YAxisTip
protected

Definition at line 305 of file vtkAxesActor.h.

◆ ZAxisTip

vtkActor* vtkAxesActor::ZAxisTip
protected

Definition at line 306 of file vtkAxesActor.h.

◆ TotalLength

double vtkAxesActor::TotalLength[3]
protected

Definition at line 310 of file vtkAxesActor.h.

◆ NormalizedShaftLength

double vtkAxesActor::NormalizedShaftLength[3]
protected

Definition at line 311 of file vtkAxesActor.h.

◆ NormalizedTipLength

double vtkAxesActor::NormalizedTipLength[3]
protected

Definition at line 312 of file vtkAxesActor.h.

◆ NormalizedLabelPosition

double vtkAxesActor::NormalizedLabelPosition[3]
protected

Definition at line 313 of file vtkAxesActor.h.

◆ ShaftType

int vtkAxesActor::ShaftType
protected

Definition at line 315 of file vtkAxesActor.h.

◆ TipType

int vtkAxesActor::TipType
protected

Definition at line 316 of file vtkAxesActor.h.

◆ UserDefinedTip

vtkPolyData* vtkAxesActor::UserDefinedTip
protected

Definition at line 318 of file vtkAxesActor.h.

◆ UserDefinedShaft

vtkPolyData* vtkAxesActor::UserDefinedShaft
protected

Definition at line 319 of file vtkAxesActor.h.

◆ XAxisLabelText

char* vtkAxesActor::XAxisLabelText
protected

Definition at line 321 of file vtkAxesActor.h.

◆ YAxisLabelText

char* vtkAxesActor::YAxisLabelText
protected

Definition at line 322 of file vtkAxesActor.h.

◆ ZAxisLabelText

char* vtkAxesActor::ZAxisLabelText
protected

Definition at line 323 of file vtkAxesActor.h.

◆ XAxisLabel

vtkCaptionActor2D* vtkAxesActor::XAxisLabel
protected

Definition at line 325 of file vtkAxesActor.h.

◆ YAxisLabel

vtkCaptionActor2D* vtkAxesActor::YAxisLabel
protected

Definition at line 326 of file vtkAxesActor.h.

◆ ZAxisLabel

vtkCaptionActor2D* vtkAxesActor::ZAxisLabel
protected

Definition at line 327 of file vtkAxesActor.h.

◆ AxisLabels

vtkTypeBool vtkAxesActor::AxisLabels
protected

Definition at line 329 of file vtkAxesActor.h.

◆ ConeResolution

int vtkAxesActor::ConeResolution
protected

Definition at line 331 of file vtkAxesActor.h.

◆ SphereResolution

int vtkAxesActor::SphereResolution
protected

Definition at line 332 of file vtkAxesActor.h.

◆ CylinderResolution

int vtkAxesActor::CylinderResolution
protected

Definition at line 333 of file vtkAxesActor.h.

◆ ConeRadius

double vtkAxesActor::ConeRadius
protected

Definition at line 335 of file vtkAxesActor.h.

◆ SphereRadius

double vtkAxesActor::SphereRadius
protected

Definition at line 336 of file vtkAxesActor.h.

◆ CylinderRadius

double vtkAxesActor::CylinderRadius
protected

Definition at line 337 of file vtkAxesActor.h.


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