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

#include <vtkGridAxes3DActor.h>

Inheritance diagram for vtkGridAxes3DActor:

[legend]

Collaboration diagram for vtkGridAxes3DActor:

[legend]

Public Types
enum	FaceMasks { MIN_YZ = 0x01, MIN_ZX = 0x02, MIN_XY = 0x04, MAX_YZ = 0x08, MAX_ZX = 0x010, MAX_XY = 0x020 }
	Values for FaceMask. More...

enum	LabelMasks { MIN_X = vtkGridAxesHelper::MIN_X, MIN_Y = vtkGridAxesHelper::MIN_Y, MIN_Z = vtkGridAxesHelper::MIN_Z, MAX_X = vtkGridAxesHelper::MAX_X, MAX_Y = vtkGridAxesHelper::MAX_Y, MAX_Z = vtkGridAxesHelper::MAX_Z }

typedef vtkProp3D	Superclass

Public Types inherited from vtkProp3D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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

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

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

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

void	SetXUseCustomLabels (bool val)

void	SetYUseCustomLabels (bool val)

void	SetZUseCustomLabels (bool val)

void	SetNumberOfLabels (int axis, vtkIdType val)

void	SetNumberOfXLabels (vtkIdType val)

void	SetNumberOfYLabels (vtkIdType val)

void	SetNumberOfZLabels (vtkIdType val)

void	SetLabel (int axis, vtkIdType index, double value)

void	SetXLabel (vtkIdType index, double value)

void	SetYLabel (vtkIdType index, double value)

void	SetZLabel (vtkIdType index, double value)

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

int	RenderOpaqueGeometry (vtkViewport *) override

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override

int	RenderOverlay (vtkViewport *viewport) override

int	HasTranslucentPolygonalGeometry () override

void	ReleaseGraphicsResources (vtkWindow *) override


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

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

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

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

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


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

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


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

unsigned int	GetLabelMask ()
	Set the axis to label. More...


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

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


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

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

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

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


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

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

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

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


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

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

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

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


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

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


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

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

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

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

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


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

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

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

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

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


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

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

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

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

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


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

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

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

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

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


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

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

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

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

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


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

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


double *	GetBounds () override
	Returns the prop bounds. More...


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

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

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

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

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

virtual void	SetPosition (double pos[3])

virtual double *	GetPosition ()

virtual void	GetPosition (double data[3])

void	AddPosition (double deltaPosition[3])

void	AddPosition (double deltaX, double deltaY, double deltaZ)

double *	GetCenter ()

double *	GetXRange ()

double *	GetYRange ()

double *	GetZRange ()

double	GetLength ()

void	RotateX (double)

void	RotateY (double)

void	RotateZ (double)

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

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

void	SetOrientation (double orientation[3])

double *	GetOrientationWXYZ ()

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

void	AddOrientation (double orentation[3])

void	PokeMatrix (vtkMatrix4x4 *matrix)

void	InitPathTraversal ()

vtkMTimeType	GetMTime ()

vtkMTimeType	GetUserTransformMatrixMTime ()

virtual void	ComputeMatrix ()

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

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

virtual void	SetOrigin (const double pos[3])

virtual double *	GetOrigin ()

virtual void	GetOrigin (double data[3])

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

virtual void	SetScale (double scale[3])

virtual double *	GetScale ()

virtual void	GetScale (double data[3])

void	SetScale (double s)

void	SetUserTransform (vtkLinearTransform *transform)

virtual vtkLinearTransform *	GetUserTransform ()

void	SetUserMatrix (vtkMatrix4x4 *matrix)

vtkMatrix4x4 *	GetUserMatrix ()

virtual void	GetMatrix (vtkMatrix4x4 *m)

virtual void	GetMatrix (double m[16])

void	GetBounds (double bounds[6])

double *	GetOrientation ()

void	GetOrientation (double orentation[3])

vtkMatrix4x4 *	GetMatrix ()

virtual int	GetIsIdentity ()

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

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

virtual void	SetOrigin (const double pos[3])

