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

#include <vtkGridAxes2DActor.h>

Inherits vtkProp3D.

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 Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetCustomTickPositions (int axis, vtkDoubleArray *positions)
 Set custom tick positions for each of the axes. More...
 
void SetGenerateGrid (bool val)
 Turn off to not generate polydata for the plane's grid. More...
 
bool GetGenerateGrid ()
 
virtual void GenerateGridOn ()
 
virtual void GenerateGridOff ()
 
void SetGenerateEdges (bool val)
 Turn off to not generate the polydata for the plane's edges. More...
 
bool GetGenerateEdges ()
 
virtual void GenerateEdgesOn ()
 
virtual void GenerateEdgesOff ()
 
void SetGenerateTicks (bool val)
 
bool GetGenerateTicks ()
 
virtual void GenerateTicksOn ()
 
virtual void GenerateTicksOff ()
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
 
virtual int RenderOverlay (vtkViewport *viewport)
 
virtual int HasTranslucentPolygonalGeometry ()
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
vtkMTimeType GetMTime ()
 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 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 SetLabelMask (unsigned int)
 Set the axes to label. More...
 
virtual unsigned int GetLabelMask ()
 Set the axes to label. More...
 
virtual void SetEnableLayerSupport (bool)
 Enable/Disable layer support. More...
 
virtual bool GetEnableLayerSupport ()
 Enable/Disable layer support. More...
 
virtual void EnableLayerSupportOn ()
 Enable/Disable layer support. More...
 
virtual void EnableLayerSupportOff ()
 Enable/Disable layer support. More...
 
virtual void SetBackgroundLayer (int)
 Get/Set the layer in which to render all background actors/text when EnableLayerSupport is ON. More...
 
virtual int GetBackgroundLayer ()
 Get/Set the layer in which to render all background actors/text when EnableLayerSupport is ON. More...
 
virtual void SetGeometryLayer (int)
 Get/Set the layer in which to render all 3D actors when EnableLayerSupport is ON. More...
 
virtual int GetGeometryLayer ()
 Get/Set the layer in which to render all 3D actors when EnableLayerSupport is ON. More...
 
virtual void SetForegroundLayer (int)
 Get/Set the layer in which to render all foreground actors/text when EnableLayerSupport is ON. More...
 
virtual int GetForegroundLayer ()
 Get/Set the layer in which to render all foreground actors/text when EnableLayerSupport is ON. 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 title text properties for each of the coordinate axes. More...
 
