Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkGridAxes2DActor Class Reference

actor for an axes plane in a 3D view. More...

#include <vtkGridAxes2DActor.h>

Inheritance diagram for vtkGridAxes2DActor:
Inheritance graph
[legend]
Collaboration diagram for vtkGridAxes2DActor:
Collaboration graph
[legend]

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  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
}
 Valid values for LabelMask. More...
 
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 *viewport, bool doRegularUpdate)
 Updates the billboard geometry without performing any rendering, to assist GetActors(). More...
 
void SetCustomTickPositions (int axis, vtkDoubleArray *positions)
 Set custom tick positions for each of the axes. More...
 
int RenderOpaqueGeometry (vtkViewport *) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
int RenderOverlay (vtkViewport *viewport) override
 
int HasTranslucentPolygonalGeometry () override
 
void ReleaseGraphicsResources (vtkWindow *) override
 
vtkMTimeType GetMTime () override
 Overridden to include the mtime for the text properties. More...
 
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 doubleGetGridBounds ()
 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 SetLabelMask (unsigned int)
 Set the axes to label. More...
 
virtual unsigned int GetLabelMask ()
 Set the axes to label. More...
 
void SetProperty (vtkProperty *)
 Get/Set the property used to control the appearance of the rendered grid, including edges. More...
 
vtkPropertyGetProperty ()
 Get/Set the property used to control the appearance of the rendered grid, including edges. More...
 
void SetTitleTextProperty (int axis, vtkTextProperty *)
 Get/Set the title text properties for each of the coordinate axes. More...
 
vtkTextPropertyGetTitleTextProperty (int axis)
 Get/Set the title text properties for each of the coordinate axes. More...
 
void SetLabelTextProperty (int axis, vtkTextProperty *)
 Get/Set the label text properties for each of the coordinate axes. More...
 
vtkTextPropertyGetLabelTextProperty (int axis)
 Get/Set the label text properties for each of the coordinate axes. More...
 
void SetTitle (int axis, const std::string &title)
 Set titles for each of the axes. More...
 
const std::stringGetTitle (int axis)
 Set titles for each of the axes. More...
 
void SetNotation (int axis, 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...
 
int GetPrecision (int axis)
 Get/set the numerical precision to use, default is 2. 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...
 
doubleGetBounds () 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
vtkProp3DNewInstance () const
 
void ShallowCopy (vtkProp *prop)
 
virtual void SetPosition (double pos[3])
 
virtual doubleGetPosition ()
 
virtual void GetPosition (double data[3])
 
void AddPosition (double deltaPosition[3])
 
void AddPosition (double deltaX, double deltaY, double deltaZ)
 
doubleGetCenter ()
 
doubleGetXRange ()
 
doubleGetYRange ()
 
doubleGetZRange ()
 
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])
 
doubleGetOrientationWXYZ ()
 
void AddOrientation (double x, double y, double z)
 
void AddOrientation (double orentation[3])
 
void PokeMatrix (vtkMatrix4x4 *matrix)
 
void InitPathTraversal ()
 
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 doubleGetOrigin ()
 
virtual void GetOrigin (double data[3])
 
virtual void SetScale (double x, double y, double z)
 
virtual void SetScale (double scale[3])
 
virtual doubleGetScale ()
 
virtual void GetScale (double data[3])
 
void SetScale (double s)
 
void SetUserTransform (vtkLinearTransform *transform)
 
virtual vtkLinearTransformGetUserTransform ()
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 
vtkMatrix4x4GetUserMatrix ()
 
virtual void GetMatrix (vtkMatrix4x4 *m)
 
virtual void GetMatrix (double m[16])
 
void GetBounds (double bounds[6])
 
doubleGetOrientation ()
 
void GetOrientation (double orentation[3])
 
vtkMatrix4x4GetMatrix ()
 
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 doubleGetOrigin ()
 
virtual void GetOrigin (double data[3])
 
virtual void SetScale (double x, double y, double z)
 
virtual void SetScale (double scale[3])
 
virtual doubleGetScale ()
 
virtual void GetScale (double data[3])
 
void SetScale (double s)
 
void SetUserTransform (vtkLinearTransform *transform)
 
virtual vtkLinearTransformGetUserTransform ()
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 
vtkMatrix4x4GetUserMatrix ()
 
virtual void GetMatrix (vtkMatrix4x4 *m)
 
virtual void GetMatrix (double m[16])
 