virtual double *	GetOrigin ()

virtual void	GetOrigin (double data[3])

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

virtual void	SetScale (double scale[3])

virtual double *	GetScale ()

virtual void	GetScale (double data[3])

void	SetScale (double s)

void	SetUserTransform (vtkLinearTransform *transform)

virtual vtkLinearTransform *	GetUserTransform ()

void	SetUserMatrix (vtkMatrix4x4 *matrix)

vtkMatrix4x4 *	GetUserMatrix ()

virtual void	GetMatrix (vtkMatrix4x4 *m)

virtual void	GetMatrix (double m[16])

void	GetBounds (double bounds[6])

double *	GetOrientation ()

void	GetOrientation (double orentation[3])

vtkMatrix4x4 *	GetMatrix ()

virtual int	GetIsIdentity ()

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

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

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

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

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

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

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

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

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

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

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkGridAxes3DActor *	New ()

static int	IsTypeOf (const char *type)

static vtkGridAxes3DActor *	SafeDownCast (vtkObject *o)

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

static vtkProp3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkGridAxes3DActor ()

	~vtkGridAxes3DActor () override

virtual void	Update (vtkViewport *viewport)

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

	vtkProp3D ()

	~vtkProp3D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	GridBounds [6]

unsigned int	FaceMask

unsigned int	LabelMask

bool	LabelUniqueEdgesOnly

vtkTuple< bool, 3 >	UseCustomLabels

vtkTuple< vtkNew< vtkDoubleArray >, 3 >	CustomLabels

vtkMTimeType	CustomLabelsMTime

vtkTuple< vtkNew< vtkGridAxes2DActor >, 6 >	GridAxes2DActors

bool	ForceOpaque

Protected Attributes inherited from vtkProp3D
vtkLinearTransform *	UserTransform

vtkMatrix4x4 *	UserMatrix

vtkMatrix4x4 *	Matrix

vtkTimeStamp	MatrixMTime

double	Origin [3]

double	Position [3]

double	Orientation [3]

double	Scale [3]

double	Center [3]

vtkTransform *	Transform

double	Bounds [6]

vtkProp3D *	CachedProp3D

int	IsIdentity

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

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

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

Definition at line 30 of file vtkGridAxes3DActor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp3D vtkGridAxes3DActor::Superclass

Definition at line 34 of file vtkGridAxes3DActor.h.

Member Enumeration Documentation

◆ FaceMasks

enum vtkGridAxes3DActor::FaceMasks

Values for FaceMask.

Developer note: these are deliberately in the same order as vtkGridAxesHelper::Faces which is same order as faces in vtkVoxel.

Enumerator
MIN_YZ
MIN_ZX
MIN_XY
MAX_YZ
MAX_ZX
MAX_XY

Definition at line 57 of file vtkGridAxes3DActor.h.

◆ LabelMasks

enum vtkGridAxes3DActor::LabelMasks

Enumerator
MIN_X
MIN_Y
MIN_Z
MAX_X
MAX_Y
MAX_Z

Definition at line 77 of file vtkGridAxes3DActor.h.

Constructor & Destructor Documentation

◆ vtkGridAxes3DActor()

vtkGridAxes3DActor::vtkGridAxes3DActor ( )

protected

◆ ~vtkGridAxes3DActor()

vtkGridAxes3DActor::~vtkGridAxes3DActor ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGridAxes3DActor* vtkGridAxes3DActor::New ( )

static

◆ GetClassName()

virtual const char* vtkGridAxes3DActor::GetClassName ( )

virtual

Reimplemented in vtkPVGridAxes3DActor.

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkGridAxes3DActor::IsA ( const char * type )

virtual

Reimplemented from vtkProp3D.

Reimplemented in vtkPVGridAxes3DActor.

◆ SafeDownCast()

static vtkGridAxes3DActor* vtkGridAxes3DActor::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkProp3D.

Reimplemented in vtkPVGridAxes3DActor.

◆ ShallowCopy()