vtkTextProperty * GetTitleTextProperty (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...
 
vtkTextProperty * GetLabelTextProperty (int axis)
 Get/Set the label text properties for each of the coordinate axes. More...
 
void SetTitle (int axis, const vtkStdString &title)
 Set titles for each of the axes. More...
 
const vtkStdString & GetTitle (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...
 
virtual double * GetBounds ()
 Returns the prop bounds. More...
 

Static Public Member Functions

static vtkGridAxes2DActorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGridAxes2DActorSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkGridAxes2DActor ()
 
 ~vtkGridAxes2DActor ()
 
bool Update (vtkViewport *viewport)
 
void UpdateTextProperties (vtkViewport *viewport)
 
void UpdateLabelPositions (vtkViewport *viewport)
 
void UpdateTextActors (vtkViewport *viewport)
 

Protected Attributes

double GridBounds [6]
 
int Face
 
unsigned int LabelMask
 
bool EnableLayerSupport
 
int BackgroundLayer
 
int ForegroundLayer
 
int GeometryLayer
 
vtkTuple< vtkSmartPointer< vtkTextProperty >, 3 > TitleTextProperty
 
vtkTuple< vtkSmartPointer< vtkTextProperty >, 3 > LabelTextProperty
 
vtkTuple< vtkStdString, 3 > Titles
 
vtkNew< vtkGridAxesHelperHelper
 
vtkSmartPointer< vtkGridAxesPlane2DActorPlaneActor
 
vtkNew< vtkAxis > AxisHelpers [3]
 
vtkNew< vtkContextScene > AxisHelperScene
 
vtkTimeStamp UpdateLabelTextPropertiesMTime
 

Friends

class vtkGridAxes3DActor
 
class vtkLabels
 

Detailed Description

Definition at line 38 of file vtkGridAxes2DActor.h.

Member Typedef Documentation

§ Superclass

typedef vtkProp3D vtkGridAxes2DActor::Superclass

Definition at line 42 of file vtkGridAxes2DActor.h.

Member Enumeration Documentation

§ Faces

Enumerator
MIN_YZ 
MIN_ZX 
MIN_XY 
MAX_YZ 
MAX_ZX 
MAX_XY 

Definition at line 56 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 77 of file vtkGridAxes2DActor.h.

Constructor & Destructor Documentation

§ vtkGridAxes2DActor()

vtkGridAxes2DActor::vtkGridAxes2DActor ( )
protected

§ ~vtkGridAxes2DActor()

vtkGridAxes2DActor::~vtkGridAxes2DActor ( )
protected

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

§ SafeDownCast()

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

§ PrintSelf()

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

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

§ GetLabelMask()

virtual unsigned int vtkGridAxes2DActor::GetLabelMask ( )
virtual

Set the axes to label.

§ SetEnableLayerSupport()

virtual void vtkGridAxes2DActor::SetEnableLayerSupport ( bool  )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop can render in there separate layers:

  • BackgroundLayer for all text labels and titles on the back faces,
  • GeometryLayer for all 3D geometry e.g the grid wireframe, and
  • ForegroundLayer for all text labels and titles on the front faces.

§ GetEnableLayerSupport()

virtual bool vtkGridAxes2DActor::GetEnableLayerSupport ( )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop can render in there separate layers:

  • BackgroundLayer for all text labels and titles on the back faces,
  • GeometryLayer for all 3D geometry e.g the grid wireframe, and
  • ForegroundLayer for all text labels and titles on the front faces.

§ EnableLayerSupportOn()

virtual void vtkGridAxes2DActor::EnableLayerSupportOn ( )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop can render in there separate layers:

  • BackgroundLayer for all text labels and titles on the back faces,
  • GeometryLayer for all 3D geometry e.g the grid wireframe, and
  • ForegroundLayer for all text labels and titles on the front faces.

§ EnableLayerSupportOff()

virtual void vtkGridAxes2DActor::EnableLayerSupportOff ( )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop can render in there separate layers:

  • BackgroundLayer for all text labels and titles on the back faces,
  • GeometryLayer for all 3D geometry e.g the grid wireframe, and
  • ForegroundLayer for all text labels and titles on the front faces.

§ SetBackgroundLayer()

virtual void vtkGridAxes2DActor::SetBackgroundLayer ( int  )
virtual

Get/Set the layer in which to render all background actors/text when EnableLayerSupport is ON.

Default is 0.

§ GetBackgroundLayer()

virtual int vtkGridAxes2DActor::GetBackgroundLayer ( )
virtual

Get/Set the layer in which to render all background actors/text when EnableLayerSupport is ON.

Default is 0.

§ SetGeometryLayer()

virtual void vtkGridAxes2DActor::SetGeometryLayer ( int  )
virtual

Get/Set the layer in which to render all 3D actors when EnableLayerSupport is ON.

Default is 0.

§ GetGeometryLayer()

virtual int vtkGridAxes2DActor::GetGeometryLayer ( )
virtual

Get/Set the layer in which to render all 3D actors when EnableLayerSupport is ON.

Default is 0.

§ SetForegroundLayer()

virtual void vtkGridAxes2DActor::SetForegroundLayer ( int  )
virtual

Get/Set the layer in which to render all foreground actors/text when EnableLayerSupport is ON.

Default is 0.

§ GetForegroundLayer()

virtual int vtkGridAxes2DActor::GetForegroundLayer ( )
virtual

Get/Set the layer in which to render all foreground actors/text when EnableLayerSupport is ON.

Default is 0.

§ SetProperty()

void vtkGridAxes2DActor::SetProperty ( vtkProperty *  )

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

§ GetProperty()

vtkProperty* vtkGridAxes2DActor::GetProperty ( )

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

§ 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 vtkStdString &  title 
)

Set titles for each of the axes.

§ GetTitle()

const vtkStdString& 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 NULL 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 200 of file vtkGridAxes2DActor.h.

§ GetGenerateGrid()

bool vtkGridAxes2DActor::GetGenerateGrid ( )
inline

Definition at line 201 of file vtkGridAxes2DActor.h.

§ GenerateGridOn()

virtual void vtkGridAxes2DActor::GenerateGridOn ( )
virtual

§ GenerateGridOff()

virtual void vtkGridAxes2DActor::GenerateGridOff ( )
virtual

§ SetGenerateEdges()

void vtkGridAxes2DActor::SetGenerateEdges ( bool  val)
inline

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

Which edges are rendered is defined by the EdgeMask.

Definition at line 208 of file vtkGridAxes2DActor.h.

§ GetGenerateEdges()

bool vtkGridAxes2DActor::GetGenerateEdges ( )
inline

Definition at line 209 of file vtkGridAxes2DActor.h.

§ GenerateEdgesOn()

virtual void vtkGridAxes2DActor::GenerateEdgesOn ( )
virtual

§ GenerateEdgesOff()

virtual void vtkGridAxes2DActor::GenerateEdgesOff ( )
virtual

§ SetGenerateTicks()

void vtkGridAxes2DActor::SetGenerateTicks ( bool  val)
inline

Definition at line 214 of file vtkGridAxes2DActor.h.

§ GetGenerateTicks()

bool vtkGridAxes2DActor::GetGenerateTicks ( )
inline

Definition at line 215 of file vtkGridAxes2DActor.h.

§ GenerateTicksOn()

virtual void vtkGridAxes2DActor::GenerateTicksOn ( )
virtual

§ GenerateTicksOff()

virtual void vtkGridAxes2DActor::GenerateTicksOff ( )
virtual

§ GetBounds()

virtual double* vtkGridAxes2DActor::GetBounds ( )
inlinevirtual

Returns the prop bounds.

Definition at line 226 of file vtkGridAxes2DActor.h.

§ RenderOpaqueGeometry()

virtual int vtkGridAxes2DActor::RenderOpaqueGeometry ( vtkViewport *  )
virtual

§ RenderTranslucentPolygonalGeometry()

virtual int vtkGridAxes2DActor::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport)
virtual

