vtkAxesActor Class Reference

#include <vtkAxesActor.h>

Inheritance diagram for vtkAxesActor:

Inheritance graph
[legend]
Collaboration diagram for vtkAxesActor:

Collaboration graph
[legend]

List of all members.


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 accessable 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
Examples:
vtkAxesActor (Examples)
Tests:
vtkAxesActor (Tests)

Definition at line 69 of file vtkAxesActor.h.


Public Types

enum  { CYLINDER_SHAFT, LINE_SHAFT, USER_DEFINED_SHAFT }
enum  { CONE_TIP, SPHERE_TIP, USER_DEFINED_TIP }
typedef vtkProp3D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void GetActors (vtkPropCollection *)
virtual int HasTranslucentPolygonalGeometry ()
void ShallowCopy (vtkProp *prop)
void ReleaseGraphicsResources (vtkWindow *)
unsigned long int GetMTime ()
virtual unsigned long GetRedrawMTime ()
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
virtual int RenderOverlay (vtkViewport *viewport)
void GetBounds (double bounds[6])
double * GetBounds ()
void SetTotalLength (double v[3])
void SetTotalLength (double x, double y, double z)
virtual double * GetTotalLength ()
virtual void GetTotalLength (double data[3])
void SetNormalizedShaftLength (double v[3])
void SetNormalizedShaftLength (double x, double y, double z)
virtual double * GetNormalizedShaftLength ()
virtual void GetNormalizedShaftLength (double data[3])
void SetNormalizedTipLength (double v[3])
void SetNormalizedTipLength (double x, double y, double z)
virtual double * GetNormalizedTipLength ()
virtual void GetNormalizedTipLength (double data[3])
void SetNormalizedLabelPosition (double v[3])
void SetNormalizedLabelPosition (double x, double y, double z)
virtual double * GetNormalizedLabelPosition ()
virtual void GetNormalizedLabelPosition (double data[3])
virtual void SetConeResolution (int)
virtual int GetConeResolution ()
virtual void SetSphereResolution (int)
virtual int GetSphereResolution ()
virtual void SetCylinderResolution (int)
virtual int GetCylinderResolution ()
virtual void SetConeRadius (double)
virtual double GetConeRadius ()
virtual void SetSphereRadius (double)
virtual double GetSphereRadius ()
virtual void SetCylinderRadius (double)
virtual double GetCylinderRadius ()
void SetShaftType (int type)
void SetShaftTypeToCylinder ()
void SetShaftTypeToLine ()
void SetShaftTypeToUserDefined ()
virtual int GetShaftType ()
void SetTipType (int type)
void SetTipTypeToCone ()
void SetTipTypeToSphere ()
void SetTipTypeToUserDefined ()
virtual int GetTipType ()
void SetUserDefinedTip (vtkPolyData *)
virtual vtkPolyDataGetUserDefinedTip ()
void SetUserDefinedShaft (vtkPolyData *)
virtual vtkPolyDataGetUserDefinedShaft ()
vtkPropertyGetXAxisTipProperty ()
vtkPropertyGetYAxisTipProperty ()
vtkPropertyGetZAxisTipProperty ()
vtkPropertyGetXAxisShaftProperty ()
vtkPropertyGetYAxisShaftProperty ()
vtkPropertyGetZAxisShaftProperty ()
vtkCaptionActor2DGetXAxisCaptionActor2D ()
vtkCaptionActor2DGetYAxisCaptionActor2D ()
vtkCaptionActor2DGetZAxisCaptionActor2D ()
virtual void SetXAxisLabelText (const char *)
virtual char * GetXAxisLabelText ()
virtual void SetYAxisLabelText (const char *)
virtual char * GetYAxisLabelText ()
virtual void SetZAxisLabelText (const char *)
virtual char * GetZAxisLabelText ()
virtual void SetAxisLabels (int)
virtual int GetAxisLabels ()
virtual void AxisLabelsOn ()
virtual void AxisLabelsOff ()

Static Public Member Functions

static vtkAxesActorNew ()
static int IsTypeOf (const char *type)
static vtkAxesActorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkAxesActor ()
 ~vtkAxesActor ()
void UpdateProps ()

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
int AxisLabels
int ConeResolution
int SphereResolution
int CylinderResolution
double ConeRadius
double SphereRadius
double CylinderRadius

Member Typedef Documentation

Reimplemented from vtkProp3D.

Definition at line 73 of file vtkAxesActor.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
CYLINDER_SHAFT 
LINE_SHAFT 
USER_DEFINED_SHAFT 

Definition at line 250 of file vtkAxesActor.h.

anonymous enum

Enumerator:
CONE_TIP 
SPHERE_TIP 
USER_DEFINED_TIP 

Definition at line 257 of file vtkAxesActor.h.


Constructor & Destructor Documentation

vtkAxesActor::vtkAxesActor (  )  [protected]

vtkAxesActor::~vtkAxesActor (  )  [protected]


Member Function Documentation

static vtkAxesActor* vtkAxesActor::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkAxesActor::GetClassName (  )  [virtual]

