vtkCubeAxesActor Class Reference

#include <vtkCubeAxesActor.h>

Inheritance diagram for vtkCubeAxesActor:

[legend]

Collaboration diagram for vtkCubeAxesActor:

[legend]

List of all members.

Detailed Description

create a plot of a bounding box edges -

Date: 2007-11-21 18:05:05

Revision: 1.2

used for navigation

vtkCubeAxesActor is a composite actor that draws axes of the bounding box of an input dataset. The axes include labels and titles for the x-y-z axes. The algorithm selects which axes to draw based on the user-defined 'fly' mode. (STATIC is default). 'STATIC' constructs axes from all edges of the bounding box. 'CLOSEST_TRIAD' consists of the three axes x-y-z forming a triad that lies closest to the specified camera. 'FURTHEST_TRIAD' consists of the three axes x-y-z forming a triad that lies furthest from the specified camera. 'OUTER_EDGES' is constructed from edges that are on the "exterior" of the bounding box, exterior as determined from examining outer edges of the bounding box in projection (display) space.

To use this object you must define a bounding box and the camera used to render the vtkCubeAxesActor. You can optionally turn on/off labels, ticks, gridlines, and set tick location, number of labels, and text to use for axis-titles. A 'corner offset' can also be set. This allows the axes to be set partially away from the actual bounding box to perhaps prevent overlap of labels between the various axes.

The Bounds instance variable (an array of six doubles) is used to determine the bounding box.

See also:: vtkActor vtkAxisActor vtkCubeAxesActor2D

Tests:: vtkCubeAxesActor (Tests)

Definition at line 70 of file vtkCubeAxesActor.h.


Public Types
typedef vtkActor	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ReleaseGraphicsResources (vtkWindow *)
virtual void	SetYAxisLabelVisibility (int)
virtual int	GetYAxisLabelVisibility ()
virtual void	YAxisLabelVisibilityOn ()
virtual void	YAxisLabelVisibilityOff ()
virtual void	SetZAxisLabelVisibility (int)
virtual int	GetZAxisLabelVisibility ()
virtual void	ZAxisLabelVisibilityOn ()
virtual void	ZAxisLabelVisibilityOff ()
virtual void	SetYAxisTickVisibility (int)
virtual int	GetYAxisTickVisibility ()
virtual void	YAxisTickVisibilityOn ()
virtual void	YAxisTickVisibilityOff ()
virtual void	SetZAxisTickVisibility (int)
virtual int	GetZAxisTickVisibility ()
virtual void	ZAxisTickVisibilityOn ()
virtual void	ZAxisTickVisibilityOff ()
virtual void	SetYAxisMinorTickVisibility (int)
virtual int	GetYAxisMinorTickVisibility ()
virtual void	YAxisMinorTickVisibilityOn ()
virtual void	YAxisMinorTickVisibilityOff ()
virtual void	SetZAxisMinorTickVisibility (int)
virtual int	GetZAxisMinorTickVisibility ()
virtual void	ZAxisMinorTickVisibilityOn ()
virtual void	ZAxisMinorTickVisibilityOff ()
virtual void	SetDrawXGridlines (int)
virtual int	GetDrawXGridlines ()
virtual void	DrawXGridlinesOn ()
virtual void	DrawXGridlinesOff ()
virtual void	SetDrawYGridlines (int)
virtual int	GetDrawYGridlines ()
virtual void	DrawYGridlinesOn ()
virtual void	DrawYGridlinesOff ()
virtual void	SetDrawZGridlines (int)
virtual int	GetDrawZGridlines ()
virtual void	DrawZGridlinesOn ()
virtual void	DrawZGridlinesOff ()
void	SetTickLocationToInside (void)
void	SetTickLocationToOutside (void)
void	SetTickLocationToBoth (void)
void	SetLabelScaling (bool, int, int, int)
void	ShallowCopy (vtkCubeAxesActor *actor)

virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentGeometry (vtkViewport *)

virtual void	SetBounds (double, double, double, double, double, double)
virtual void	SetBounds (double[6])
double *	GetBounds ()
void	GetBounds (double &xmin, double &xmax, double &ymin, double &ymax, double &zmin, double &zmax)
void	GetBounds (double bounds[6])

virtual void	SetCamera (vtkCamera *)
virtual vtkCamera *	GetCamera ()

virtual void	SetFlyMode (int)
virtual int	GetFlyMode ()
void	SetFlyModeToOuterEdges ()
void	SetFlyModeToClosestTriad ()
void	SetFlyModeToFurthestTriad ()
void	SetFlyModeToStaticTriad ()
void	SetFlyModeToStaticEdges ()

