vtkGridAxesPlane2DActor Class Reference

renders a 2D grid for vtkGridAxes2DActor. More...

#include <vtkGridAxesPlane2DActor.h>

Inheritance diagram for vtkGridAxesPlane2DActor:

Collaboration diagram for vtkGridAxesPlane2DActor:

Public Types
enum	Faces {   MIN_YZ = vtkGridAxesHelper::MIN_YZ, MIN_ZX = vtkGridAxesHelper::MIN_ZX, MIN_XY = vtkGridAxesHelper::MIN_XY, MAX_YZ = vtkGridAxesHelper::MAX_YZ,   MAX_ZX = vtkGridAxesHelper::MAX_ZX, MAX_XY = vtkGridAxesHelper::MAX_XY }
enum	{ TICK_DIRECTION_INWARDS = 0x1, TICK_DIRECTION_OUTWARDS = 0x2, TICK_DIRECTION_BOTH = TICK_DIRECTION_INWARDS | TICK_DIRECTION_OUTWARDS }
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	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	SetTickPositions (int axis, vtkDoubleArray *data)
	Set the tick positions for each of the coordinate axis. More...
const std::deque< double > &	GetTickPositions (int axis)
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	SetFace (int)
	Indicate which face of the specified bounds is this class operating with. More...
virtual int	GetFace ()
	Indicate which face of the specified bounds is this class operating with. More...
virtual void	SetGenerateGrid (bool)
	Get/Set whether to generate lines for the plane's grid. More...
virtual bool	GetGenerateGrid ()
	Get/Set whether to generate lines for the plane's grid. More...
virtual void	GenerateGridOn ()
	Get/Set whether to generate lines for the plane's grid. More...
virtual void	GenerateGridOff ()
	Get/Set whether to generate lines for the plane's grid. More...
virtual void	SetGenerateEdges (bool)
	Get/Set whether to generate the polydata for the plane's edges. More...
virtual bool	GetGenerateEdges ()
	Get/Set whether to generate the polydata for the plane's edges. More...
virtual void	GenerateEdgesOn ()
	Get/Set whether to generate the polydata for the plane's edges. More...
virtual void	GenerateEdgesOff ()
	Get/Set whether to generate the polydata for the plane's edges. More...
virtual void	SetGenerateTicks (bool)
	Get/Set whether to generate tick markers for the tick positions. More...
virtual bool	GetGenerateTicks ()
	Get/Set whether to generate tick markers for the tick positions. More...
virtual void	GenerateTicksOn ()
	Get/Set whether to generate tick markers for the tick positions. More...
virtual void	GenerateTicksOff ()
	Get/Set whether to generate tick markers for the tick positions. More...
virtual void	SetTickDirection (unsigned int)
	Get/Set the tick direction. More...
virtual unsigned int	GetTickDirection ()
	Get/Set the tick direction. 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...
double *	GetBounds () override
	Returns the prop bounds. More...
Public Member Functions inherited from vtkProp3D
vtkProp3D *	NewInstance () const
void	ShallowCopy (vtkProp *prop)
virtual void	SetPosition (double pos[3])
virtual double *	GetPosition ()
virtual void	GetPosition (double data[3])
void	AddPosition (double deltaPosition[3])
void	AddPosition (double deltaX, double deltaY, double deltaZ)
double *	GetCenter ()
double *	GetXRange ()
double *	GetYRange ()
double *	GetZRange ()
double	GetLength ()
void	RotateX (double)
void	RotateY (double)
void	RotateZ (double)
void	RotateWXYZ (double w, double x, double y, double z)
void	SetOrientation (double x, double y, double z)
void	SetOrientation (double orientation[3])
double *	GetOrientationWXYZ ()
void	AddOrientation (double x, double y, double z)
void	AddOrientation (double orentation[3])
void	PokeMatrix (vtkMatrix4x4 *matrix)
void	InitPathTraversal ()
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 vtkGridAxesPlane2DActor *	New ()
static int	IsTypeOf (const char *type)
static vtkGridAxesPlane2DActor *	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
	vtkGridAxesPlane2DActor (vtkGridAxesHelper *helper=nullptr)
	~vtkGridAxesPlane2DActor () override
