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

#include <vtkCubeAxesActor2D.h>

Inheritance diagram for vtkCubeAxesActor2D:

Collaboration diagram for vtkCubeAxesActor2D:

Public Types
enum	FlyMode { VTK_FLY_OUTER_EDGES = 0, VTK_FLY_CLOSEST_TRIAD = 1, VTK_FLY_NONE = 2 }

typedef vtkActor2D	Superclass

Public Types inherited from vtkActor2D
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...

vtkCubeAxesActor2D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry? More...

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

vtkAxisActor2D *	GetYAxisActor2D ()

vtkAxisActor2D *	GetZAxisActor2D ()

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor. More...

void	ShallowCopy (vtkCubeAxesActor2D *actor)
	Shallow copy of a CubeAxesActor2D. More...


int	RenderOverlay (vtkViewport *) override
	Draw the axes as per the vtkProp superclass' API. More...

int	RenderOpaqueGeometry (vtkViewport *) override
	Draw the axes as per the vtkProp superclass' API. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Draw the axes as per the vtkProp superclass' API. More...


virtual void	SetInputConnection (vtkAlgorithmOutput *)
	Use the bounding box of this input dataset to draw the cube axes. More...

virtual void	SetInputData (vtkDataSet *)
	Use the bounding box of this input dataset to draw the cube axes. More...

virtual vtkDataSet *	GetInput ()
	Use the bounding box of this input dataset to draw the cube axes. More...


void	SetViewProp (vtkProp *prop)
	Use the bounding box of this prop to draw the cube axes. More...

virtual vtkProp *	GetViewProp ()
	Use the bounding box of this prop to draw the cube axes. More...


virtual void	SetBounds (double, double, double, double, double, double)
	Explicitly specify the region in space around which to draw the bounds. More...

virtual void	SetBounds (double[6])
	Explicitly specify the region in space around which to draw the bounds. More...

double *	GetBounds () override
	Explicitly specify the region in space around which to draw the bounds. More...

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

void	GetBounds (double bounds[6])
	Explicitly specify the region in space around which to draw the bounds. More...


virtual void	SetRanges (double, double, double, double, double, double)
	Explicitly specify the range of values used on the bounds. More...

virtual void	SetRanges (double[6])
	Explicitly specify the range of values used on the bounds. More...

double *	GetRanges ()
	Explicitly specify the range of values used on the bounds. More...

void	GetRanges (double &xmin, double &xmax, double &ymin, double &ymax, double &zmin, double &zmax)
	Explicitly specify the range of values used on the bounds. More...

void	GetRanges (double ranges[6])
	Explicitly specify the range of values used on the bounds. More...


virtual void	SetXOrigin (double)
	Explicitly specify an origin for the axes. More...

virtual void	SetYOrigin (double)
	Explicitly specify an origin for the axes. More...

virtual void	SetZOrigin (double)
	Explicitly specify an origin for the axes. More...


virtual void	SetUseRanges (vtkTypeBool)
	Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges. More...

virtual vtkTypeBool	GetUseRanges ()
	Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges. More...

virtual void	UseRangesOn ()
	Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges. More...

virtual void	UseRangesOff ()
	Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges. More...


virtual void	SetCamera (vtkCamera *)
	Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor2D. More...

virtual vtkCamera *	GetCamera ()
	Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor2D. More...


virtual void	SetFlyMode (int)
	Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes. More...

virtual int	GetFlyMode ()
	Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes. More...

void	SetFlyModeToOuterEdges ()
	Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes. More...

void	SetFlyModeToClosestTriad ()
	Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes. More...

void	SetFlyModeToNone ()
	Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes. More...


virtual void	SetScaling (vtkTypeBool)
	Set/Get a flag that controls whether the axes are scaled to fit in the viewport. More...

virtual vtkTypeBool	GetScaling ()
	Set/Get a flag that controls whether the axes are scaled to fit in the viewport. More...

virtual void	ScalingOn ()
	Set/Get a flag that controls whether the axes are scaled to fit in the viewport. More...