virtual void	SetXTitle (const char *)
virtual char *	GetXTitle ()
virtual void	SetXUnits (const char *)
virtual char *	GetXUnits ()
virtual void	SetYTitle (const char *)
virtual char *	GetYTitle ()
virtual void	SetYUnits (const char *)
virtual char *	GetYUnits ()
virtual void	SetZTitle (const char *)
virtual char *	GetZTitle ()
virtual void	SetZUnits (const char *)
virtual char *	GetZUnits ()

virtual void	SetXLabelFormat (const char *)
virtual char *	GetXLabelFormat ()
virtual void	SetYLabelFormat (const char *)
virtual char *	GetYLabelFormat ()
virtual void	SetZLabelFormat (const char *)
virtual char *	GetZLabelFormat ()

virtual void	SetInertia (int)
virtual int	GetInertia ()

virtual void	SetCornerOffset (double)
virtual double	GetCornerOffset ()

virtual void	SetXAxisVisibility (int)
virtual int	GetXAxisVisibility ()
virtual void	XAxisVisibilityOn ()
virtual void	XAxisVisibilityOff ()
virtual void	SetYAxisVisibility (int)
virtual int	GetYAxisVisibility ()
virtual void	YAxisVisibilityOn ()
virtual void	YAxisVisibilityOff ()
virtual void	SetZAxisVisibility (int)
virtual int	GetZAxisVisibility ()
virtual void	ZAxisVisibilityOn ()
virtual void	ZAxisVisibilityOff ()

virtual void	SetXAxisLabelVisibility (int)
virtual int	GetXAxisLabelVisibility ()
virtual void	XAxisLabelVisibilityOn ()
virtual void	XAxisLabelVisibilityOff ()

virtual void	SetXAxisTickVisibility (int)
virtual int	GetXAxisTickVisibility ()
virtual void	XAxisTickVisibilityOn ()
virtual void	XAxisTickVisibilityOff ()

virtual void	SetXAxisMinorTickVisibility (int)
virtual int	GetXAxisMinorTickVisibility ()
virtual void	XAxisMinorTickVisibilityOn ()
virtual void	XAxisMinorTickVisibilityOff ()

virtual void	SetTickLocation (int)
virtual int	GetTickLocation ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCubeAxesActor *	SafeDownCast (vtkObject *o)
static vtkCubeAxesActor *	New ()
Protected Member Functions
	vtkCubeAxesActor ()
	~vtkCubeAxesActor ()
int	LabelExponent (double min, double max)
int	Digits (double min, double max)
double	MaxOf (double, double)
double	MaxOf (double, double, double, double)
double	FFix (double)
double	FSign (double, double)
Protected Attributes
double	Bounds [6]
vtkCamera *	Camera
int	FlyMode
vtkAxisActor *	XAxes [4]
vtkAxisActor *	YAxes [4]
vtkAxisActor *	ZAxes [4]
char *	XTitle
char *	XUnits
char *	YTitle
char *	YUnits
char *	ZTitle
char *	ZUnits
char *	ActualXLabel
char *	ActualYLabel
char *	ActualZLabel
int	TickLocation
int	XAxisVisibility
int	YAxisVisibility
int	ZAxisVisibility
int	XAxisTickVisibility
int	YAxisTickVisibility
int	ZAxisTickVisibility
int	XAxisMinorTickVisibility
int	YAxisMinorTickVisibility
int	ZAxisMinorTickVisibility
int	XAxisLabelVisibility
int	YAxisLabelVisibility
int	ZAxisLabelVisibility
int	DrawXGridlines
int	DrawYGridlines
int	DrawZGridlines
char *	XLabelFormat
char *	YLabelFormat
char *	ZLabelFormat
double	CornerOffset
int	Inertia
int	RenderCount
int	InertiaLocs [3]
int	RenderSomething

Member Typedef Documentation

typedef vtkActor vtkCubeAxesActor::Superclass

Reimplemented from vtkActor.

Definition at line 73 of file vtkCubeAxesActor.h.

Constructor & Destructor Documentation

vtkCubeAxesActor::vtkCubeAxesActor ( ) [protected]

vtkCubeAxesActor::~vtkCubeAxesActor ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkActor.

static int vtkCubeAxesActor::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 vtkActor.

virtual int vtkCubeAxesActor::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 vtkActor.

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

Reimplemented from vtkActor.

void vtkCubeAxesActor::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 vtkActor.

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

Instantiate object with label format "6.3g" and the number of labels per axis set to 3.

Reimplemented from vtkActor.

virtual int vtkCubeAxesActor::RenderOpaqueGeometry ( vtkViewport * ) [virtual]

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkActor.

virtual int vtkCubeAxesActor::RenderTranslucentGeometry ( vtkViewport * ) [inline, virtual]

Draw the axes as per the vtkProp superclass' API.

Definition at line 83 of file vtkCubeAxesActor.h.

virtual void vtkCubeAxesActor::SetBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)			`[virtual]`

Explicitly specify the region in space around which to draw the bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