void	Update (vtkViewport *viewport)
	Update's the polydata. More...
bool	UpdateEdges (vtkViewport *viewport)
	Update's the polydata. More...
bool	UpdateGrid (vtkViewport *viewport)
	Update's the polydata. More...
bool	UpdateTicks (vtkViewport *viewport)
	Update's the polydata. More...
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]
int	Face
bool	GenerateGrid
bool	GenerateEdges
bool	GenerateTicks
unsigned int	TickDirection
std::deque< double >	TickPositions [3]
vtkNew< vtkPolyData >	PolyData
vtkNew< vtkPoints >	PolyDataPoints
vtkNew< vtkCellArray >	PolyDataLines
vtkNew< vtkPolyDataMapper >	Mapper
vtkNew< vtkActor >	Actor
vtkSmartPointer< vtkGridAxesHelper >	Helper
bool	HelperManagedExternally
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
class	vtkGridAxes2DActor
	vtkGridAxes2DActor uses this method to create vtkGridAxesPlane2DActor instance. More...
static vtkGridAxesPlane2DActor *	New (vtkGridAxesHelper *helper)
	vtkGridAxes2DActor uses this method to create vtkGridAxesPlane2DActor instance. More...

Detailed Description

renders a 2D grid for vtkGridAxes2DActor.

vtkGridAxesPlane2DActor is designed for use by vtkGridAxes2DActor to render the wireframe for the grid plane. It can also be used directly to render such a wireframe in a renderer.

Definition at line 32 of file vtkGridAxesPlane2DActor.h.

Member Typedef Documentation

Superclass

typedef vtkProp3D vtkGridAxesPlane2DActor::Superclass

Definition at line 36 of file vtkGridAxesPlane2DActor.h.

Member Enumeration Documentation

Faces

enum vtkGridAxesPlane2DActor::Faces

Enumerator
MIN_YZ
MIN_ZX
MIN_XY
MAX_YZ
MAX_ZX
MAX_XY

Definition at line 53 of file vtkGridAxesPlane2DActor.h.

anonymous enum

anonymous enum

Enumerator
TICK_DIRECTION_INWARDS
TICK_DIRECTION_OUTWARDS
TICK_DIRECTION_BOTH

Definition at line 119 of file vtkGridAxesPlane2DActor.h.

Constructor & Destructor Documentation

vtkGridAxesPlane2DActor()

vtkGridAxesPlane2DActor::vtkGridAxesPlane2DActor ( vtkGridAxesHelper *  helper = nullptr )

protected

~vtkGridAxesPlane2DActor()

vtkGridAxesPlane2DActor::~vtkGridAxesPlane2DActor ( )

overrideprotected

Member Function Documentation

New() [1/2]

static vtkGridAxesPlane2DActor* vtkGridAxesPlane2DActor::New ( )

static

GetClassName()

virtual const char* vtkGridAxesPlane2DActor::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkProp3D.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkProp3D.

SetGridBounds() [1/2]

virtual void vtkGridAxesPlane2DActor::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. Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

SetGridBounds() [2/2]

virtual void vtkGridAxesPlane2DActor::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. Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

GetGridBounds() [1/3]

virtual double* vtkGridAxesPlane2DActor::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. Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

GetGridBounds() [2/3]

virtual void vtkGridAxesPlane2DActor::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. Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

GetGridBounds() [3/3]

virtual void vtkGridAxesPlane2DActor::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. Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

SetFace()

virtual void vtkGridAxesPlane2DActor::SetFace ( int  )

virtual

Indicate which face of the specified bounds is this class operating with.

Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

GetFace()

virtual int vtkGridAxesPlane2DActor::GetFace ( )

virtual

Indicate which face of the specified bounds is this class operating with.

Note: this is only needed/used when the vtkGridAxesHelper is not provided when calling New(), otherwise the vtkGridAxesHelper is assumed to be initialized externally.

GetActors()

void vtkGridAxesPlane2DActor::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 vtkGridAxesPlane2DActor::UpdateGeometry

(

vtkViewport *

vp

)

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

SetGenerateGrid()

virtual void vtkGridAxesPlane2DActor::SetGenerateGrid ( bool  )

virtual

Get/Set whether to generate lines for the plane's grid.

Default is true.

GetGenerateGrid()

