create a plot of a bounding box edges - used for navigation More...

#include <vtkCubeAxesActor.h>

Inheritance diagram for vtkCubeAxesActor:

Collaboration diagram for vtkCubeAxesActor:

Public Types
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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCubeAxesActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual double *	GetZAxisRange ()

virtual void	GetZAxisRange (double &, double &)

virtual void	GetZAxisRange (double[2])

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 ()

virtual void	SetDrawXInnerGridlines (int)

virtual int	GetDrawXInnerGridlines ()

virtual void	DrawXInnerGridlinesOn ()

virtual void	DrawXInnerGridlinesOff ()

virtual void	SetDrawYInnerGridlines (int)

virtual int	GetDrawYInnerGridlines ()

virtual void	DrawYInnerGridlinesOn ()

virtual void	DrawYInnerGridlinesOff ()

virtual void	SetDrawZInnerGridlines (int)

virtual int	GetDrawZInnerGridlines ()

virtual void	DrawZInnerGridlinesOn ()

virtual void	DrawZInnerGridlinesOff ()

virtual void	SetDrawXGridpolys (int)

virtual int	GetDrawXGridpolys ()

virtual void	DrawXGridpolysOn ()

virtual void	DrawXGridpolysOff ()

virtual void	SetDrawYGridpolys (int)

virtual int	GetDrawYGridpolys ()

virtual void	DrawYGridpolysOn ()

virtual void	DrawYGridpolysOff ()

virtual void	SetDrawZGridpolys (int)

virtual int	GetDrawZGridpolys ()

virtual void	DrawZGridpolysOn ()

virtual void	DrawZGridpolysOff ()

vtkTextProperty *	GetTitleTextProperty (int)

vtkTextProperty *	GetLabelTextProperty (int)

void	SetTickLocationToInside (void)

void	SetTickLocationToOutside (void)

void	SetTickLocationToBoth (void)

void	SetLabelScaling (bool, int, int, int)

void	SetSaveTitlePosition (int val)


virtual int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

int	HasTranslucentPolygonalGeometry ()


virtual void	SetRebuildAxes (bool)

virtual bool	GetRebuildAxes ()


virtual void	SetBounds (double, double, double, double, double, double)

virtual void	SetBounds (double[6])

virtual double *	GetBounds ()

virtual void	GetBounds (double &, double &, double &, double &, double &, double &)

virtual void	GetBounds (double[6])


virtual void	GetRenderedBounds (double rBounds[6])

virtual double *	GetRenderedBounds ()


virtual void	SetXAxisRange (double, double)

void	SetXAxisRange (double[2])

virtual void	SetYAxisRange (double, double)

void	SetYAxisRange (double[2])

virtual void	SetZAxisRange (double, double)

void	SetZAxisRange (double[2])

virtual double *	GetXAxisRange ()

virtual void	GetXAxisRange (double &, double &)

virtual void	GetXAxisRange (double[2])

virtual double *	GetYAxisRange ()

virtual void	GetYAxisRange (double &, double &)

virtual void	GetYAxisRange (double[2])


vtkStringArray *	GetAxisLabels (int axis)

void	SetAxisLabels (int axis, vtkStringArray *value)


void	SetScreenSize (double screenSize)

virtual double	GetScreenSize ()


void	SetLabelOffset (double offset)

virtual double	GetLabelOffset ()


void	SetTitleOffset (double offset)

virtual double	GetTitleOffset ()


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	SetEnableDistanceLOD (int)

virtual int	GetEnableDistanceLOD ()


virtual void	SetDistanceLODThreshold (double)

virtual double	GetDistanceLODThreshold ()


virtual void	SetEnableViewAngleLOD (int)

virtual int	GetEnableViewAngleLOD ()


virtual void	SetViewAngleLODThreshold (double)

virtual double	GetViewAngleLODThreshold ()


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 ()


void	SetXAxesLinesProperty (vtkProperty *)

vtkProperty *	GetXAxesLinesProperty ()

void	SetYAxesLinesProperty (vtkProperty *)

vtkProperty *	GetYAxesLinesProperty ()

void	SetZAxesLinesProperty (vtkProperty *)

vtkProperty *	GetZAxesLinesProperty ()


void	SetXAxesGridlinesProperty (vtkProperty *)

vtkProperty *	GetXAxesGridlinesProperty ()

void	SetYAxesGridlinesProperty (vtkProperty *)