virtual void	ScalingOff ()
	Set/Get a flag that controls whether the axes are scaled to fit in the viewport. More...


virtual void	SetNumberOfLabels (int)
	Set/Get the number of annotation labels to show along the x, y, and z axes. More...

virtual int	GetNumberOfLabels ()
	Set/Get the number of annotation labels to show along the x, y, and z axes. More...


virtual void	SetXLabel (const char *)
	Set/Get the labels for the x, y, and z axes. More...

virtual char *	GetXLabel ()
	Set/Get the labels for the x, y, and z axes. More...

virtual void	SetYLabel (const char *)
	Set/Get the labels for the x, y, and z axes. More...

virtual char *	GetYLabel ()
	Set/Get the labels for the x, y, and z axes. More...

virtual void	SetZLabel (const char *)
	Set/Get the labels for the x, y, and z axes. More...

virtual char *	GetZLabel ()
	Set/Get the labels for the x, y, and z axes. More...


virtual void	SetAxisTitleTextProperty (vtkTextProperty *p)
	Set/Get the title text property of all axes. More...

virtual vtkTextProperty *	GetAxisTitleTextProperty ()
	Set/Get the title text property of all axes. More...


virtual void	SetAxisLabelTextProperty (vtkTextProperty *p)
	Set/Get the labels text property of all axes. More...

virtual vtkTextProperty *	GetAxisLabelTextProperty ()
	Set/Get the labels text property of all axes. More...


virtual void	SetLabelFormat (const char *)
	Set/Get the format with which to print the labels on each of the x-y-z axes. More...

virtual char *	GetLabelFormat ()
	Set/Get the format with which to print the labels on each of the x-y-z axes. More...


virtual void	SetFontFactor (double)
	Set/Get the factor that controls the overall size of the fonts used to label and title the axes. More...

virtual double	GetFontFactor ()
	Set/Get the factor that controls the overall size of the fonts used to label and title the axes. More...


virtual void	SetInertia (int)
	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). More...

virtual int	GetInertia ()
	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). More...


virtual void	SetShowActualBounds (int)
	Set/Get the variable that controls whether the actual bounds of the dataset are always shown. More...

virtual int	GetShowActualBounds ()
	Set/Get the variable that controls whether the actual bounds of the dataset are always shown. More...


virtual void	SetCornerOffset (double)
	Specify an offset value to "pull back" the axes from the corner at which they are joined to avoid overlap of axes labels. More...

virtual double	GetCornerOffset ()
	Specify an offset value to "pull back" the axes from the corner at which they are joined to avoid overlap of axes labels. More...


virtual void	SetXAxisVisibility (vtkTypeBool)
	Turn on and off the visibility of each axis. More...

virtual vtkTypeBool	GetXAxisVisibility ()
	Turn on and off the visibility of each axis. More...

virtual void	XAxisVisibilityOn ()
	Turn on and off the visibility of each axis. More...

virtual void	XAxisVisibilityOff ()
	Turn on and off the visibility of each axis. More...

virtual void	SetYAxisVisibility (vtkTypeBool)
	Turn on and off the visibility of each axis. More...

virtual vtkTypeBool	GetYAxisVisibility ()
	Turn on and off the visibility of each axis. More...

virtual void	YAxisVisibilityOn ()
	Turn on and off the visibility of each axis. More...

virtual void	YAxisVisibilityOff ()
	Turn on and off the visibility of each axis. More...

virtual void	SetZAxisVisibility (vtkTypeBool)
	Turn on and off the visibility of each axis. More...

virtual vtkTypeBool	GetZAxisVisibility ()
	Turn on and off the visibility of each axis. More...

virtual void	ZAxisVisibilityOn ()
	Turn on and off the visibility of each axis. More...

virtual void	ZAxisVisibilityOff ()
	Turn on and off the visibility of each axis. More...

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkActor2D *	NewInstance () const

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry? More...

vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D. More...

virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D. More...

void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates. More...

vtkMTimeType	GetMTime () override
	Return this objects MTime. More...