virtual bool vtkGridAxesPlane2DActor::GetGenerateGrid ( )

virtual

Get/Set whether to generate lines for the plane's grid.

Default is true.

GenerateGridOn()

virtual void vtkGridAxesPlane2DActor::GenerateGridOn ( )

virtual

Get/Set whether to generate lines for the plane's grid.

Default is true.

GenerateGridOff()

virtual void vtkGridAxesPlane2DActor::GenerateGridOff ( )

virtual

Get/Set whether to generate lines for the plane's grid.

Default is true.

SetGenerateEdges()

virtual void vtkGridAxesPlane2DActor::SetGenerateEdges ( bool  )

virtual

Get/Set whether to generate the polydata for the plane's edges.

Default is true.

GetGenerateEdges()

virtual bool vtkGridAxesPlane2DActor::GetGenerateEdges ( )

virtual

Get/Set whether to generate the polydata for the plane's edges.

Default is true.

GenerateEdgesOn()

virtual void vtkGridAxesPlane2DActor::GenerateEdgesOn ( )

virtual

Get/Set whether to generate the polydata for the plane's edges.

Default is true.

GenerateEdgesOff()

virtual void vtkGridAxesPlane2DActor::GenerateEdgesOff ( )

virtual

Get/Set whether to generate the polydata for the plane's edges.

Default is true.

SetGenerateTicks()

virtual void vtkGridAxesPlane2DActor::SetGenerateTicks ( bool  )

virtual

Get/Set whether to generate tick markers for the tick positions.

Default is true.

GetGenerateTicks()

virtual bool vtkGridAxesPlane2DActor::GetGenerateTicks ( )

virtual

Get/Set whether to generate tick markers for the tick positions.

Default is true.

GenerateTicksOn()

virtual void vtkGridAxesPlane2DActor::GenerateTicksOn ( )

virtual

Get/Set whether to generate tick markers for the tick positions.

Default is true.

GenerateTicksOff()

virtual void vtkGridAxesPlane2DActor::GenerateTicksOff ( )

virtual

Get/Set whether to generate tick markers for the tick positions.

Default is true.

SetTickDirection()

virtual void vtkGridAxesPlane2DActor::SetTickDirection ( unsigned  int )

virtual

Get/Set the tick direction.

GetTickDirection()

virtual unsigned int vtkGridAxesPlane2DActor::GetTickDirection ( )

virtual

Get/Set the tick direction.

SetTickPositions()

void vtkGridAxesPlane2DActor::SetTickPositions	(	int	axis,
		vtkDoubleArray *	data
	)

Set the tick positions for each of the coordinate axis.

Which tick positions get used depended on the face being rendered e.g. if Face is MIN_XY, then the tick positions for Z-axis i.e. axis=2 will not be used and hence need not be specified. Pass nullptr for data will clear the ticks positions for that axis. Note: This creates a deep-copy of the values in data and stores that.

GetTickPositions()

const std::deque<double>& vtkGridAxesPlane2DActor::GetTickPositions ( int  axis )

inline

Definition at line 144 of file vtkGridAxesPlane2DActor.h.

SetProperty()

void vtkGridAxesPlane2DActor::SetProperty

(

vtkProperty *

)

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

GetProperty()

vtkProperty* vtkGridAxesPlane2DActor::GetProperty

(

)

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

GetBounds()

double* vtkGridAxesPlane2DActor::GetBounds ( void  )

inlineoverridevirtual

Returns the prop bounds.

Implements vtkProp3D.

Definition at line 165 of file vtkGridAxesPlane2DActor.h.

RenderOpaqueGeometry()

int vtkGridAxesPlane2DActor::RenderOpaqueGeometry ( vtkViewport *  )

overridevirtual

Reimplemented from vtkProp.

RenderTranslucentPolygonalGeometry()

int vtkGridAxesPlane2DActor::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport )

overridevirtual

Reimplemented from vtkProp.

RenderOverlay()

int vtkGridAxesPlane2DActor::RenderOverlay ( vtkViewport *  viewport )

overridevirtual

Reimplemented from vtkProp.

HasTranslucentPolygonalGeometry()

int vtkGridAxesPlane2DActor::HasTranslucentPolygonalGeometry ( )