vtkProperty *	GetYAxesGridlinesProperty ()

void	SetZAxesGridlinesProperty (vtkProperty *)

vtkProperty *	GetZAxesGridlinesProperty ()


void	SetXAxesInnerGridlinesProperty (vtkProperty *)

vtkProperty *	GetXAxesInnerGridlinesProperty ()

void	SetYAxesInnerGridlinesProperty (vtkProperty *)

vtkProperty *	GetYAxesInnerGridlinesProperty ()

void	SetZAxesInnerGridlinesProperty (vtkProperty *)

vtkProperty *	GetZAxesInnerGridlinesProperty ()


void	SetXAxesGridpolysProperty (vtkProperty *)

vtkProperty *	GetXAxesGridpolysProperty ()

void	SetYAxesGridpolysProperty (vtkProperty *)

vtkProperty *	GetYAxesGridpolysProperty ()

void	SetZAxesGridpolysProperty (vtkProperty *)

vtkProperty *	GetZAxesGridpolysProperty ()


virtual void	SetTickLocation (int)

virtual int	GetTickLocation ()


void	SetUseTextActor3D (int val)

int	GetUseTextActor3D ()


void	SetUse2DMode (int val)

int	GetUse2DMode ()


virtual void	SetOrientedBounds (double, double, double, double, double, double)

virtual void	SetOrientedBounds (double[6])

virtual double *	GetOrientedBounds ()

virtual void	GetOrientedBounds (double &, double &, double &, double &, double &, double &)

virtual void	GetOrientedBounds (double[6])


virtual void	SetUseOrientedBounds (int)

virtual int	GetUseOrientedBounds ()


virtual void	SetAxisBaseForX (double, double, double)

virtual void	SetAxisBaseForX (double[3])

virtual double *	GetAxisBaseForX ()

virtual void	GetAxisBaseForX (double &, double &, double &)

virtual void	GetAxisBaseForX (double[3])


virtual void	SetAxisBaseForY (double, double, double)

virtual void	SetAxisBaseForY (double[3])

virtual double *	GetAxisBaseForY ()

virtual void	GetAxisBaseForY (double &, double &, double &)

virtual void	GetAxisBaseForY (double[3])


virtual void	SetAxisBaseForZ (double, double, double)

virtual void	SetAxisBaseForZ (double[3])

virtual double *	GetAxisBaseForZ ()

virtual void	GetAxisBaseForZ (double &, double &, double &)

virtual void	GetAxisBaseForZ (double[3])


virtual void	SetAxisOrigin (double, double, double)

virtual void	SetAxisOrigin (double[3])

virtual double *	GetAxisOrigin ()

virtual void	GetAxisOrigin (double &, double &, double &)

virtual void	GetAxisOrigin (double[3])


virtual void	SetUseAxisOrigin (int)

virtual int	GetUseAxisOrigin ()


virtual void	SetGridLineLocation (int)

virtual int	GetGridLineLocation ()


virtual void	SetStickyAxes (int)

virtual int	GetStickyAxes ()

virtual void	StickyAxesOn ()

virtual void	StickyAxesOff ()


virtual void	SetCenterStickyAxes (int)

virtual int	GetCenterStickyAxes ()

virtual void	CenterStickyAxesOn ()

virtual void	CenterStickyAxesOff ()

Public Member Functions inherited from vtkActor
vtkActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	GetActors (vtkPropCollection *)

virtual void	Render (vtkRenderer , vtkMapper )

void	ShallowCopy (vtkProp *prop)

void	ReleaseGraphicsResources (vtkWindow *)

virtual vtkProperty *	MakeProperty ()

virtual void	SetMapper (vtkMapper *)

virtual void	ApplyProperties ()

unsigned long int	GetMTime ()

virtual unsigned long	GetRedrawMTime ()

virtual bool	GetSupportsSelection ()

void	SetProperty (vtkProperty *lut)

vtkProperty *	GetProperty ()

void	SetBackfaceProperty (vtkProperty *lut)

virtual vtkProperty *	GetBackfaceProperty ()

virtual void	SetTexture (vtkTexture *)

virtual vtkTexture *	GetTexture ()

virtual vtkMapper *	GetMapper ()

void	GetBounds (double bounds[6])

double *	GetBounds ()

virtual bool	GetForceOpaque ()

virtual void	SetForceOpaque (bool)

virtual void	ForceOpaqueOn ()

virtual void	ForceOpaqueOff ()