void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor. More...

virtual vtkCoordinate *	GetActualPositionCoordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...

int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods. More...

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods. More...

virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn. More...

virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn. More...

virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render. More...

virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render. More...

virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable. More...

virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable. More...

virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable. More...

virtual float *	GetPosition2 ()
	Access the Position2 instance variable. More...

void	SetWidth (double w)
	Set/Get the height and width of the Actor2D. More...

double	GetWidth ()
	Set/Get the height and width of the Actor2D. More...

void	SetHeight (double h)
	Set/Get the height and width of the Actor2D. More...

double	GetHeight ()
	Set/Get the height and width of the Actor2D. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual 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 void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp. More...

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp. More...

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable. More...

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOn ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOff ()
	Set/Get the pickable instance variable. More...

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable. More...

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,. More...

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkCubeAxesActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkCubeAxesActor2D *	New ()
	Instantiate object with bold, italic, and shadow enabled; font family set to Arial; and label format "6.3g". More...

Static Public Member Functions inherited from vtkActor2D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. More...

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	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 vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	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 vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCubeAxesActor2D ()

	~vtkCubeAxesActor2D () override

void	TransformBounds (vtkViewport *viewport, double bounds[6], double pts[8][3])

int	ClipBounds (vtkViewport *viewport, double pts[8][3], double bounds[6])

double	EvaluatePoint (double planes[24], double x[3])

double	EvaluateBounds (double planes[24], double bounds[6])

void	AdjustAxes (double pts[8][3], double bounds[6], int idx, int xIdx, int yIdx, int zIdx, int zIdx2, int xAxes, int yAxes, int zAxes, double xCoords[4], double yCoords[4], double zCoords[4], double xRange[2], double yRange[2], double zRange[2])

Protected Member Functions inherited from vtkActor2D
	vtkActor2D ()

	~vtkActor2D () override

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCubeAxesActor2DConnection *	ConnectionHolder

vtkProp *	ViewProp

double	Bounds [6]

double	Ranges [6]

vtkTypeBool	UseRanges

vtkCamera *	Camera

int	FlyMode

vtkTypeBool	Scaling

vtkAxisActor2D *	XAxis

vtkAxisActor2D *	YAxis

vtkAxisActor2D *	ZAxis

vtkTextProperty *	AxisTitleTextProperty

vtkTextProperty *	AxisLabelTextProperty

vtkTimeStamp	BuildTime

int	NumberOfLabels

char *	XLabel

char *	YLabel

char *	ZLabel

char *	Labels [3]

vtkTypeBool	XAxisVisibility

vtkTypeBool	YAxisVisibility

vtkTypeBool	ZAxisVisibility

char *	LabelFormat

double	FontFactor

double	CornerOffset

int	Inertia

int	RenderCount

int	InertiaAxes [8]

int	RenderSomething

int	ShowActualBounds

double	XOrigin

double	YOrigin

double	ZOrigin

Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

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

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 2D plot of a bounding box edges - used for navigation

vtkCubeAxesActor2D is a composite actor that draws three axes of the bounding box of an input dataset. The axes include labels and titles for the x-y-z axes. The algorithm selects the axes that are on the "exterior" of the bounding box, exterior as determined from examining outer edges of the bounding box in projection (display) space. Alternatively, the edges closest to the viewer (i.e., camera position) can be drawn.

To use this object you must define a bounding box and the camera used to render the vtkCubeAxesActor2D. The camera is used to control the scaling and position of the vtkCubeAxesActor2D so that it fits in the viewport and always remains visible.)

The font property of the axes titles and labels can be modified through the AxisTitleTextProperty and AxisLabelTextProperty attributes. You may also use the GetXAxisActor2D, GetYAxisActor2D or GetZAxisActor2D methods to access each individual axis actor to modify their font properties.