void vtkGridAxes3DActor::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy from another vtkGridAxes3DActor.

Reimplemented from vtkProp3D.

Reimplemented in vtkPVGridAxes3DActor.

◆ SetGridBounds() [1/2]

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

◆ GetFaceMask()

virtual unsigned int vtkGridAxes3DActor::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.

◆ SetLabelMask()

virtual void vtkGridAxes3DActor::SetLabelMask ( unsigned int mask )

virtual

Set the axis to label.

◆ GetLabelMask()

unsigned int vtkGridAxes3DActor::GetLabelMask ( )

Set the axis to label.

◆ GetActors()

void vtkGridAxes3DActor::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 vtkGridAxes3DActor::UpdateGeometry ( vtkViewport * vp )

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

◆ SetLabelUniqueEdgesOnly()

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

◆ GetLabelUniqueEdgesOnly()

virtual bool vtkGridAxes3DActor::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.

◆ SetGenerateGrid()

void vtkGridAxes3DActor::SetGenerateGrid ( bool val )

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

◆ GetGenerateGrid()

bool vtkGridAxes3DActor::GetGenerateGrid ( )

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

◆ GenerateGridOn()

virtual void vtkGridAxes3DActor::GenerateGridOn ( )

virtual

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

◆ GenerateGridOff()

virtual void vtkGridAxes3DActor::GenerateGridOff ( )

virtual

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

◆ SetGenerateEdges()

void vtkGridAxes3DActor::SetGenerateEdges ( bool val )

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

Which edges are rendered is defined by the EdgeMask.

◆ GetGenerateEdges()

bool vtkGridAxes3DActor::GetGenerateEdges ( )

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

Which edges are rendered is defined by the EdgeMask.

◆ GenerateEdgesOn()

virtual void vtkGridAxes3DActor::GenerateEdgesOn ( )

virtual

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

Which edges are rendered is defined by the EdgeMask.

◆ GenerateEdgesOff()

virtual void vtkGridAxes3DActor::GenerateEdgesOff ( )

virtual

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

Which edges are rendered is defined by the EdgeMask.

◆ SetGenerateTicks()

void vtkGridAxes3DActor::SetGenerateTicks ( bool val )

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

Which edges are rendered is defined by the TickMask.

◆ GetGenerateTicks()

bool vtkGridAxes3DActor::GetGenerateTicks ( )

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

Which edges are rendered is defined by the TickMask.

◆ GenerateTicksOn()

virtual void vtkGridAxes3DActor::GenerateTicksOn ( )

virtual

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

Which edges are rendered is defined by the TickMask.

◆ GenerateTicksOff()

virtual void vtkGridAxes3DActor::GenerateTicksOff ( )

virtual

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

Which edges are rendered is defined by the TickMask.

◆ SetProperty()

void vtkGridAxes3DActor::SetProperty ( vtkProperty * )

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

◆ GetProperty()

vtkProperty* vtkGridAxes3DActor::GetProperty ( )

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

◆ SetTitleTextProperty()

void vtkGridAxes3DActor::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 vtkGridAxes3DActor::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 166 of file vtkGridAxes3DActor.h.

◆ SetYTitleTextProperty()

void vtkGridAxes3DActor::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 167 of file vtkGridAxes3DActor.h.

◆ SetZTitleTextProperty()

void vtkGridAxes3DActor::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 168 of file vtkGridAxes3DActor.h.

◆ GetTitleTextProperty()

vtkTextProperty* vtkGridAxes3DActor::GetTitleTextProperty ( int axis )

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

Note that the alignment properties are not used.

◆ SetTitle()

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

◆ SetXTitle()

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

Definition at line 178 of file vtkGridAxes3DActor.h.

◆ SetYTitle()

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

Definition at line 179 of file vtkGridAxes3DActor.h.

◆ SetZTitle()

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

Definition at line 180 of file vtkGridAxes3DActor.h.

◆ GetTitle()

const std::string& vtkGridAxes3DActor::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.

◆ SetUseCustomLabels()