void GetBounds (double bounds[6])
 
doubleGetOrientation ()
 
void GetOrientation (double orentation[3])
 
vtkMatrix4x4GetMatrix ()
 
virtual int GetIsIdentity ()
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () 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 vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 
virtual vtkInformationGetPropertyKeys ()
 
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)
 
vtkObjectGetConsumer (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 vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 
virtual vtkInformationGetPropertyKeys ()
 
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)
 
vtkObjectGetConsumer (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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkGridAxes2DActorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGridAxes2DActorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkProp3D
static int IsTypeOf (const char *type)
 
static vtkProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkGridAxes2DActor ()
 
 ~vtkGridAxes2DActor () override
 
bool Update (vtkViewport *viewport)
 
void UpdateTextProperties (vtkViewport *viewport)
 
void UpdateLabelPositions (vtkViewport *viewport)
 
void UpdateTextActors (vtkViewport *viewport)
 
- Protected Member Functions inherited from vtkProp3D
virtual vtkObjectBaseNewInstanceInternal () 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
 
unsigned int LabelMask
 
vtkTuple< vtkSmartPointer< vtkTextProperty >, 3 > TitleTextProperty
 
vtkTuple< vtkSmartPointer< vtkTextProperty >, 3 > LabelTextProperty
 
vtkTuple< std::string, 3 > Titles
 
vtkNew< vtkGridAxesHelperHelper
 
vtkSmartPointer< vtkGridAxesPlane2DActorPlaneActor
 
vtkNew< vtkAxisAxisHelpers [3]
 
vtkNew< vtkContextSceneAxisHelperScene
 
vtkTimeStamp UpdateLabelTextPropertiesMTime
 
bool ForceOpaque
 
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
 
vtkMatrix4x4UserMatrix
 
vtkMatrix4x4Matrix
 
vtkTimeStamp MatrixMTime
 
double Origin [3]
 
double Position [3]
 
double Orientation [3]
 
double Scale [3]
 
double Center [3]
 
vtkTransformTransform
 
double Bounds [6]
 
vtkProp3DCachedProp3D
 
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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkGridAxes3DActor
 
class vtkLabels
 

Detailed Description

actor for an axes plane in a 3D view.

vtkGridAxes2DActor is a vtkProp3D that renders a single axes plane (or face). Despite the name, it renders a prop in 3D with ability to render lines for the axes bounds along with labels on them.

To use this, one sets the GridBounds and then the Face which identifies the face of the cube defined by the GridBounds along which this prop will render the grid. Parameters available allow additional controls including labeling, grid rendering, edge rendering etc.

See also
vtkGridAxes3DActor

Definition at line 48 of file vtkGridAxes2DActor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkGridAxes2DActor.h.

Member Enumeration Documentation

◆ Faces

Enumerator
MIN_YZ 
MIN_ZX 
MIN_XY 
MAX_YZ 
MAX_ZX 
MAX_XY 

Definition at line 66 of file vtkGridAxes2DActor.h.

◆ LabelMasks

Valid values for LabelMask.

Enumerator
MIN_X 
MIN_Y 
MIN_Z 
MAX_X 
MAX_Y 
MAX_Z 

Definition at line 87 of file vtkGridAxes2DActor.h.

Constructor & Destructor Documentation

◆ vtkGridAxes2DActor()

vtkGridAxes2DActor::vtkGridAxes2DActor ( )
protected

◆ ~vtkGridAxes2DActor()

vtkGridAxes2DActor::~vtkGridAxes2DActor ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGridAxes2DActor* vtkGridAxes2DActor::New ( )
static

◆ GetClassName()

virtual const char* vtkGridAxes2DActor::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkProp3D.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkGridAxes2DActor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkProp3D.

◆ SetGridBounds() [1/2]

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

◆ SetFace()

virtual void vtkGridAxes2DActor::SetFace ( int  )
virtual

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

◆ GetFace()

virtual int vtkGridAxes2DActor::GetFace ( )
virtual

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

◆ SetLabelMask()

virtual void vtkGridAxes2DActor::SetLabelMask ( unsigned  int)
virtual

Set the axes to label.

The mask can be generated by or-ing values in vtkGridAxes2DActor::LabelMasks to label multiple axes. Any request to label an axes not present on the selected Face is ignored e.g. if Face is MIN_YZ, then LabelMask set to MIN_X will have no effect.

◆ GetLabelMask()

virtual unsigned int vtkGridAxes2DActor::GetLabelMask ( )
virtual

Set the axes to label.

The mask can be generated by or-ing values in vtkGridAxes2DActor::LabelMasks to label multiple axes. Any request to label an axes not present on the selected Face is ignored e.g. if Face is MIN_YZ, then LabelMask set to MIN_X will have no effect.

◆ GetActors()

void vtkGridAxes2DActor::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 vtkGridAxes2DActor::UpdateGeometry ( vtkViewport viewport,
bool  doRegularUpdate 
)

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

◆ SetProperty()

void vtkGridAxes2DActor::SetProperty ( vtkProperty )

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

◆ GetProperty()

vtkProperty* vtkGridAxes2DActor::GetProperty ( )

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

◆ SetTitleTextProperty()

void vtkGridAxes2DActor::SetTitleTextProperty ( int  axis,
vtkTextProperty  
)

Get/Set the title text properties for each of the coordinate axes.

Which properties will be used depends on the selected Face being rendered.

◆ GetTitleTextProperty()

vtkTextProperty* vtkGridAxes2DActor::GetTitleTextProperty ( int  axis)

Get/Set the title text properties for each of the coordinate axes.

Which properties will be used depends on the selected Face being rendered.

◆ SetLabelTextProperty()

void vtkGridAxes2DActor::SetLabelTextProperty ( int  axis,
vtkTextProperty  
)

Get/Set the label text properties for each of the coordinate axes.

Which properties will be used depends on the selected Face being rendered.

◆ GetLabelTextProperty()

vtkTextProperty* vtkGridAxes2DActor::GetLabelTextProperty ( int  axis)

Get/Set the label text properties for each of the coordinate axes.

Which properties will be used depends on the selected Face being rendered.

◆ SetTitle()

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

Set titles for each of the axes.

◆ GetTitle()

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

Set titles for each of the axes.

◆ SetNotation()

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

◆ GetNotation()

int vtkGridAxes2DActor::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 vtkGridAxes2DActor::SetPrecision ( int  axis,
int  val 
)

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

◆ GetPrecision()

int vtkGridAxes2DActor::GetPrecision ( int  axis)

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

◆ SetCustomTickPositions()

void vtkGridAxes2DActor::SetCustomTickPositions ( int  axis,
vtkDoubleArray positions 
)

Set custom tick positions for each of the axes.

The positions are deep copied. Set to nullptr to not use custom tick positions for the axis.

◆ SetGenerateGrid()

void vtkGridAxes2DActor::SetGenerateGrid ( bool  val)
inline

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

Definition at line 191 of file vtkGridAxes2DActor.h.

◆ GetGenerateGrid()

bool vtkGridAxes2DActor::GetGenerateGrid ( )
inline

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

Definition at line 192 of file vtkGridAxes2DActor.h.

◆ GenerateGridOn()

virtual void vtkGridAxes2DActor::GenerateGridOn ( )
virtual

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

◆ GenerateGridOff()

virtual void vtkGridAxes2DActor::GenerateGridOff ( )
virtual

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

◆ SetGenerateEdges()

void vtkGridAxes2DActor::SetGenerateEdges ( bool  val)
inline

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

Definition at line 200 of file vtkGridAxes2DActor.h.

◆ GetGenerateEdges()

bool vtkGridAxes2DActor::GetGenerateEdges ( )
inline

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

Definition at line 201 of file vtkGridAxes2DActor.h.

◆ GenerateEdgesOn()

virtual void vtkGridAxes2DActor::GenerateEdgesOn ( )
virtual

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

◆ GenerateEdgesOff()

virtual void vtkGridAxes2DActor::GenerateEdgesOff ( )
virtual

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

◆ SetGenerateTicks()

void vtkGridAxes2DActor::SetGenerateTicks ( bool  val)
inline

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

Which edges are rendered is defined by the TickMask.

Definition at line 210 of file vtkGridAxes2DActor.h.

◆ GetGenerateTicks()

bool vtkGridAxes2DActor::GetGenerateTicks ( )
inline

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

Which edges are rendered is defined by the TickMask.

Definition at line 211 of file vtkGridAxes2DActor.h.

◆ GenerateTicksOn()

virtual void vtkGridAxes2DActor::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 vtkGridAxes2DActor::GenerateTicksOff ( )
virtual

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

Which edges are rendered is defined by the TickMask.

◆ GetBounds()

double* vtkGridAxes2DActor::GetBounds ( void  )
inlineoverridevirtual

Returns the prop bounds.

Implements vtkProp3D.

Definition at line 223 of file vtkGridAxes2DActor.h.

◆ SetForceOpaque()

virtual void vtkGridAxes2DActor::SetForceOpaque ( bool  )
virtual

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

◆ GetForceOpaque()

virtual bool vtkGridAxes2DActor::GetForceOpaque ( )
virtual

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

◆ ForceOpaqueOn()

virtual void vtkGridAxes2DActor::ForceOpaqueOn ( )
virtual

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

◆ ForceOpaqueOff()

virtual void vtkGridAxes2DActor::ForceOpaqueOff ( )
virtual

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

◆ RenderOpaqueGeometry()

int vtkGridAxes2DActor::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkGridAxes2DActor::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkGridAxes2DActor::RenderOverlay ( vtkViewport viewport)
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

int vtkGridAxes2DActor::HasTranslucentPolygonalGeometry ( )
overridevirtual

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkGridAxes2DActor::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Reimplemented from vtkProp.

◆ GetMTime()

vtkMTimeType vtkGridAxes2DActor::GetMTime ( )
overridevirtual

Overridden to include the mtime for the text properties.

Reimplemented from vtkProp3D.

◆ Update()

bool vtkGridAxes2DActor::Update ( vtkViewport viewport)
protected

◆ UpdateTextProperties()

void vtkGridAxes2DActor::UpdateTextProperties ( vtkViewport viewport)
protected

◆ UpdateLabelPositions()

void vtkGridAxes2DActor::UpdateLabelPositions ( vtkViewport viewport)
protected

◆ UpdateTextActors()

void vtkGridAxes2DActor::UpdateTextActors ( vtkViewport viewport)
protected

Friends And Related Function Documentation

◆ vtkGridAxes3DActor

friend class vtkGridAxes3DActor
friend

Definition at line 258 of file vtkGridAxes2DActor.h.

◆ vtkLabels

friend class vtkLabels
friend

Definition at line 282 of file vtkGridAxes2DActor.h.

Member Data Documentation

◆ GridBounds

double vtkGridAxes2DActor::GridBounds[6]
protected

Definition at line 260 of file vtkGridAxes2DActor.h.

◆ Face

int vtkGridAxes2DActor::Face
protected

Definition at line 261 of file vtkGridAxes2DActor.h.

◆ LabelMask

unsigned int vtkGridAxes2DActor::LabelMask
protected

Definition at line 262 of file vtkGridAxes2DActor.h.

◆ TitleTextProperty

vtkTuple<vtkSmartPointer<vtkTextProperty>, 3> vtkGridAxes2DActor::TitleTextProperty
protected

Definition at line 264 of file vtkGridAxes2DActor.h.

◆ LabelTextProperty

vtkTuple<vtkSmartPointer<vtkTextProperty>, 3> vtkGridAxes2DActor::LabelTextProperty
protected

Definition at line 265 of file vtkGridAxes2DActor.h.

◆ Titles

vtkTuple<std::string, 3> vtkGridAxes2DActor::Titles
protected

Definition at line 266 of file vtkGridAxes2DActor.h.

◆ Helper

vtkNew<vtkGridAxesHelper> vtkGridAxes2DActor::Helper
protected

Definition at line 268 of file vtkGridAxes2DActor.h.

◆ PlaneActor

vtkSmartPointer<vtkGridAxesPlane2DActor> vtkGridAxes2DActor::PlaneActor
protected

Definition at line 269 of file vtkGridAxes2DActor.h.

◆ AxisHelpers

vtkNew<vtkAxis> vtkGridAxes2DActor::AxisHelpers[3]
protected

Definition at line 270 of file vtkGridAxes2DActor.h.

◆ AxisHelperScene

vtkNew<vtkContextScene> vtkGridAxes2DActor::AxisHelperScene
protected

Definition at line 271 of file vtkGridAxes2DActor.h.

◆ UpdateLabelTextPropertiesMTime

vtkTimeStamp vtkGridAxes2DActor::UpdateLabelTextPropertiesMTime
protected

Definition at line 272 of file vtkGridAxes2DActor.h.

◆ ForceOpaque

bool vtkGridAxes2DActor::ForceOpaque
protected

Definition at line 274 of file vtkGridAxes2DActor.h.


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