virtual bool	GetForceTranslucent ()

virtual void	SetForceTranslucent (bool)

virtual void	ForceTranslucentOn ()

virtual void	ForceTranslucentOff ()

Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	ShallowCopy (vtkProp *prop)

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)

double *	GetCenter ()

double *	GetXRange ()

double *	GetYRange ()

double *	GetZRange ()

double	GetLength ()

void	RotateX (double)

void	RotateY (double)

void	RotateZ (double)

void	RotateWXYZ (double w, double x, double y, double z)

void	SetOrientation (double x, double y, double z)

void	SetOrientation (double orientation[3])

double *	GetOrientationWXYZ ()

void	AddOrientation (double x, double y, double z)

void	AddOrientation (double orentation[3])

void	PokeMatrix (vtkMatrix4x4 *matrix)

void	InitPathTraversal ()

unsigned long int	GetMTime ()

unsigned long int	GetUserTransformMatrixMTime ()

virtual void	ComputeMatrix ()

virtual void	SetPosition (double x, double y, double z)

virtual void	SetOrigin (double x, double y, double z)

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)

virtual void	SetScale (double scale[3])

virtual double *	GetScale ()

virtual void	GetScale (double data[3])

void	SetScale (double s)

void	SetUserTransform (vtkLinearTransform *transform)

virtual vtkLinearTransform *	GetUserTransform ()

void	SetUserMatrix (vtkMatrix4x4 *matrix)

vtkMatrix4x4 *	GetUserMatrix ()

virtual void	GetMatrix (vtkMatrix4x4 *m)

virtual void	GetMatrix (double m[16])

void	GetBounds (double bounds[6])

double *	GetOrientation ()

void	GetOrientation (double orentation[3])

vtkMatrix4x4 *	GetMatrix ()

virtual int	GetIsIdentity ()

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkCubeAxesActor *	SafeDownCast (vtkObjectBase *o)

static vtkCubeAxesActor *	New ()

Static Public Member Functions inherited from vtkActor
static int	IsTypeOf (const char *type)

static vtkActor *	SafeDownCast (vtkObjectBase *o)

static vtkActor *	New ()

Static Public Member Functions inherited from vtkProp3D
static int	IsTypeOf (const char *type)

static vtkProp3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCubeAxesActor ()

	~vtkCubeAxesActor ()

void	GetViewportLimitedBounds (vtkViewport *viewport, double bounds[6])

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)

int	FRound (double fnt)

int	GetNumTicks (double range, double fxt)

void	UpdateLabels (vtkAxisActor **axis, int index)

int	FindClosestAxisIndex (double pts[8][3])

int	FindFurtherstAxisIndex (double pts[8][3])

void	FindBoundaryEdge (int &indexOfAxisX, int &indexOfAxisY, int &indexOfAxisZ, double pts[8][3])

void	UpdateGridLineVisibility (int axisIndex)


void	ComputeStickyAxesBoundingSphere (vtkViewport *viewport, const double bounds[6], double sphereCenter[3], double &sphereRadius)

Protected Member Functions inherited from vtkActor
	vtkActor ()

	~vtkActor ()

int	GetIsOpaque ()

Protected Member Functions inherited from vtkProp3D
	vtkProp3D ()

	~vtkProp3D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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 &)

Static Protected Member Functions
static void	GetBoundsPoint (unsigned int pointIndex, const double bounds[6], double point[3])


static void	GetBoundsPointBits (unsigned int pointIndex, unsigned int &xBit, unsigned int &yBit, unsigned int &zBit)

Protected Attributes
double	Bounds [6]

vtkCamera *	Camera

int	FlyMode

int	GridLineLocation

int	StickyAxes

int	CenterStickyAxes

int	EnableDistanceLOD

double	DistanceLODThreshold

int	EnableViewAngleLOD

double	ViewAngleLODThreshold

bool	RebuildAxes

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

int	DrawXInnerGridlines

int	DrawYInnerGridlines

int	DrawZInnerGridlines

int	DrawXGridpolys

int	DrawYGridpolys

int	DrawZGridpolys

char *	XLabelFormat

char *	YLabelFormat

char *	ZLabelFormat

double	CornerOffset

int	Inertia

int	RenderCount

int	InertiaLocs [3]

int	RenderSomething

vtkTextProperty *	TitleTextProperty [3]

vtkStringArray *	AxisLabels [3]

vtkTextProperty *	LabelTextProperty [3]

