actor for a cube-axes like prop in the 3D view. More...

#include <vtkGridAxesActor3D.h>

Inheritance diagram for vtkGridAxesActor3D:

Collaboration diagram for vtkGridAxesActor3D:

Public Types
typedef vtkProp3D	Superclass

Public Types inherited from vtkProp3D
typedef vtkProp	Superclass

enum	CoordinateSystems { WORLD = 0 , PHYSICAL = 1 , DEVICE = 2 }
	Specify the coordinate system that this prop is relative to. More...

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.

vtkGridAxesActor3D *	NewInstance () const

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

void	ShallowCopy (vtkProp *prop) override
	Shallow copy from another vtkGridAxesActor3D.

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

void	UpdateGeometry (vtkViewport *vp)
	Updates the billboard geometry without performing any rendering, to assist GetActors().

virtual void	GetRenderedBounds (double bounds[6])
	Get an bounding box that is expected to contain all rendered elements, since GetBounds() returns the bounding box the grid axes describes.

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


virtual void	SetGridBounds (double, double, double, double, double, double)
	Set the bounding box defining the grid space.

virtual void	SetGridBounds (double[6])
	Set the bounding box defining the grid space.

virtual double *	GetGridBounds ()
	Set the bounding box defining the grid space.

virtual void	GetGridBounds (double &, double &, double &, double &, double &, double &)
	Set the bounding box defining the grid space.

virtual void	GetGridBounds (double[6])
	Set the bounding box defining the grid space.


virtual void	SetFaceMask (unsigned int mask)
	Set the mask to select faces.

virtual unsigned int	GetFaceMask ()
	Set the mask to select faces.


virtual void	SetLabelMask (unsigned int mask)
	Set the axis to label.

unsigned int	GetLabelMask ()
	Set the axis to label.


virtual void	SetLabelUniqueEdgesOnly (bool)
	Set to true to only label edges shared with 1 face.

virtual bool	GetLabelUniqueEdgesOnly ()
	Set to true to only label edges shared with 1 face.


void	SetGenerateGrid (bool val)
	Turn off to not generate polydata for the plane's grid.

bool	GetGenerateGrid ()
	Turn off to not generate polydata for the plane's grid.

virtual void	GenerateGridOn ()
	Turn off to not generate polydata for the plane's grid.

virtual void	GenerateGridOff ()
	Turn off to not generate polydata for the plane's grid.


void	SetGenerateEdges (bool val)
	Turn off to not generate the polydata for the plane's edges.

bool	GetGenerateEdges ()
	Turn off to not generate the polydata for the plane's edges.

virtual void	GenerateEdgesOn ()
	Turn off to not generate the polydata for the plane's edges.

virtual void	GenerateEdgesOff ()
	Turn off to not generate the polydata for the plane's edges.


void	SetGenerateTicks (bool val)
	Turn off to not generate the markers for the tick positions.

bool	GetGenerateTicks ()
	Turn off to not generate the markers for the tick positions.

virtual void	GenerateTicksOn ()
	Turn off to not generate the markers for the tick positions.

virtual void	GenerateTicksOff ()
	Turn off to not generate the markers for the tick positions.


void	SetProperty (vtkProperty *)
	Get/Set the property used to control the appearance of the rendered grid.

vtkProperty *	GetProperty ()
	Get/Set the property used to control the appearance of the rendered grid.


void	SetTitleTextProperty (int axis, vtkTextProperty *)
	Get/Set the vtkTextProperty for the title for each the axes.

void	SetXTitleTextProperty (vtkTextProperty *prop)
	Get/Set the vtkTextProperty for the title for each the axes.

void	SetYTitleTextProperty (vtkTextProperty *prop)
	Get/Set the vtkTextProperty for the title for each the axes.

void	SetZTitleTextProperty (vtkTextProperty *prop)
	Get/Set the vtkTextProperty for the title for each the axes.

vtkTextProperty *	GetTitleTextProperty (int axis)
	Get/Set the vtkTextProperty for the title for each the axes.


void	SetTitle (int axis, const std::string &title)
	Get/Set the text to use for titles for the axis.