overridevirtual

Reimplemented from vtkProp.

ReleaseGraphicsResources()

void vtkGridAxesPlane2DActor::ReleaseGraphicsResources ( vtkWindow *  )

overridevirtual

Reimplemented from vtkProp.

New() [2/2]

static vtkGridAxesPlane2DActor* vtkGridAxesPlane2DActor::New ( vtkGridAxesHelper *  helper )

staticprotected

vtkGridAxes2DActor uses this method to create vtkGridAxesPlane2DActor instance.

In that case, vtkGridAxesPlane2DActor assumes that the vtkGridAxesHelper will be updated and initialized externally. That avoids unnecessary duplicate computations per render.

Update()

void vtkGridAxesPlane2DActor::Update ( vtkViewport *  viewport )

protected

Update's the polydata.

UpdateEdges()

bool vtkGridAxesPlane2DActor::UpdateEdges ( vtkViewport *  viewport )

protected

Update's the polydata.

UpdateGrid()

bool vtkGridAxesPlane2DActor::UpdateGrid ( vtkViewport *  viewport )

protected

Update's the polydata.

UpdateTicks()

bool vtkGridAxesPlane2DActor::UpdateTicks ( vtkViewport *  viewport )

protected

Update's the polydata.

Friends And Related Function Documentation

vtkGridAxes2DActor

friend class vtkGridAxes2DActor

friend

vtkGridAxes2DActor uses this method to create vtkGridAxesPlane2DActor instance.

In that case, vtkGridAxesPlane2DActor assumes that the vtkGridAxesHelper will be updated and initialized externally. That avoids unnecessary duplicate computations per render.

Definition at line 190 of file vtkGridAxesPlane2DActor.h.

Member Data Documentation

GridBounds

double vtkGridAxesPlane2DActor::GridBounds[6]

protected

Definition at line 203 of file vtkGridAxesPlane2DActor.h.

Face

int vtkGridAxesPlane2DActor::Face

protected

Definition at line 204 of file vtkGridAxesPlane2DActor.h.

GenerateGrid

bool vtkGridAxesPlane2DActor::GenerateGrid

protected

Definition at line 206 of file vtkGridAxesPlane2DActor.h.

GenerateEdges

bool vtkGridAxesPlane2DActor::GenerateEdges

protected

Definition at line 207 of file vtkGridAxesPlane2DActor.h.

GenerateTicks

bool vtkGridAxesPlane2DActor::GenerateTicks

protected

Definition at line 208 of file vtkGridAxesPlane2DActor.h.

TickDirection

unsigned int vtkGridAxesPlane2DActor::TickDirection

protected

Definition at line 209 of file vtkGridAxesPlane2DActor.h.

TickPositions

std::deque<double> vtkGridAxesPlane2DActor::TickPositions[3]

protected

Definition at line 210 of file vtkGridAxesPlane2DActor.h.

PolyData

vtkNew<vtkPolyData> vtkGridAxesPlane2DActor::PolyData

protected

Definition at line 212 of file vtkGridAxesPlane2DActor.h.

PolyDataPoints

vtkNew<vtkPoints> vtkGridAxesPlane2DActor::PolyDataPoints

protected

Definition at line 213 of file vtkGridAxesPlane2DActor.h.

PolyDataLines

vtkNew<vtkCellArray> vtkGridAxesPlane2DActor::PolyDataLines

protected

Definition at line 214 of file vtkGridAxesPlane2DActor.h.

Mapper

vtkNew<vtkPolyDataMapper> vtkGridAxesPlane2DActor::Mapper

protected

Definition at line 215 of file vtkGridAxesPlane2DActor.h.

Actor

vtkNew<vtkActor> vtkGridAxesPlane2DActor::Actor

protected

Definition at line 216 of file vtkGridAxesPlane2DActor.h.

Helper

vtkSmartPointer<vtkGridAxesHelper> vtkGridAxesPlane2DActor::Helper

protected

Definition at line 218 of file vtkGridAxesPlane2DActor.h.

HelperManagedExternally

bool vtkGridAxesPlane2DActor::HelperManagedExternally

protected

Definition at line 219 of file vtkGridAxesPlane2DActor.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkGridAxesPlane2DActor.h