vtkProperty *	XAxesLinesProperty

vtkProperty *	YAxesLinesProperty

vtkProperty *	ZAxesLinesProperty

vtkProperty *	XAxesGridlinesProperty

vtkProperty *	YAxesGridlinesProperty

vtkProperty *	ZAxesGridlinesProperty

vtkProperty *	XAxesInnerGridlinesProperty

vtkProperty *	YAxesInnerGridlinesProperty

vtkProperty *	ZAxesInnerGridlinesProperty

vtkProperty *	XAxesGridpolysProperty

vtkProperty *	YAxesGridpolysProperty

vtkProperty *	ZAxesGridpolysProperty

double	RenderedBounds [6]

double	OrientedBounds [6]

int	UseOrientedBounds

double	AxisOrigin [3]

int	UseAxisOrigin

double	AxisBaseForX [3]

double	AxisBaseForY [3]

double	AxisBaseForZ [3]


vtkAxisActor *	XAxes [NUMBER_OF_ALIGNED_AXIS]

vtkAxisActor *	YAxes [NUMBER_OF_ALIGNED_AXIS]

vtkAxisActor *	ZAxes [NUMBER_OF_ALIGNED_AXIS]

Protected Attributes inherited from vtkActor
bool	ForceOpaque

bool	ForceTranslucent

vtkProperty *	Property

vtkProperty *	BackfaceProperty

vtkTexture *	Texture

vtkMapper *	Mapper

double	MapperBounds [6]

vtkTimeStamp	BoundsMTime

Protected Attributes inherited from vtkProp3D
vtkLinearTransform *	UserTransform

vtkMatrix4x4 *	UserMatrix

vtkMatrix4x4 *	Matrix

vtkTimeStamp	MatrixMTime

double	Origin [3]

double	Position [3]

double	Orientation [3]

double	Scale [3]

double	Center [3]

vtkTransform *	Transform

double	Bounds [6]

vtkProp3D *	CachedProp3D

int	IsIdentity

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

create a plot of a bounding box edges - 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.

Thanks:: This class was written by: Hank Childs, Kathleen Bonnell, Amy Squillacote, Brad Whitlock, Will Schroeder, Eric Brugger, Daniel Aguilera, Claire Guilbaud, Nicolas Dolegieviez, 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 vtkAxisActor vtkCubeAxesActor2D

Tests:: vtkCubeAxesActor (Tests)

Definition at line 85 of file vtkCubeAxesActor.h.

Member Typedef Documentation

typedef vtkActor vtkCubeAxesActor::Superclass

Definition at line 88 of file vtkCubeAxesActor.h.

Constructor & Destructor Documentation

vtkCubeAxesActor::vtkCubeAxesActor ( )

protected

vtkCubeAxesActor::~vtkCubeAxesActor ( )

protected

Member Function Documentation

static int vtkCubeAxesActor::IsTypeOf ( const char * type )

static

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor.

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

static

virtual vtkObjectBase* vtkCubeAxesActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor.

vtkCubeAxesActor* vtkCubeAxesActor::NewInstance ( ) const

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

static vtkCubeAxesActor* vtkCubeAxesActor::New ( )

static

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

virtual int vtkCubeAxesActor::RenderOpaqueGeometry ( vtkViewport * )

virtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkActor.

virtual int vtkCubeAxesActor::RenderTranslucentGeometry ( vtkViewport * )

virtual

Draw the axes as per the vtkProp superclass' API.

virtual int vtkCubeAxesActor::RenderTranslucentPolygonalGeometry ( vtkViewport * )

virtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkActor.

virtual int vtkCubeAxesActor::RenderOverlay ( vtkViewport * )

virtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkProp.

int vtkCubeAxesActor::HasTranslucentPolygonalGeometry ( )

virtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkActor.

virtual void vtkCubeAxesActor::SetRebuildAxes ( bool )

virtual

Gets/Sets the RebuildAxes flag

virtual bool vtkCubeAxesActor::GetRebuildAxes ( )

virtual

Gets/Sets the RebuildAxes flag

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.

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

Implements vtkProp3D.