virtual void vtkCubeAxesActor::SetBounds ( double [6] ) [virtual]

Explicitly specify the region in space around which to draw the bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

double* vtkCubeAxesActor::GetBounds ( ) [virtual]

Explicitly specify the region in space around which to draw the bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

Reimplemented from vtkActor.

void vtkCubeAxesActor::GetBounds	(	double &	xmin,
		double &	xmax,
		double &	ymin,
		double &	ymax,
		double &	zmin,
		double &	zmax
	)

Explicitly specify the region in space around which to draw the bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

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

Explicitly specify the region in space around which to draw the bounds. The bounds is used only when no Input or Prop is specified. The bounds are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

Reimplemented from vtkActor.

virtual void vtkCubeAxesActor::SetCamera ( vtkCamera * ) [virtual]

Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor.

virtual vtkCamera* vtkCubeAxesActor::GetCamera ( ) [virtual]

Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor.

virtual void vtkCubeAxesActor::SetFlyMode ( int ) [virtual]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

virtual int vtkCubeAxesActor::GetFlyMode ( ) [virtual]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

void vtkCubeAxesActor::SetFlyModeToOuterEdges ( ) [inline]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

Definition at line 111 of file vtkCubeAxesActor.h.

void vtkCubeAxesActor::SetFlyModeToClosestTriad ( ) [inline]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

Definition at line 113 of file vtkCubeAxesActor.h.

void vtkCubeAxesActor::SetFlyModeToFurthestTriad ( ) [inline]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

Definition at line 115 of file vtkCubeAxesActor.h.

void vtkCubeAxesActor::SetFlyModeToStaticTriad ( ) [inline]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

Definition at line 117 of file vtkCubeAxesActor.h.

void vtkCubeAxesActor::SetFlyModeToStaticEdges ( ) [inline]

Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or outer edges in relation to the camera position.

Definition at line 119 of file vtkCubeAxesActor.h.

virtual void vtkCubeAxesActor::SetXTitle ( const char * ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual char* vtkCubeAxesActor::GetXTitle ( ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual void vtkCubeAxesActor::SetXUnits ( const char * ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual char* vtkCubeAxesActor::GetXUnits ( ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual void vtkCubeAxesActor::SetYTitle ( const char * ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual char* vtkCubeAxesActor::GetYTitle ( ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual void vtkCubeAxesActor::SetYUnits ( const char * ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual char* vtkCubeAxesActor::GetYUnits ( ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual void vtkCubeAxesActor::SetZTitle ( const char * ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual char* vtkCubeAxesActor::GetZTitle ( ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual void vtkCubeAxesActor::SetZUnits ( const char * ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual char* vtkCubeAxesActor::GetZUnits ( ) [virtual]

Set/Get the labels for the x, y, and z axes. By default, use "X-Axis", "Y-Axis" and "Z-Axis".

virtual void vtkCubeAxesActor::SetXLabelFormat ( const char * ) [virtual]

Set/Get the format with which to print the labels on each of the x-y-z axes.

virtual char* vtkCubeAxesActor::GetXLabelFormat ( ) [virtual]

Set/Get the format with which to print the labels on each of the x-y-z axes.

virtual void vtkCubeAxesActor::SetYLabelFormat ( const char * ) [virtual]

Set/Get the format with which to print the labels on each of the x-y-z axes.

virtual char* vtkCubeAxesActor::GetYLabelFormat ( ) [virtual]

Set/Get the format with which to print the labels on each of the x-y-z axes.

virtual void vtkCubeAxesActor::SetZLabelFormat ( const char * ) [virtual]

Set/Get the format with which to print the labels on each of the x-y-z axes.

virtual char* vtkCubeAxesActor::GetZLabelFormat ( ) [virtual]

Set/Get the format with which to print the labels on each of the x-y-z axes.

virtual void vtkCubeAxesActor::SetInertia ( int ) [virtual]

Set/Get the inertial factor that controls how often (i.e, how many renders) the axes can switch position (jump from one axes to another).

virtual int vtkCubeAxesActor::GetInertia ( ) [virtual]

Set/Get the inertial factor that controls how often (i.e, how many renders) the axes can switch position (jump from one axes to another).

virtual void vtkCubeAxesActor::SetCornerOffset ( double ) [virtual]

Specify an offset value to "pull back" the axes from the corner at which they are joined to avoid overlap of axes labels. The "CornerOffset" is the fraction of the axis length to pull back.

virtual double vtkCubeAxesActor::GetCornerOffset ( ) [virtual]

Specify an offset value to "pull back" the axes from the corner at which they are joined to avoid overlap of axes labels. The "CornerOffset" is the fraction of the axis length to pull back.

void vtkCubeAxesActor::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 vtkActor.

virtual void vtkCubeAxesActor::SetXAxisVisibility ( int ) [virtual]