void vtkGridAxes3DActor::SetUseCustomLabels	(	int	axis,
		bool	val
	)

Set whether the specified axis should use custom labels instead of automatically determined ones.

◆ SetXUseCustomLabels()

void vtkGridAxes3DActor::SetXUseCustomLabels ( bool val )

inline

Definition at line 189 of file vtkGridAxes3DActor.h.

◆ SetYUseCustomLabels()

void vtkGridAxes3DActor::SetYUseCustomLabels ( bool val )

inline

Definition at line 190 of file vtkGridAxes3DActor.h.

◆ SetZUseCustomLabels()

void vtkGridAxes3DActor::SetZUseCustomLabels ( bool val )

inline

Definition at line 191 of file vtkGridAxes3DActor.h.

◆ SetNumberOfLabels()

void vtkGridAxes3DActor::SetNumberOfLabels	(	int	axis,
		vtkIdType	val
	)

◆ SetNumberOfXLabels()

void vtkGridAxes3DActor::SetNumberOfXLabels ( vtkIdType val )

inline

Definition at line 194 of file vtkGridAxes3DActor.h.

◆ SetNumberOfYLabels()

void vtkGridAxes3DActor::SetNumberOfYLabels ( vtkIdType val )

inline

Definition at line 195 of file vtkGridAxes3DActor.h.

◆ SetNumberOfZLabels()

void vtkGridAxes3DActor::SetNumberOfZLabels ( vtkIdType val )

inline

Definition at line 196 of file vtkGridAxes3DActor.h.

◆ SetLabel()

void vtkGridAxes3DActor::SetLabel	(	int	axis,
		vtkIdType	index,
		double	value
	)

◆ SetXLabel()

void vtkGridAxes3DActor::SetXLabel	(	vtkIdType	index,
		double	value
	)

inline

Definition at line 199 of file vtkGridAxes3DActor.h.

◆ SetYLabel()

void vtkGridAxes3DActor::SetYLabel	(	vtkIdType	index,
		double	value
	)

inline

Definition at line 200 of file vtkGridAxes3DActor.h.

◆ SetZLabel()

void vtkGridAxes3DActor::SetZLabel	(	vtkIdType	index,
		double	value
	)

inline

Definition at line 201 of file vtkGridAxes3DActor.h.

◆ SetLabelTextProperty()

void vtkGridAxes3DActor::SetLabelTextProperty	(	int	axis,
		vtkTextProperty *
	)

Get/Set the vtkTextProperty that governs how the axis labels are displayed.

Note that the alignment properties are not used.

◆ SetXLabelTextProperty()

void vtkGridAxes3DActor::SetXLabelTextProperty ( vtkTextProperty * prop )

inline

Get/Set the vtkTextProperty that governs how the axis labels are displayed.

Note that the alignment properties are not used.

Definition at line 212 of file vtkGridAxes3DActor.h.

◆ SetYLabelTextProperty()

void vtkGridAxes3DActor::SetYLabelTextProperty ( vtkTextProperty * prop )

inline

Get/Set the vtkTextProperty that governs how the axis labels are displayed.

Note that the alignment properties are not used.

Definition at line 213 of file vtkGridAxes3DActor.h.

◆ SetZLabelTextProperty()

void vtkGridAxes3DActor::SetZLabelTextProperty ( vtkTextProperty * prop )

inline

Get/Set the vtkTextProperty that governs how the axis labels are displayed.

Note that the alignment properties are not used.

Definition at line 214 of file vtkGridAxes3DActor.h.

◆ GetLabelTextProperty()

vtkTextProperty* vtkGridAxes3DActor::GetLabelTextProperty ( int axis )

Get/Set the vtkTextProperty that governs how the axis labels are displayed.

Note that the alignment properties are not used.

◆ SetNotation()

void vtkGridAxes3DActor::SetNotation	(	int	axis,
		int	notation
	)

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

Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.

◆ SetXNotation()

void vtkGridAxes3DActor::SetXNotation ( int notation )

inline

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

Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.