The bounding box to use is defined in one of three ways. First, if the Input ivar is defined, then the input dataset's bounds is used. If the Input is not defined, and the Prop (superclass of all actors) is defined, then the Prop's bounds is used. If neither the Input or Prop is defined, then the Bounds instance variable (an array of six doubles) is used.

See also: vtkActor2D vtkAxisActor2D vtkXYPlotActor vtkTextProperty

Examples:: vtkCubeAxesActor2D (Examples)

Tests:: vtkCubeAxesActor2D (Tests)

Definition at line 65 of file vtkCubeAxesActor2D.h.

Member Typedef Documentation

typedef vtkActor2D vtkCubeAxesActor2D::Superclass

Definition at line 68 of file vtkCubeAxesActor2D.h.

Member Enumeration Documentation

enum vtkCubeAxesActor2D::FlyMode

Enumerator
VTK_FLY_OUTER_EDGES
VTK_FLY_CLOSEST_TRIAD
VTK_FLY_NONE

Definition at line 171 of file vtkCubeAxesActor2D.h.

Constructor & Destructor Documentation

vtkCubeAxesActor2D::vtkCubeAxesActor2D ( )

protected

vtkCubeAxesActor2D::~vtkCubeAxesActor2D ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool vtkCubeAxesActor2D::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 vtkActor2D.

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

static

virtual vtkObjectBase* vtkCubeAxesActor2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

vtkCubeAxesActor2D* vtkCubeAxesActor2D::NewInstance ( ) const

void vtkCubeAxesActor2D::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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

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

Reimplemented from vtkObject.

static vtkCubeAxesActor2D* vtkCubeAxesActor2D::New ( )

static

Instantiate object with bold, italic, and shadow enabled; font family set to Arial; and label format "6.3g".

The number of labels per axis is set to 3.

int vtkCubeAxesActor2D::RenderOverlay ( vtkViewport * )

overridevirtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkProp.

int vtkCubeAxesActor2D::RenderOpaqueGeometry ( vtkViewport * )

overridevirtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkProp.

int vtkCubeAxesActor2D::RenderTranslucentPolygonalGeometry ( vtkViewport * )

inlineoverridevirtual

Draw the axes as per the vtkProp superclass' API.

Reimplemented from vtkProp.

Definition at line 84 of file vtkCubeAxesActor2D.h.

vtkTypeBool vtkCubeAxesActor2D::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

virtual void vtkCubeAxesActor2D::SetInputConnection ( vtkAlgorithmOutput * )

virtual

Use the bounding box of this input dataset to draw the cube axes.

If this is not specified, then the class will attempt to determine the bounds from the defined Prop or Bounds.

virtual void vtkCubeAxesActor2D::SetInputData ( vtkDataSet * )

virtual

Use the bounding box of this input dataset to draw the cube axes.

If this is not specified, then the class will attempt to determine the bounds from the defined Prop or Bounds.

virtual vtkDataSet* vtkCubeAxesActor2D::GetInput ( )

virtual

Use the bounding box of this input dataset to draw the cube axes.

If this is not specified, then the class will attempt to determine the bounds from the defined Prop or Bounds.

void vtkCubeAxesActor2D::SetViewProp ( vtkProp * prop )

Use the bounding box of this prop to draw the cube axes.

The ViewProp is used to determine the bounds only if the Input is not defined.

virtual vtkProp* vtkCubeAxesActor2D::GetViewProp ( )

virtual

Use the bounding box of this prop to draw the cube axes.

The ViewProp is used to determine the bounds only if the Input is not defined.

virtual void vtkCubeAxesActor2D::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 vtkCubeAxesActor2D::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* vtkCubeAxesActor2D::GetBounds ( )

overridevirtual

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

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

virtual void vtkCubeAxesActor2D::SetRanges	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Explicitly specify the range of values used on the bounds.

The ranges are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

virtual void vtkCubeAxesActor2D::SetRanges ( double [6] )

virtual

Explicitly specify the range of values used on the bounds.

The ranges are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

double* vtkCubeAxesActor2D::GetRanges ( )

Explicitly specify the range of values used on the bounds.

The ranges are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