void	SetXTitle (const std::string &title)
	Get/Set the text to use for titles for the axis.

void	SetYTitle (const std::string &title)
	Get/Set the text to use for titles for the axis.

void	SetZTitle (const std::string &title)
	Get/Set the text to use for titles for the axis.

const std::string &	GetTitle (int axis)
	Get/Set the text to use for titles for the axis.


void	SetUseCustomLabels (int axis, bool val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetXUseCustomLabels (bool val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetYUseCustomLabels (bool val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetZUseCustomLabels (bool val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetNumberOfLabels (int axis, vtkIdType val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetNumberOfXLabels (vtkIdType val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetNumberOfYLabels (vtkIdType val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetNumberOfZLabels (vtkIdType val)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetLabel (int axis, vtkIdType index, double value)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetXLabel (vtkIdType index, double value)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetYLabel (vtkIdType index, double value)
	Set whether the specified axis should use custom labels instead of automatically determined ones.

void	SetZLabel (vtkIdType index, double value)
	Set whether the specified axis should use custom labels instead of automatically determined ones.


void	SetLabelTextProperty (int axis, vtkTextProperty *)
	Get/Set the vtkTextProperty that governs how the axis labels are displayed.

void	SetXLabelTextProperty (vtkTextProperty *prop)
	Get/Set the vtkTextProperty that governs how the axis labels are displayed.

void	SetYLabelTextProperty (vtkTextProperty *prop)
	Get/Set the vtkTextProperty that governs how the axis labels are displayed.

void	SetZLabelTextProperty (vtkTextProperty *prop)
	Get/Set the vtkTextProperty that governs how the axis labels are displayed.

vtkTextProperty *	GetLabelTextProperty (int axis)
	Get/Set the vtkTextProperty that governs how the axis labels are displayed.


void	SetNotation (int axis, int notation)
	Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).

void	SetXNotation (int notation)
	Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).

void	SetYNotation (int notation)
	Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).

void	SetZNotation (int notation)
	Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).

int	GetNotation (int axis)
	Get/set the numerical notation, standard, scientific or mixed (0, 1, 2).


void	SetPrecision (int axis, int val)
	Get/set the numerical precision to use, default is 2.

void	SetXPrecision (int val)
	Get/set the numerical precision to use, default is 2.

void	SetYPrecision (int val)
	Get/set the numerical precision to use, default is 2.

void	SetZPrecision (int val)
	Get/set the numerical precision to use, default is 2.

int	GetPrecision (int axis)
	Get/set the numerical precision to use, default is 2.


void	SetTickLabelFunction (int axis, std::function< double(double)> func)
	Get/Set the function that will be applied to the tick label of each axis.

std::function< double(double)>	GetTickLabelFunction (int axis)
	Get/Set the function that will be applied to the tick label of each axis.


double *	GetBounds () override
	Returns the prop bounds.

void	GetBounds (double bounds[6])
	Return a reference to the Prop3D's composite transform.

double *	GetBounds () override=0
	Returns the prop bounds.


virtual void	SetForceOpaque (bool)
	If true, the actor will always be rendered during the opaque pass.

virtual bool	GetForceOpaque ()
	If true, the actor will always be rendered during the opaque pass.

virtual void	ForceOpaqueOn ()
	If true, the actor will always be rendered during the opaque pass.

virtual void	ForceOpaqueOff ()
	If true, the actor will always be rendered during the opaque pass.


int	RenderOpaqueGeometry (vtkViewport *) override
	Standard render methods for different types of geometry.

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Standard render methods for different types of geometry.

int	RenderOverlay (vtkViewport *viewport) override
	Standard render methods for different types of geometry.

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Standard render methods for different types of geometry.


virtual void	SetLabelDisplayOffset (int xoffset, int yoffset)
	Set/Get the label display offset.

virtual void	SetLabelDisplayOffset (const int offset[2])
	Set/Get the label display offset.

virtual int *	GetLabelDisplayOffset ()
	Set/Get the label display offset.

virtual VTK_WRAPEXCLUDE void	GetLabelDisplayOffset (int &xoffset, int &yoffset)
	Set/Get the label display offset.

virtual VTK_WRAPEXCLUDE void	GetLabelDisplayOffset (int offset[2])
	Set/Get the label display offset.

Public Member Functions inherited from vtkProp3D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp3D *	NewInstance () const

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

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

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)

void	SetScale (double s)
	Method to set the scale isotropically.

virtual void	SetPropertiesFromModelToWorldMatrix (vtkMatrix4x4 *modelToWorld)
	Set the position, scale, orientation from a provided model to world matrix.

double *	GetCenter ()
	Get the center of the bounding box in world coordinates.

double *	GetXRange ()
	Get the Prop3D's x range in world coordinates.

double *	GetYRange ()
	Get the Prop3D's y range in world coordinates.

double *	GetZRange ()
	Get the Prop3D's z range in world coordinates.

double	GetLength ()
	Get the length of the diagonal of the bounding box.

void	RotateX (double)
	Rotate the Prop3D in degrees about the X axis using the right hand rule.

void	RotateY (double)
	Rotate the Prop3D in degrees about the Y axis using the right hand rule.

void	RotateZ (double)
	Rotate the Prop3D in degrees about the Z axis using the right hand rule.

void	RotateWXYZ (double w, double x, double y, double z)
	Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments.

void	SetOrientation (double x, double y, double z)
	Sets the orientation of the Prop3D.

void	SetOrientation (double orientation[3])
	Sets the orientation of the Prop3D.

double *	GetOrientationWXYZ ()
	Returns the WXYZ orientation of the Prop3D.

void	AddOrientation (double x, double y, double z)
	Add to the current orientation.

void	AddOrientation (double orentation[3])
	Add to the current orientation.

void	PokeMatrix (vtkMatrix4x4 *matrix) override
	This method modifies the vtkProp3D so that its transformation state is set to the matrix specified.

void	InitPathTraversal () override
	Overload vtkProp's method for setting up assembly paths.

vtkMTimeType	GetMTime () override
	Get the vtkProp3D's mtime.

vtkMTimeType	GetUserTransformMatrixMTime ()
	Get the modified time of the user matrix or user transform.

virtual void	SetPosition (double x, double y, double z)
	Set/Get/Add the position of the Prop3D in world coordinates.

virtual void	SetOrigin (double x, double y, double z)
	Set/Get the origin of the Prop3D.

virtual void	SetOrigin (const double pos[3])
	Set/Get the origin of the Prop3D.

virtual double *	GetOrigin ()
	Set/Get the origin of the Prop3D.

virtual void	GetOrigin (double data[3])
	Set/Get the origin of the Prop3D.

virtual void	SetScale (double x, double y, double z)
	Set/Get the scale of the actor.

virtual void	SetScale (double scale[3])
	Set/Get the scale of the actor.

virtual double *	GetScale ()
	Set/Get the scale of the actor.

virtual void	GetScale (double data[3])
	Set/Get the scale of the actor.

void	SetUserTransform (vtkLinearTransform *transform)
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.

virtual vtkLinearTransform *	GetUserTransform ()
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.

void	SetUserMatrix (vtkMatrix4x4 *matrix)
	The UserMatrix can be used in place of UserTransform.

vtkMatrix4x4 *	GetUserMatrix ()
	The UserMatrix can be used in place of UserTransform.

virtual void	GetMatrix (vtkMatrix4x4 *result)
	Return a reference to the Prop3D's 4x4 composite matrix.

virtual void	GetMatrix (double result[16])
	Return a reference to the Prop3D's 4x4 composite matrix.

virtual void	GetModelToWorldMatrix (vtkMatrix4x4 *result)
	Return a reference to the Prop3D's Model to World matrix.

void	GetBounds (double bounds[6])
	Return a reference to the Prop3D's composite transform.

double *	GetOrientation ()
	Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.

void	GetOrientation (double orentation[3])
	Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.

virtual void	ComputeMatrix ()
	Generate the matrix based on ivars.

vtkMatrix4x4 *	GetMatrix () override
	Get a pointer to an internal vtkMatrix4x4.

virtual vtkTypeBool	GetIsIdentity ()
	Is the matrix for this actor identity.

void	SetCoordinateSystemRenderer (vtkRenderer *ren)
	Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.

vtkRenderer *	GetCoordinateSystemRenderer ()
	Specify the Renderer that the prop3d is relative to when the coordinate system is set to PHYSICAL or DEVICE.

virtual void	SetCoordinateSystemDevice (int)
	Specify the device to be used when the coordinate system is set to DEVICE.

virtual int	GetCoordinateSystemDevice ()
	Specify the device to be used when the coordinate system is set to DEVICE.

void	SetCoordinateSystemToWorld ()
	Specify the coordinate system that this prop is relative to.

void	SetCoordinateSystemToPhysical ()
	Specify the coordinate system that this prop is relative to.

void	SetCoordinateSystemToDevice ()
	Specify the coordinate system that this prop is relative to.

void	SetCoordinateSystem (CoordinateSystems val)
	Specify the coordinate system that this prop is relative to.

virtual CoordinateSystems	GetCoordinateSystem ()
	Specify the coordinate system that this prop is relative to.

const char *	GetCoordinateSystemAsString ()
	Specify the coordinate system that this prop is relative to.

Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkProp *	NewInstance () const

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

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

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

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

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

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

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.

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

virtual vtkMatrix4x4 *	GetMatrix ()

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

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

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

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

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

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

virtual vtkTypeBool	HasTranslucentPolygonalGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

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.

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.

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.

virtual void	AddEstimatedRenderTime (double t, vtkViewport *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.

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.

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.

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.

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	SetAllocatedRenderTime (double t, vtkViewport *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.

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

virtual int	GetNumberOfConsumers ()
	Get the number of consumers.

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

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

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

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

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.

virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkGridAxesActor3D *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGridAxesActor3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkProp3D *	SafeDownCast (vtkObjectBase *o)

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.

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.

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.

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

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGridAxesActor3D ()

	~vtkGridAxesActor3D () override

virtual void	Update (vtkViewport *viewport)

Protected Member Functions inherited from vtkProp3D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp3D ()

	~vtkProp3D () override

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	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.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

vtkTypeBool	IsIdentity

int	CoordinateSystemDevice

CoordinateSystems	CoordinateSystem = WORLD

vtkWeakPointer< vtkRenderer >	CoordinateSystemRenderer

vtkNew< vtkMatrix4x4 >	TempMatrix4x4

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

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

actor for a cube-axes like prop in the 3D view.

vtkGridAxesActor3D is an alternate implementation for something like the vtkCubeAxesActor which can be used to render a 3D grid in a scene. It uses vtkGridAxesActor3D to render individual axes planes for the box.

Tests:: vtkGridAxesActor3D (Tests)

Definition at line 35 of file vtkGridAxesActor3D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp3D vtkGridAxesActor3D::Superclass

Definition at line 39 of file vtkGridAxesActor3D.h.

Constructor & Destructor Documentation

◆ vtkGridAxesActor3D()

vtkGridAxesActor3D::vtkGridAxesActor3D ( )

protected

◆ ~vtkGridAxesActor3D()

vtkGridAxesActor3D::~vtkGridAxesActor3D ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGridAxesActor3D * vtkGridAxesActor3D::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkGridAxesActor3D::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkProp3D.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGridAxesActor3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp3D.

◆ NewInstance()

vtkGridAxesActor3D * vtkGridAxesActor3D::NewInstance ( ) const

◆ PrintSelf()

void vtkGridAxesActor3D::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 vtkObjectBase.

◆ ShallowCopy()

void vtkGridAxesActor3D::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy from another vtkGridAxesActor3D.

Reimplemented from vtkProp.

◆ SetGridBounds() [1/2]

virtual void vtkGridAxesActor3D::SetGridBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Set the bounding box defining the grid space.

This, together with the Face identify which planar surface this class is interested in. This class is designed to work with a single planar surface.

◆ SetGridBounds() [2/2]

virtual void vtkGridAxesActor3D::SetGridBounds ( double [6] )

virtual

Set the bounding box defining the grid space.

This, together with the Face identify which planar surface this class is interested in. This class is designed to work with a single planar surface.

◆ GetGridBounds() [1/3]

virtual double * vtkGridAxesActor3D::GetGridBounds ( )

virtual

Set the bounding box defining the grid space.

This, together with the Face identify which planar surface this class is interested in. This class is designed to work with a single planar surface.

◆ GetGridBounds() [2/3]

virtual void vtkGridAxesActor3D::GetGridBounds	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)

virtual

Set the bounding box defining the grid space.

This, together with the Face identify which planar surface this class is interested in. This class is designed to work with a single planar surface.

◆ GetGridBounds() [3/3]

virtual void vtkGridAxesActor3D::GetGridBounds ( double [6] )

virtual

Set the bounding box defining the grid space.

This, together with the Face identify which planar surface this class is interested in. This class is designed to work with a single planar surface.

◆ SetFaceMask()

virtual void vtkGridAxesActor3D::SetFaceMask ( unsigned int mask )

virtual

Set the mask to select faces.

The faces rendered can be a subset of the faces selected using the FaceMask based on the BackfaceCulling and FrontfaceCulling flags set on the Property.

Defaults to 0.

◆ GetFaceMask()

virtual unsigned int vtkGridAxesActor3D::GetFaceMask ( )

virtual

Set the mask to select faces.

The faces rendered can be a subset of the faces selected using the FaceMask based on the BackfaceCulling and FrontfaceCulling flags set on the Property.

Defaults to 0.

◆ SetLabelMask()

virtual void vtkGridAxesActor3D::SetLabelMask ( unsigned int mask )

virtual

Set the axis to label.

Default is 0xff.

◆ GetLabelMask()

unsigned int vtkGridAxesActor3D::GetLabelMask ( )

Set the axis to label.

Default is 0xff.

◆ GetActors()

void vtkGridAxesActor3D::GetActors ( vtkPropCollection * )

overridevirtual

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

These methods are used in that process. In case the viewport is not a consumer of this prop: call UpdateGeometry() first for updated viewport-specific billboard geometry.

Reimplemented from vtkProp.

◆ UpdateGeometry()

void vtkGridAxesActor3D::UpdateGeometry ( vtkViewport * vp )

Updates the billboard geometry without performing any rendering, to assist GetActors().

◆ SetLabelUniqueEdgesOnly()

virtual void vtkGridAxesActor3D::SetLabelUniqueEdgesOnly ( bool )

virtual

Set to true to only label edges shared with 1 face.

Note that if all faces are being rendered, this will generate no labels.

Default is true.

◆ GetLabelUniqueEdgesOnly()

virtual bool vtkGridAxesActor3D::GetLabelUniqueEdgesOnly ( )

virtual

Set to true to only label edges shared with 1 face.

Note that if all faces are being rendered, this will generate no labels.

Default is true.

◆ SetGenerateGrid()

void vtkGridAxesActor3D::SetGenerateGrid ( bool val )

Turn off to not generate polydata for the plane's grid.

Default is true.

◆ GetGenerateGrid()

bool vtkGridAxesActor3D::GetGenerateGrid ( )

Turn off to not generate polydata for the plane's grid.

Default is true.

◆ GenerateGridOn()

virtual void vtkGridAxesActor3D::GenerateGridOn ( )

virtual

Turn off to not generate polydata for the plane's grid.

Default is true.

◆ GenerateGridOff()

virtual void vtkGridAxesActor3D::GenerateGridOff ( )

virtual

Turn off to not generate polydata for the plane's grid.

Default is true.

◆ SetGenerateEdges()

void vtkGridAxesActor3D::SetGenerateEdges ( bool val )

Turn off to not generate the polydata for the plane's edges.

Which edges are rendered is defined by the EdgeMask.

Default is true.

◆ GetGenerateEdges()

bool vtkGridAxesActor3D::GetGenerateEdges ( )

Turn off to not generate the polydata for the plane's edges.

Which edges are rendered is defined by the EdgeMask.

Default is true.

◆ GenerateEdgesOn()

virtual void vtkGridAxesActor3D::GenerateEdgesOn ( )

virtual

Turn off to not generate the polydata for the plane's edges.

Which edges are rendered is defined by the EdgeMask.

Default is true.

◆ GenerateEdgesOff()

virtual void vtkGridAxesActor3D::GenerateEdgesOff ( )

virtual

Turn off to not generate the polydata for the plane's edges.

Which edges are rendered is defined by the EdgeMask.

Default is true.

◆ SetGenerateTicks()

void vtkGridAxesActor3D::SetGenerateTicks ( bool val )

Turn off to not generate the markers for the tick positions.

Which edges are rendered is defined by the TickMask.

Default is true.

◆ GetGenerateTicks()

bool vtkGridAxesActor3D::GetGenerateTicks ( )

Turn off to not generate the markers for the tick positions.

Which edges are rendered is defined by the TickMask.

Default is true.

◆ GenerateTicksOn()

virtual void vtkGridAxesActor3D::GenerateTicksOn ( )

virtual

Turn off to not generate the markers for the tick positions.

Which edges are rendered is defined by the TickMask.

Default is true.

◆ GenerateTicksOff()

virtual void vtkGridAxesActor3D::GenerateTicksOff ( )

virtual

Turn off to not generate the markers for the tick positions.

Which edges are rendered is defined by the TickMask.

Default is true.

◆ SetProperty()

void vtkGridAxesActor3D::SetProperty ( vtkProperty * )

Get/Set the property used to control the appearance of the rendered grid.

◆ GetProperty()

vtkProperty * vtkGridAxesActor3D::GetProperty ( )

Get/Set the property used to control the appearance of the rendered grid.

◆ SetTitleTextProperty()

void vtkGridAxesActor3D::SetTitleTextProperty	(	int	axis,
		vtkTextProperty *
	)

Get/Set the vtkTextProperty for the title for each the axes.

Note that the alignment properties are not used.

◆ SetXTitleTextProperty()

void vtkGridAxesActor3D::SetXTitleTextProperty ( vtkTextProperty * prop )

inline

Get/Set the vtkTextProperty for the title for each the axes.

Note that the alignment properties are not used.

Definition at line 158 of file vtkGridAxesActor3D.h.

◆ SetYTitleTextProperty()

void vtkGridAxesActor3D::SetYTitleTextProperty ( vtkTextProperty * prop )

inline

Get/Set the vtkTextProperty for the title for each the axes.

Note that the alignment properties are not used.

Definition at line 159 of file vtkGridAxesActor3D.h.

◆ SetZTitleTextProperty()

void vtkGridAxesActor3D::SetZTitleTextProperty ( vtkTextProperty * prop )

inline

Get/Set the vtkTextProperty for the title for each the axes.

Note that the alignment properties are not used.

Definition at line 160 of file vtkGridAxesActor3D.h.

◆ GetTitleTextProperty()

vtkTextProperty * vtkGridAxesActor3D::GetTitleTextProperty ( int axis )

Get/Set the vtkTextProperty for the title for each the axes.

Note that the alignment properties are not used.

◆ SetTitle()

void vtkGridAxesActor3D::SetTitle	(	int	axis,
		const std::string &	title
	)

Get/Set the text to use for titles for the axis.

Setting the title to an empty string will hide the title label for that axis.

Default is empty.

◆ SetXTitle()

void vtkGridAxesActor3D::SetXTitle ( const std::string & title )

inline

Get/Set the text to use for titles for the axis.

Setting the title to an empty string will hide the title label for that axis.

Default is empty.

Definition at line 172 of file vtkGridAxesActor3D.h.

◆ SetYTitle()

void vtkGridAxesActor3D::SetYTitle ( const std::string & title )

inline

Get/Set the text to use for titles for the axis.

Setting the title to an empty string will hide the title label for that axis.

Default is empty.

Definition at line 173 of file vtkGridAxesActor3D.h.

◆ SetZTitle()

void vtkGridAxesActor3D::SetZTitle ( const std::string & title )

inline

Get/Set the text to use for titles for the axis.

Setting the title to an empty string will hide the title label for that axis.

Default is empty.

Definition at line 174 of file vtkGridAxesActor3D.h.

◆ GetTitle()

const std::string & vtkGridAxesActor3D::GetTitle ( int axis )

Get/Set the text to use for titles for the axis.

Setting the title to an empty string will hide the title label for that axis.

Default is empty.