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

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

#include <vtkGridAxesPlane2DActor.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  { TICK_DIRECTION_INWARDS = 0x1, TICK_DIRECTION_OUTWARDS = 0x2, TICK_DIRECTION_BOTH = TICK_DIRECTION_INWARDS | TICK_DIRECTION_OUTWARDS }
 
typedef vtkProp3D Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetTickPositions (int axis, vtkDoubleArray *data)
 Set the tick positions for each of the coordinate axis. More...
 
const std::deque< double > & GetTickPositions (int axis)
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
 
virtual int RenderOverlay (vtkViewport *viewport)
 
virtual int HasTranslucentPolygonalGeometry ()
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
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...
 
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 SetLayer (int)
 Set the layer to render this prop under when EnableLayerSupport is true. More...
 
virtual int GetLayer ()
 Set the layer to render this prop under when EnableLayerSupport is true. 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...
 
virtual double * GetBounds ()
 Returns the prop bounds. More...
 

Static Public Member Functions

static vtkGridAxesPlane2DActorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGridAxesPlane2DActorSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkGridAxesPlane2DActor (vtkGridAxesHelper *helper=NULL)
 
 ~vtkGridAxesPlane2DActor ()
 
bool IsLayerActive (vtkViewport *viewport)
 Returns true if the actor must render in the viewport. More...
 
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 Attributes

double GridBounds [6]
 
int Face
 
bool GenerateGrid
 
bool GenerateEdges
 
bool GenerateTicks
 
unsigned int TickDirection
 
std::deque< double > TickPositions [3]
 
bool EnableLayerSupport
 
int Layer
 
vtkNew< vtkPolyData > PolyData
 
vtkNew< vtkPoints > PolyDataPoints
 
vtkNew< vtkCellArray > PolyDataLines
 
vtkNew< vtkPolyDataMapper > Mapper
 
vtkNew< vtkActor > Actor
 
vtkSmartPointer< vtkGridAxesHelperHelper
 
bool HelperManagedExternally
 
class vtkGridAxes2DActor
 vtkGridAxes2DActor uses this method to create vtkGridAxesPlane2DActor instance. More...
 