void vtkCubeAxesActor2D::GetRanges	(	double &	xmin,
		double &	xmax,
		double &	ymin,
		double &	ymax,
		double &	zmin,
		double &	zmax
	)

Explicitly specify the range of values used on the bounds.

The ranges are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

void vtkCubeAxesActor2D::GetRanges ( double ranges[6] )

Explicitly specify the range of values used on the bounds.

The ranges are specified according to (xmin,xmax, ymin,ymax, zmin,zmax), making sure that the min's are less than the max's.

virtual void vtkCubeAxesActor2D::SetXOrigin ( double )

virtual

Explicitly specify an origin for the axes.

These usually intersect at one of the corners of the bounding box, however users have the option to override this if necessary

virtual void vtkCubeAxesActor2D::SetYOrigin ( double )

virtual

Explicitly specify an origin for the axes.

These usually intersect at one of the corners of the bounding box, however users have the option to override this if necessary

virtual void vtkCubeAxesActor2D::SetZOrigin ( double )

virtual

Explicitly specify an origin for the axes.

These usually intersect at one of the corners of the bounding box, however users have the option to override this if necessary

virtual void vtkCubeAxesActor2D::SetUseRanges ( vtkTypeBool )

virtual

Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges.

By default the axes use the data ranges.

virtual vtkTypeBool vtkCubeAxesActor2D::GetUseRanges ( )

virtual

Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges.

By default the axes use the data ranges.

virtual void vtkCubeAxesActor2D::UseRangesOn ( )

virtual

Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges.

By default the axes use the data ranges.

virtual void vtkCubeAxesActor2D::UseRangesOff ( )

virtual

Set/Get a flag that controls whether the axes use the data ranges or the ranges set by SetRanges.

By default the axes use the data ranges.

virtual void vtkCubeAxesActor2D::SetCamera ( vtkCamera * )

virtual

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

virtual vtkCamera* vtkCubeAxesActor2D::GetCamera ( )

virtual

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

virtual void vtkCubeAxesActor2D::SetFlyMode ( int )

virtual

Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes.

virtual int vtkCubeAxesActor2D::GetFlyMode ( )

virtual

Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes.

void vtkCubeAxesActor2D::SetFlyModeToOuterEdges ( )

inline

Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes.

Definition at line 186 of file vtkCubeAxesActor2D.h.

void vtkCubeAxesActor2D::SetFlyModeToClosestTriad ( )

inline

Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes.

Definition at line 188 of file vtkCubeAxesActor2D.h.

void vtkCubeAxesActor2D::SetFlyModeToNone ( )

inline

Specify a mode to control how the axes are drawn: either outer edges or closest triad to the camera position, or you may also disable flying of the axes.

Definition at line 190 of file vtkCubeAxesActor2D.h.

virtual void vtkCubeAxesActor2D::SetScaling ( vtkTypeBool )

virtual

Set/Get a flag that controls whether the axes are scaled to fit in the viewport.

If off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the axes are scaled to fit inside the viewport.

virtual vtkTypeBool vtkCubeAxesActor2D::GetScaling ( )

virtual

Set/Get a flag that controls whether the axes are scaled to fit in the viewport.

If off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the axes are scaled to fit inside the viewport.

virtual void vtkCubeAxesActor2D::ScalingOn ( )

virtual

Set/Get a flag that controls whether the axes are scaled to fit in the viewport.

If off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the axes are scaled to fit inside the viewport.

virtual void vtkCubeAxesActor2D::ScalingOff ( )

virtual

Set/Get a flag that controls whether the axes are scaled to fit in the viewport.

If off, the axes size remains constant (i.e., stay the size of the bounding box). By default scaling is on so the axes are scaled to fit inside the viewport.

virtual void vtkCubeAxesActor2D::SetNumberOfLabels ( int )

virtual

Set/Get the number of annotation labels to show along the x, y, and z axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data.

virtual int vtkCubeAxesActor2D::GetNumberOfLabels ( )

virtual

Set/Get the number of annotation labels to show along the x, y, and z axes.