§ RenderOverlay()

virtual int vtkGridAxes2DActor::RenderOverlay ( vtkViewport *  viewport)
virtual

§ HasTranslucentPolygonalGeometry()

virtual int vtkGridAxes2DActor::HasTranslucentPolygonalGeometry ( )
virtual

§ ReleaseGraphicsResources()

virtual void vtkGridAxes2DActor::ReleaseGraphicsResources ( vtkWindow *  )
virtual

§ GetMTime()

vtkMTimeType vtkGridAxes2DActor::GetMTime ( )

Overridden to include the mtime for the text properties.

§ 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 252 of file vtkGridAxes2DActor.h.

§ vtkLabels

friend class vtkLabels
friend

Definition at line 279 of file vtkGridAxes2DActor.h.

Member Data Documentation

§ GridBounds

double vtkGridAxes2DActor::GridBounds[6]
protected

Definition at line 254 of file vtkGridAxes2DActor.h.

§ Face

int vtkGridAxes2DActor::Face
protected

Definition at line 255 of file vtkGridAxes2DActor.h.

§ LabelMask

unsigned int vtkGridAxes2DActor::LabelMask
protected

Definition at line 256 of file vtkGridAxes2DActor.h.

§ EnableLayerSupport

bool vtkGridAxes2DActor::EnableLayerSupport
protected

Definition at line 258 of file vtkGridAxes2DActor.h.

§ BackgroundLayer

int vtkGridAxes2DActor::BackgroundLayer
protected

Definition at line 259 of file vtkGridAxes2DActor.h.

§ ForegroundLayer

int vtkGridAxes2DActor::ForegroundLayer
protected

Definition at line 260 of file vtkGridAxes2DActor.h.

§ GeometryLayer

int vtkGridAxes2DActor::GeometryLayer
protected

Definition at line 261 of file vtkGridAxes2DActor.h.

§ TitleTextProperty

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

Definition at line 263 of file vtkGridAxes2DActor.h.

§ LabelTextProperty

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

Definition at line 264 of file vtkGridAxes2DActor.h.

§ Titles

vtkTuple<vtkStdString, 3> vtkGridAxes2DActor::Titles
protected

Definition at line 265 of file vtkGridAxes2DActor.h.

§ Helper

vtkNew<vtkGridAxesHelper> vtkGridAxes2DActor::Helper
protected

Definition at line 267 of file vtkGridAxes2DActor.h.

§ PlaneActor

vtkSmartPointer<vtkGridAxesPlane2DActor> vtkGridAxes2DActor::PlaneActor
protected

Definition at line 268 of file vtkGridAxes2DActor.h.

§ AxisHelpers

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

Definition at line 269 of file vtkGridAxes2DActor.h.

§ AxisHelperScene

vtkNew<vtkContextScene> vtkGridAxes2DActor::AxisHelperScene
protected

Definition at line 270 of file vtkGridAxes2DActor.h.

§ UpdateLabelTextPropertiesMTime

vtkTimeStamp vtkGridAxes2DActor::UpdateLabelTextPropertiesMTime
protected

Definition at line 271 of file vtkGridAxes2DActor.h.


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