static vtkGridAxesPlane2DActorNew (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 43 of file vtkGridAxesPlane2DActor.h.

Member Typedef Documentation

§ Superclass

Definition at line 47 of file vtkGridAxesPlane2DActor.h.

Member Enumeration Documentation

§ Faces

Enumerator
MIN_YZ 
MIN_ZX 
MIN_XY 
MAX_YZ 
MAX_ZX 
MAX_XY 

Definition at line 64 of file vtkGridAxesPlane2DActor.h.

§ anonymous enum

anonymous enum
Enumerator
TICK_DIRECTION_INWARDS 
TICK_DIRECTION_OUTWARDS 
TICK_DIRECTION_BOTH 

Definition at line 114 of file vtkGridAxesPlane2DActor.h.

Constructor & Destructor Documentation

§ vtkGridAxesPlane2DActor()

vtkGridAxesPlane2DActor::vtkGridAxesPlane2DActor ( vtkGridAxesHelper helper = NULL)
protected

§ ~vtkGridAxesPlane2DActor()

vtkGridAxesPlane2DActor::~vtkGridAxesPlane2DActor ( )
protected

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

§ SafeDownCast()

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

§ PrintSelf()

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

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

§ 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 NULL 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 139 of file vtkGridAxesPlane2DActor.h.

§ SetEnableLayerSupport()

virtual void vtkGridAxesPlane2DActor::SetEnableLayerSupport ( bool  )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop will only render when the viewport's layer matches the Layer set on this prop.

§ GetEnableLayerSupport()

virtual bool vtkGridAxesPlane2DActor::GetEnableLayerSupport ( )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop will only render when the viewport's layer matches the Layer set on this prop.

§ EnableLayerSupportOn()

virtual void vtkGridAxesPlane2DActor::EnableLayerSupportOn ( )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop will only render when the viewport's layer matches the Layer set on this prop.

§ EnableLayerSupportOff()

virtual void vtkGridAxesPlane2DActor::EnableLayerSupportOff ( )
virtual

Enable/Disable layer support.

Default is off. When enabled, the prop will only render when the viewport's layer matches the Layer set on this prop.

§ SetLayer()

virtual void vtkGridAxesPlane2DActor::SetLayer ( int  )
virtual

Set the layer to render this prop under when EnableLayerSupport is true.

Default is 0.

§ GetLayer()

virtual int vtkGridAxesPlane2DActor::GetLayer ( )
virtual

Set the layer to render this prop under when EnableLayerSupport is true.

Default is 0.

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

virtual double* vtkGridAxesPlane2DActor::GetBounds ( )
inlinevirtual

Returns the prop bounds.

Definition at line 179 of file vtkGridAxesPlane2DActor.h.

§ RenderOpaqueGeometry()

virtual int vtkGridAxesPlane2DActor::RenderOpaqueGeometry ( vtkViewport *  )
virtual

§ RenderTranslucentPolygonalGeometry()

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

§ RenderOverlay()

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

§ HasTranslucentPolygonalGeometry()

virtual int vtkGridAxesPlane2DActor::HasTranslucentPolygonalGeometry ( )
virtual

§ ReleaseGraphicsResources()

virtual void vtkGridAxesPlane2DActor::ReleaseGraphicsResources ( vtkWindow *  )
virtual

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

§ IsLayerActive()

bool vtkGridAxesPlane2DActor::IsLayerActive ( vtkViewport *  viewport)
protected

Returns true if the actor must render in the viewport.

§ 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 204 of file vtkGridAxesPlane2DActor.h.

Member Data Documentation

§ GridBounds

double vtkGridAxesPlane2DActor::GridBounds[6]
protected

Definition at line 222 of file vtkGridAxesPlane2DActor.h.

§ Face

int vtkGridAxesPlane2DActor::Face
protected

Definition at line 223 of file vtkGridAxesPlane2DActor.h.

§ GenerateGrid

bool vtkGridAxesPlane2DActor::GenerateGrid
protected

Definition at line 225 of file vtkGridAxesPlane2DActor.h.

§ GenerateEdges

bool vtkGridAxesPlane2DActor::GenerateEdges
protected

Definition at line 226 of file vtkGridAxesPlane2DActor.h.

§ GenerateTicks

bool vtkGridAxesPlane2DActor::GenerateTicks
protected

Definition at line 227 of file vtkGridAxesPlane2DActor.h.

§ TickDirection

unsigned int vtkGridAxesPlane2DActor::TickDirection
protected

Definition at line 228 of file vtkGridAxesPlane2DActor.h.

§ TickPositions

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

Definition at line 229 of file vtkGridAxesPlane2DActor.h.

§ EnableLayerSupport

bool vtkGridAxesPlane2DActor::EnableLayerSupport
protected

Definition at line 231 of file vtkGridAxesPlane2DActor.h.

§ Layer

int vtkGridAxesPlane2DActor::Layer
protected

Definition at line 232 of file vtkGridAxesPlane2DActor.h.

§ PolyData

vtkNew<vtkPolyData> vtkGridAxesPlane2DActor::PolyData
protected

Definition at line 234 of file vtkGridAxesPlane2DActor.h.

§ PolyDataPoints

vtkNew<vtkPoints> vtkGridAxesPlane2DActor::PolyDataPoints
protected

Definition at line 235 of file vtkGridAxesPlane2DActor.h.

§ PolyDataLines

vtkNew<vtkCellArray> vtkGridAxesPlane2DActor::PolyDataLines
protected

Definition at line 236 of file vtkGridAxesPlane2DActor.h.

§ Mapper

vtkNew<vtkPolyDataMapper> vtkGridAxesPlane2DActor::Mapper
protected

Definition at line 237 of file vtkGridAxesPlane2DActor.h.

§ Actor

vtkNew<vtkActor> vtkGridAxesPlane2DActor::Actor
protected

Definition at line 238 of file vtkGridAxesPlane2DActor.h.

§ Helper

vtkSmartPointer<vtkGridAxesHelper> vtkGridAxesPlane2DActor::Helper
protected

Definition at line 240 of file vtkGridAxesPlane2DActor.h.

§ HelperManagedExternally

bool vtkGridAxesPlane2DActor::HelperManagedExternally
protected

Definition at line 241 of file vtkGridAxesPlane2DActor.h.


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