This values is a suggestion: the number of labels may vary depending on the particulars of the data.

virtual void vtkCubeAxesActor2D::SetXLabel ( const char * )

virtual

Set/Get the labels for the x, y, and z axes.

By default, use "X", "Y" and "Z".

virtual char* vtkCubeAxesActor2D::GetXLabel ( )

virtual

Set/Get the labels for the x, y, and z axes.

By default, use "X", "Y" and "Z".

virtual void vtkCubeAxesActor2D::SetYLabel ( const char * )

virtual

Set/Get the labels for the x, y, and z axes.

By default, use "X", "Y" and "Z".

virtual char* vtkCubeAxesActor2D::GetYLabel ( )

virtual

Set/Get the labels for the x, y, and z axes.

By default, use "X", "Y" and "Z".

virtual void vtkCubeAxesActor2D::SetZLabel ( const char * )

virtual

Set/Get the labels for the x, y, and z axes.

By default, use "X", "Y" and "Z".

virtual char* vtkCubeAxesActor2D::GetZLabel ( )

virtual

Set/Get the labels for the x, y, and z axes.

By default, use "X", "Y" and "Z".

vtkAxisActor2D* vtkCubeAxesActor2D::GetXAxisActor2D ( )

inline

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

Definition at line 233 of file vtkCubeAxesActor2D.h.

vtkAxisActor2D* vtkCubeAxesActor2D::GetYAxisActor2D ( )

inline

Definition at line 235 of file vtkCubeAxesActor2D.h.

vtkAxisActor2D* vtkCubeAxesActor2D::GetZAxisActor2D ( )

inline

Definition at line 237 of file vtkCubeAxesActor2D.h.

virtual void vtkCubeAxesActor2D::SetAxisTitleTextProperty ( vtkTextProperty * p )

virtual

Set/Get the title text property of all axes.

Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.

virtual vtkTextProperty* vtkCubeAxesActor2D::GetAxisTitleTextProperty ( )

virtual

Set/Get the title text property of all axes.

Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.

virtual void vtkCubeAxesActor2D::SetAxisLabelTextProperty ( vtkTextProperty * p )

virtual

Set/Get the labels text property of all axes.

Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.

virtual vtkTextProperty* vtkCubeAxesActor2D::GetAxisLabelTextProperty ( )

virtual

Set/Get the labels text property of all axes.

Note that each axis can be controlled individually through the GetX/Y/ZAxisActor2D() methods.

virtual void vtkCubeAxesActor2D::SetLabelFormat ( const char * )

virtual

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

virtual char* vtkCubeAxesActor2D::GetLabelFormat ( )

virtual

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

virtual void vtkCubeAxesActor2D::SetFontFactor ( double )

virtual

Set/Get the factor that controls the overall size of the fonts used to label and title the axes.

virtual double vtkCubeAxesActor2D::GetFontFactor ( )

virtual

Set/Get the factor that controls the overall size of the fonts used to label and title the axes.

virtual void vtkCubeAxesActor2D::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 vtkCubeAxesActor2D::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 vtkCubeAxesActor2D::SetShowActualBounds ( int )

virtual

Set/Get the variable that controls whether the actual bounds of the dataset are always shown.

Setting this variable to 1 means that clipping is disabled and that the actual value of the bounds is displayed even with corner offsets Setting this variable to 0 means these axis will clip themselves and show variable bounds (legacy mode)

virtual int vtkCubeAxesActor2D::GetShowActualBounds ( )

virtual

Set/Get the variable that controls whether the actual bounds of the dataset are always shown.

Setting this variable to 1 means that clipping is disabled and that the actual value of the bounds is displayed even with corner offsets Setting this variable to 0 means these axis will clip themselves and show variable bounds (legacy mode)

virtual void vtkCubeAxesActor2D::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 vtkCubeAxesActor2D::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 vtkCubeAxesActor2D::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.

virtual void vtkCubeAxesActor2D::SetXAxisVisibility ( vtkTypeBool )

virtual