Definition at line 224 of file vtkGridAxes3DActor.h.

◆ SetYNotation()

void vtkGridAxes3DActor::SetYNotation ( int notation )

inline

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

Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.

Definition at line 225 of file vtkGridAxes3DActor.h.

◆ SetZNotation()

void vtkGridAxes3DActor::SetZNotation ( int notation )

inline

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

Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.

Definition at line 226 of file vtkGridAxes3DActor.h.

◆ GetNotation()

int vtkGridAxes3DActor::GetNotation ( int axis )

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

Accepted values are vtkAxis::AUTO, vtkAxis::FIXED, vtkAxis::CUSTOM.

◆ SetPrecision()

void vtkGridAxes3DActor::SetPrecision	(	int	axis,
		int	val
	)

Get/set the numerical precision to use, default is 2.

◆ SetXPrecision()

void vtkGridAxes3DActor::SetXPrecision ( int val )

inline

Get/set the numerical precision to use, default is 2.

Definition at line 235 of file vtkGridAxes3DActor.h.

◆ SetYPrecision()

void vtkGridAxes3DActor::SetYPrecision ( int val )

inline

Get/set the numerical precision to use, default is 2.

Definition at line 236 of file vtkGridAxes3DActor.h.

◆ SetZPrecision()

void vtkGridAxes3DActor::SetZPrecision ( int val )

inline

Get/set the numerical precision to use, default is 2.

Definition at line 237 of file vtkGridAxes3DActor.h.

◆ GetPrecision()

int vtkGridAxes3DActor::GetPrecision ( int axis )

Get/set the numerical precision to use, default is 2.

◆ SetTickLabelFunction()

void vtkGridAxes3DActor::SetTickLabelFunction	(	int	axis,
		std::function< double(double)>	func
	)

Get/Set the function that will be applied to the tick label of each axis.

If nothing is set, then the default is to use whatever was generated by vtkAxis.

The default it to use whatever was generated by vtkAxis.

◆ GetTickLabelFunction()

std::function<double(double)> vtkGridAxes3DActor::GetTickLabelFunction ( int axis )

Get/Set the function that will be applied to the tick label of each axis.

If nothing is set, then the default is to use whatever was generated by vtkAxis.

The default it to use whatever was generated by vtkAxis.

◆ GetBounds()

double* vtkGridAxes3DActor::GetBounds ( )

overridevirtual

Returns the prop bounds.

Implements vtkProp3D.

Reimplemented in vtkPVGridAxes3DActor.

◆ GetRenderedBounds()

virtual void vtkGridAxes3DActor::GetRenderedBounds ( double bounds[6] )

virtual

Get an bounding box that is expected to contain all rendered elements, since GetBounds() returns the bounding box the grid axes describes.

◆ SetForceOpaque()

virtual void vtkGridAxes3DActor::SetForceOpaque ( bool )

virtual

If true, the actor will always be rendered during the opaque pass.

◆ GetForceOpaque()

virtual bool vtkGridAxes3DActor::GetForceOpaque ( )

virtual

If true, the actor will always be rendered during the opaque pass.

◆ ForceOpaqueOn()

virtual void vtkGridAxes3DActor::ForceOpaqueOn ( )

virtual

If true, the actor will always be rendered during the opaque pass.

◆ ForceOpaqueOff()

virtual void vtkGridAxes3DActor::ForceOpaqueOff ( )

virtual

If true, the actor will always be rendered during the opaque pass.

◆ RenderOpaqueGeometry()

int vtkGridAxes3DActor::RenderOpaqueGeometry ( vtkViewport * )

overridevirtual

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkGridAxes3DActor::RenderTranslucentPolygonalGeometry ( vtkViewport * viewport )

overridevirtual

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkGridAxes3DActor::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

int vtkGridAxes3DActor::HasTranslucentPolygonalGeometry ( )

overridevirtual

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkGridAxes3DActor::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

Reimplemented from vtkProp.

◆ Update()

virtual void vtkGridAxes3DActor::Update ( vtkViewport * viewport )