virtual void vtkCubeAxesActor::GetBounds	(	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::GetBounds ( 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.

virtual void vtkCubeAxesActor::GetRenderedBounds ( double rBounds[6] )

virtual

Method used to properly return the bounds of the cube axis itself with all its labels.

virtual double* vtkCubeAxesActor::GetRenderedBounds ( )

virtual

Method used to properly return the bounds of the cube axis itself with all its labels.

virtual void vtkCubeAxesActor::SetXAxisRange	(	double	,
		double
	)

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

void vtkCubeAxesActor::SetXAxisRange ( double [2] )

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual void vtkCubeAxesActor::SetYAxisRange	(	double	,
		double
	)

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

void vtkCubeAxesActor::SetYAxisRange ( double [2] )

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual void vtkCubeAxesActor::SetZAxisRange	(	double	,
		double
	)

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

void vtkCubeAxesActor::SetZAxisRange ( double [2] )

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual double* vtkCubeAxesActor::GetXAxisRange ( )

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual void vtkCubeAxesActor::GetXAxisRange	(	double &	,
		double &
	)

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual void vtkCubeAxesActor::GetXAxisRange ( double [2] )

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual double* vtkCubeAxesActor::GetYAxisRange ( )

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual void vtkCubeAxesActor::GetYAxisRange	(	double &	,
		double &
	)

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

virtual void vtkCubeAxesActor::GetYAxisRange ( double [2] )

virtual

Explicitly specify the range of each axes that's used to define the prop. The default, (if you do not use these methods) is to use the bounds specified, or use the bounds of the Input Prop if one is specified. This method allows you to separate the notion of extent of the axes in physical space (bounds) and the extent of the values it represents. In other words, you can have the ticks and labels show a different range.

vtkStringArray* vtkCubeAxesActor::GetAxisLabels ( int axis )

Explicitly specify the axis labels along an axis as an array of strings instead of using the values.

void vtkCubeAxesActor::SetAxisLabels	(	int	axis,
		vtkStringArray *	value
	)

Explicitly specify the axis labels along an axis as an array of strings instead of using the values.

virtual double* vtkCubeAxesActor::GetZAxisRange ( )

virtual

virtual void vtkCubeAxesActor::GetZAxisRange	(	double &	,
		double &
	)

virtual

virtual void vtkCubeAxesActor::GetZAxisRange ( double [2] )

virtual

void vtkCubeAxesActor::SetScreenSize ( double screenSize )

Explicitly specify the screen size of title and label text. ScreenSize determines the size of the text in terms of screen pixels. Default is 10.0.

virtual double vtkCubeAxesActor::GetScreenSize ( )

virtual

Explicitly specify the screen size of title and label text. ScreenSize determines the size of the text in terms of screen pixels. Default is 10.0.

void vtkCubeAxesActor::SetLabelOffset ( double offset )

Explicitly specify the distance between labels and the axis. Default is 20.0.

virtual double vtkCubeAxesActor::GetLabelOffset ( )

virtual

Explicitly specify the distance between labels and the axis. Default is 20.0.

void vtkCubeAxesActor::SetTitleOffset ( double offset )

Explicitly specify the distance between title and labels. Default is 20.0.

virtual double vtkCubeAxesActor::GetTitleOffset ( )

virtual

Explicitly specify the distance between title and labels. Default is 20.0.

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 184 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 186 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 188 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 190 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 192 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 vtkProp.

virtual void vtkCubeAxesActor::SetEnableDistanceLOD ( int )

virtual

Enable and disable the use of distance based LOD for titles and labels.

virtual int vtkCubeAxesActor::GetEnableDistanceLOD ( )

virtual

Enable and disable the use of distance based LOD for titles and labels.

virtual void vtkCubeAxesActor::SetDistanceLODThreshold ( double )

virtual

Set distance LOD threshold [0.0 - 1.0] for titles and labels.

virtual double vtkCubeAxesActor::GetDistanceLODThreshold ( )

virtual

Set distance LOD threshold [0.0 - 1.0] for titles and labels.

virtual void vtkCubeAxesActor::SetEnableViewAngleLOD ( int )

virtual

Enable and disable the use of view angle based LOD for titles and labels.

virtual int vtkCubeAxesActor::GetEnableViewAngleLOD ( )

virtual

Enable and disable the use of view angle based LOD for titles and labels.

virtual void vtkCubeAxesActor::SetViewAngleLODThreshold ( double )

virtual

Set view angle LOD threshold [0.0 - 1.0] for titles and labels.

virtual double vtkCubeAxesActor::GetViewAngleLODThreshold ( )

virtual

Set view angle LOD threshold [0.0 - 1.0] for titles and labels.

virtual void vtkCubeAxesActor::SetXAxisVisibility ( int )

virtual