Reimplemented from vtkProp3D.

static int vtkAxesActor::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

virtual int 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

static vtkAxesActor* vtkAxesActor::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkProp3D.

void vtkAxesActor::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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 vtkProp3D.

virtual void vtkAxesActor::GetActors ( vtkPropCollection  )  [virtual]

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.

virtual int vtkAxesActor::RenderOpaqueGeometry ( vtkViewport viewport  )  [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAxesActor::RenderTranslucentPolygonalGeometry ( vtkViewport viewport  )  [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAxesActor::RenderOverlay ( vtkViewport viewport  )  [virtual]

Support the standard render methods.

Reimplemented from vtkProp.

virtual int vtkAxesActor::HasTranslucentPolygonalGeometry (  )  [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

void vtkAxesActor::ShallowCopy ( vtkProp prop  )  [virtual]

Shallow copy of an axes actor. Overloads the virtual vtkProp method.

Reimplemented from vtkProp3D.

void vtkAxesActor::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

void 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.)

Reimplemented from vtkProp3D.

double* vtkAxesActor::GetBounds (  )  [virtual]

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). (The method GetBounds(double bounds[6]) is available from the superclass.)

Implements vtkProp3D.

unsigned long int vtkAxesActor::GetMTime (  )  [virtual]

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

Reimplemented from vtkProp3D.

virtual unsigned long vtkAxesActor::GetRedrawMTime (  )  [virtual]

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.

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

Set the total length of the axes in 3 dimensions.

Definition at line 118 of file vtkAxesActor.h.

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

Set the total length of the axes in 3 dimensions.

virtual double* vtkAxesActor::GetTotalLength (  )  [virtual]

Set the total length of the axes in 3 dimensions.

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

Set the total length of the axes in 3 dimensions.

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

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

Definition at line 126 of file vtkAxesActor.h.

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

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

virtual double* vtkAxesActor::GetNormalizedShaftLength (  )  [virtual]

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

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

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

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 135 of file vtkAxesActor.h.

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

Set the normalized (0-1) length of the tip. Normally, this would be 1 - the normalized length of the shaft.

virtual double* vtkAxesActor::GetNormalizedTipLength (  )  [virtual]

Set the normalized (0-1) length of the tip. Normally, this would be 1 - the normalized length of the shaft.

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

Set the normalized (0-1) length of the tip. Normally, this would be 1 - the normalized length of the shaft.

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 144 of file vtkAxesActor.h.

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

Set the normalized (0-1) position of the label along the length of the shaft. A value > 1 is permissible.

virtual double* vtkAxesActor::GetNormalizedLabelPosition (  )  [virtual]

Set the normalized (0-1) position of the label along the length of the shaft. A value > 1 is permissible.

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

Set the normalized (0-1) position of the label along the length of the shaft. A value > 1 is permissible.

virtual void vtkAxesActor::SetConeResolution ( int   )  [virtual]

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

virtual int vtkAxesActor::GetConeResolution (  )  [virtual]

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

virtual void vtkAxesActor::SetSphereResolution ( int   )  [virtual]

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

virtual int vtkAxesActor::GetSphereResolution (  )  [virtual]

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

virtual void vtkAxesActor::SetCylinderResolution ( int   )  [virtual]

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

virtual int vtkAxesActor::GetCylinderResolution (  )  [virtual]

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

virtual void vtkAxesActor::SetConeRadius ( double   )  [virtual]

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

virtual double vtkAxesActor::GetConeRadius (  )  [virtual]

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

virtual void vtkAxesActor::SetSphereRadius ( double   )  [virtual]

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

virtual double vtkAxesActor::GetSphereRadius (  )  [virtual]

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

virtual void vtkAxesActor::SetCylinderRadius ( double   )  [virtual]

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

virtual double vtkAxesActor::GetCylinderRadius (  )  [virtual]

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

void vtkAxesActor::SetShaftType ( int  type  ) 

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

void vtkAxesActor::SetShaftTypeToCylinder (  )  [inline]

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

Definition at line 174 of file vtkAxesActor.h.

void vtkAxesActor::SetShaftTypeToLine (  )  [inline]

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

Definition at line 176 of file vtkAxesActor.h.

void vtkAxesActor::SetShaftTypeToUserDefined (  )  [inline]

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

Definition at line 178 of file vtkAxesActor.h.

virtual int vtkAxesActor::GetShaftType (  )  [virtual]

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

void vtkAxesActor::SetTipType ( int  type  ) 

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

void vtkAxesActor::SetTipTypeToCone (  )  [inline]

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

Definition at line 186 of file vtkAxesActor.h.

void vtkAxesActor::SetTipTypeToSphere (  )  [inline]

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

Definition at line 188 of file vtkAxesActor.h.

void vtkAxesActor::SetTipTypeToUserDefined (  )  [inline]

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

Definition at line 190 of file vtkAxesActor.h.

virtual int vtkAxesActor::GetTipType (  )  [virtual]

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

void vtkAxesActor::SetUserDefinedTip ( vtkPolyData  ) 

Set the user defined tip polydata.

virtual vtkPolyData* vtkAxesActor::GetUserDefinedTip (  )  [virtual]

Set the user defined tip polydata.

void vtkAxesActor::SetUserDefinedShaft ( vtkPolyData  ) 

Set the user defined shaft polydata.

virtual vtkPolyData* vtkAxesActor::GetUserDefinedShaft (  )  [virtual]

Set the user defined shaft polydata.

vtkProperty* vtkAxesActor::GetXAxisTipProperty (  ) 

Get the tip properties.

vtkProperty* vtkAxesActor::GetYAxisTipProperty (  ) 

Get the tip properties.

vtkProperty* vtkAxesActor::GetZAxisTipProperty (  ) 

Get the tip properties.

vtkProperty* vtkAxesActor::GetXAxisShaftProperty (  ) 

Get the shaft properties.

vtkProperty* vtkAxesActor::GetYAxisShaftProperty (  ) 

Get the shaft properties.

vtkProperty* vtkAxesActor::GetZAxisShaftProperty (  ) 

Get the shaft properties.

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 224 of file vtkAxesActor.h.

vtkCaptionActor2D* vtkAxesActor::GetYAxisCaptionActor2D (  )  [inline]

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

Definition at line 226 of file vtkAxesActor.h.

vtkCaptionActor2D* vtkAxesActor::GetZAxisCaptionActor2D (  )  [inline]

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

Definition at line 228 of file vtkAxesActor.h.

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

Set/get the label text.

virtual char* vtkAxesActor::GetXAxisLabelText (  )  [virtual]

Set/get the label text.

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

Set/get the label text.

virtual char* vtkAxesActor::GetYAxisLabelText (  )  [virtual]

Set/get the label text.

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

Set/get the label text.

virtual char* vtkAxesActor::GetZAxisLabelText (  )  [virtual]

Set/get the label text.

virtual void vtkAxesActor::SetAxisLabels ( int   )  [virtual]

Enable/disable drawing the axis labels.

virtual int vtkAxesActor::GetAxisLabels (  )  [virtual]

Enable/disable drawing the axis labels.

virtual void vtkAxesActor::AxisLabelsOn (  )  [virtual]

Enable/disable drawing the axis labels.

virtual void vtkAxesActor::AxisLabelsOff (  )  [virtual]

Enable/disable drawing the axis labels.

void vtkAxesActor::UpdateProps (  )  [protected]


Member Data Documentation

Definition at line 269 of file vtkAxesActor.h.

Definition at line 270 of file vtkAxesActor.h.

Definition at line 271 of file vtkAxesActor.h.

Definition at line 272 of file vtkAxesActor.h.

Definition at line 274 of file vtkAxesActor.h.

Definition at line 275 of file vtkAxesActor.h.

Definition at line 276 of file vtkAxesActor.h.

Definition at line 278 of file vtkAxesActor.h.

Definition at line 279 of file vtkAxesActor.h.

Definition at line 280 of file vtkAxesActor.h.

double vtkAxesActor::TotalLength[3] [protected]

Definition at line 284 of file vtkAxesActor.h.

double vtkAxesActor::NormalizedShaftLength[3] [protected]

Definition at line 285 of file vtkAxesActor.h.

double vtkAxesActor::NormalizedTipLength[3] [protected]

Definition at line 286 of file vtkAxesActor.h.

Definition at line 287 of file vtkAxesActor.h.

int vtkAxesActor::ShaftType [protected]

Definition at line 289 of file vtkAxesActor.h.

int vtkAxesActor::TipType [protected]

Definition at line 290 of file vtkAxesActor.h.

Definition at line 292 of file vtkAxesActor.h.

Definition at line 293 of file vtkAxesActor.h.

char* vtkAxesActor::XAxisLabelText [protected]

Definition at line 295 of file vtkAxesActor.h.

char* vtkAxesActor::YAxisLabelText [protected]

Definition at line 296 of file vtkAxesActor.h.

char* vtkAxesActor::ZAxisLabelText [protected]

Definition at line 297 of file vtkAxesActor.h.

Definition at line 299 of file vtkAxesActor.h.

Definition at line 300 of file vtkAxesActor.h.

Definition at line 301 of file vtkAxesActor.h.

int vtkAxesActor::AxisLabels [protected]

Definition at line 303 of file vtkAxesActor.h.

Definition at line 306 of file vtkAxesActor.h.

Definition at line 307 of file vtkAxesActor.h.

Definition at line 308 of file vtkAxesActor.h.

double vtkAxesActor::ConeRadius [protected]

Definition at line 310 of file vtkAxesActor.h.

double vtkAxesActor::SphereRadius [protected]

Definition at line 311 of file vtkAxesActor.h.

double vtkAxesActor::CylinderRadius [protected]

Definition at line 312 of file vtkAxesActor.h.


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

Generated on Sat Dec 27 13:17:12 2008 for VTK by  doxygen 1.5.6