protectedvirtual

Reimplemented in vtkPVGridAxes3DActor.

Member Data Documentation

◆ GridBounds

double vtkGridAxes3DActor::GridBounds[6]

protected

Definition at line 291 of file vtkGridAxes3DActor.h.

◆ FaceMask

unsigned int vtkGridAxes3DActor::FaceMask

protected

Definition at line 292 of file vtkGridAxes3DActor.h.

◆ LabelMask

unsigned int vtkGridAxes3DActor::LabelMask

protected

Definition at line 293 of file vtkGridAxes3DActor.h.

◆ LabelUniqueEdgesOnly

bool vtkGridAxes3DActor::LabelUniqueEdgesOnly

protected

Definition at line 294 of file vtkGridAxes3DActor.h.

◆ UseCustomLabels

vtkTuple<bool, 3> vtkGridAxes3DActor::UseCustomLabels

protected

Definition at line 295 of file vtkGridAxes3DActor.h.

◆ CustomLabels

vtkTuple<vtkNew<vtkDoubleArray>, 3> vtkGridAxes3DActor::CustomLabels

protected

Definition at line 296 of file vtkGridAxes3DActor.h.

◆ CustomLabelsMTime

vtkMTimeType vtkGridAxes3DActor::CustomLabelsMTime

protected

Definition at line 297 of file vtkGridAxes3DActor.h.

◆ GridAxes2DActors

vtkTuple<vtkNew<vtkGridAxes2DActor>, 6> vtkGridAxes3DActor::GridAxes2DActors

protected

Definition at line 299 of file vtkGridAxes3DActor.h.

◆ ForceOpaque

bool vtkGridAxes3DActor::ForceOpaque

protected

Definition at line 301 of file vtkGridAxes3DActor.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkGridAxes3DActor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ FaceMasks

◆ LabelMasks

Constructor & Destructor Documentation

◆ vtkGridAxes3DActor()

◆ ~vtkGridAxes3DActor()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ShallowCopy()

◆ SetGridBounds() [1/2]

◆ SetGridBounds() [2/2]

◆ GetGridBounds() [1/3]

◆ GetGridBounds() [2/3]

◆ GetGridBounds() [3/3]

◆ SetFaceMask()

◆ GetFaceMask()

◆ SetLabelMask()

◆ GetLabelMask()

◆ GetActors()

◆ UpdateGeometry()

◆ SetLabelUniqueEdgesOnly()

◆ GetLabelUniqueEdgesOnly()

◆ SetGenerateGrid()

◆ GetGenerateGrid()

◆ GenerateGridOn()

◆ GenerateGridOff()

◆ SetGenerateEdges()

◆ GetGenerateEdges()

◆ GenerateEdgesOn()

◆ GenerateEdgesOff()

◆ SetGenerateTicks()

◆ GetGenerateTicks()

◆ GenerateTicksOn()

◆ GenerateTicksOff()

◆ SetProperty()

◆ GetProperty()

◆ SetTitleTextProperty()

◆ SetXTitleTextProperty()

◆ SetYTitleTextProperty()

◆ SetZTitleTextProperty()

◆ GetTitleTextProperty()

◆ SetTitle()

◆ SetXTitle()

◆ SetYTitle()

◆ SetZTitle()

◆ GetTitle()

◆ SetUseCustomLabels()

◆ SetXUseCustomLabels()

◆ SetYUseCustomLabels()

◆ SetZUseCustomLabels()

◆ SetNumberOfLabels()

◆ SetNumberOfXLabels()

◆ SetNumberOfYLabels()

◆ SetNumberOfZLabels()

◆ SetLabel()

◆ SetXLabel()

◆ SetYLabel()

◆ SetZLabel()

◆ SetLabelTextProperty()

◆ SetXLabelTextProperty()

◆ SetYLabelTextProperty()

◆ SetZLabelTextProperty()

◆ GetLabelTextProperty()

◆ SetNotation()

◆ SetXNotation()

◆ SetYNotation()

◆ SetZNotation()