vtkCubeAxesRepresentation Class Reference

representation for a cube-axes. More...

#include <vtkCubeAxesRepresentation.h>

Inheritance diagram for vtkCubeAxesRepresentation:

Collaboration diagram for vtkCubeAxesRepresentation:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetVisibility (bool visible)
virtual void	EnableCustomAxisRange (bool useCustomRange)
virtual void	SetFlyMode (int val)
virtual void	SetInertia (int val)
virtual void	SetCornerOffset (double val)
virtual void	SetTickLocation (int val)
virtual void	SetXTitle (const char *val)
virtual void	SetXAxisVisibility (int val)
virtual void	SetXAxisTickVisibility (int val)
virtual void	SetXAxisMinorTickVisibility (int val)
virtual void	SetDrawXGridlines (int val)
virtual void	SetXAxisRange (double min, double max)
virtual void	SetYAxisVisibility (int val)
virtual void	SetYTitle (const char *val)
virtual void	SetYAxisTickVisibility (int val)
virtual void	SetYAxisMinorTickVisibility (int val)
virtual void	SetDrawYGridlines (int val)
virtual void	SetYAxisRange (double min, double max)
virtual void	SetZAxisVisibility (int val)
virtual void	SetZTitle (const char *val)
virtual void	SetZAxisTickVisibility (int val)
virtual void	SetZAxisMinorTickVisibility (int val)
virtual void	SetDrawZGridlines (int val)
virtual void	SetZAxisRange (double min, double max)
virtual void	SetPosition (double, double, double)
virtual void	SetPosition (double[3])
virtual double *	GetPosition ()
virtual void	GetPosition (double &, double &, double &)
virtual void	GetPosition (double[3])
virtual void	SetOrientation (double, double, double)
virtual void	SetOrientation (double[3])
virtual double *	GetOrientation ()
virtual void	GetOrientation (double &, double &, double &)
virtual void	GetOrientation (double[3])
virtual void	SetScale (double, double, double)
virtual void	SetScale (double[3])
virtual double *	GetScale ()
virtual void	GetScale (double &, double &, double &)
virtual void	GetScale (double[3])
virtual double *	GetDataBounds ()
virtual void	GetDataBounds (double &, double &, double &, double &, double &, double &)
virtual void	GetDataBounds (double[6])
virtual void	SetCustomBounds (double, double, double, double, double, double)
virtual void	SetCustomBounds (double[6])
virtual double *	GetCustomBounds ()
virtual void	GetCustomBounds (double &, double &, double &, double &, double &, double &)
virtual void	GetCustomBounds (double[6])
virtual void	SetCustomBoundsActive (int, int, int)
virtual void	SetCustomBoundsActive (int[3])
virtual int *	GetCustomBoundsActive ()
virtual void	GetCustomBoundsActive (int &, int &, int &)
virtual void	GetCustomBoundsActive (int[3])
virtual void	SetColor (double r, double g, double b)
virtual void	SetColor (double rgb[3])
virtual void	MarkModified ()
virtual int	ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
Static Public Member Functions
static vtkCubeAxesRepresentation *	New ()
static int	IsTypeOf (const char *type)
static vtkCubeAxesRepresentation *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCubeAxesRepresentation ()
	~vtkCubeAxesRepresentation ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestData (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *)
virtual void	UpdateBounds ()
virtual bool	AddToView (vtkView *view)
virtual bool	RemoveFromView (vtkView *view)
Protected Attributes
vtkWeakPointer< vtkPVRenderView >	View
vtkTimeStamp	BoundsUpdateTime
vtkCubeAxesActor *	CubeAxesActor
double	Position [3]
double	Scale [3]
double	Orientation [3]
double	CustomBounds [6]
int	CustomBoundsActive [3]
double	DataBounds [6]
bool	UseBoundsRangeAsLabel

---

Detailed Description

representation for a cube-axes.

vtkCubeAxesRepresentation is a representation for the Cube-Axes that shows a bounding box with labels around any input dataset.

Definition at line 31 of file vtkCubeAxesRepresentation.h.

---

Constructor & Destructor Documentation

vtkCubeAxesRepresentation::vtkCubeAxesRepresentation

(

)

[protected]

vtkCubeAxesRepresentation::~vtkCubeAxesRepresentation

(

)

[protected]

---

Member Function Documentation

static vtkCubeAxesRepresentation* vtkCubeAxesRepresentation::New

(

)

[static]

Reimplemented from vtkDataRepresentation.

virtual const char* vtkCubeAxesRepresentation::GetClassName

(

)

[virtual]

Reimplemented from vtkPVDataRepresentation.

static int vtkCubeAxesRepresentation::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkPVDataRepresentation.

virtual int vtkCubeAxesRepresentation::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkPVDataRepresentation.

static vtkCubeAxesRepresentation* vtkCubeAxesRepresentation::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkPVDataRepresentation.

void vtkCubeAxesRepresentation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkPVDataRepresentation.

virtual void vtkCubeAxesRepresentation::SetPosition	(	double	,
		double	,
		double
	)		[virtual]

Get/Set the Position to transform the data bounds.

virtual void vtkCubeAxesRepresentation::SetPosition

(

double

[3]

)

[virtual]

Get/Set the Position to transform the data bounds.

virtual double* vtkCubeAxesRepresentation::GetPosition

(

)

[virtual]

Get/Set the Position to transform the data bounds.

virtual void vtkCubeAxesRepresentation::GetPosition	(	double &	,
		double &	,
		double &
	)		[virtual]

Get/Set the Position to transform the data bounds.

virtual void vtkCubeAxesRepresentation::GetPosition

(

double

[3]

)

[virtual]

Get/Set the Position to transform the data bounds.

virtual void vtkCubeAxesRepresentation::SetOrientation	(	double	,
		double	,
		double
	)		[virtual]

Get/Set the Orientation to transform the data bounds.

virtual void vtkCubeAxesRepresentation::SetOrientation

(

double

[3]

)

[virtual]

Get/Set the Orientation to transform the data bounds.

virtual double* vtkCubeAxesRepresentation::GetOrientation

(

)

[virtual]

Get/Set the Orientation to transform the data bounds.

virtual void vtkCubeAxesRepresentation::GetOrientation	(	double &	,
		double &	,
		double &
	)		[virtual]

Get/Set the Orientation to transform the data bounds.

virtual void vtkCubeAxesRepresentation::GetOrientation

(

double

[3]

)

[virtual]

Get/Set the Orientation to transform the data bounds.

virtual void vtkCubeAxesRepresentation::SetScale	(	double	,
		double	,
		double
	)		[virtual]

Get/Set the Scale to transform the data bounds.

virtual void vtkCubeAxesRepresentation::SetScale

(

double

[3]

)

[virtual]

Get/Set the Scale to transform the data bounds.

virtual double* vtkCubeAxesRepresentation::GetScale

(

)

[virtual]

Get/Set the Scale to transform the data bounds.

virtual void vtkCubeAxesRepresentation::GetScale	(	double &	,
		double &	,
		double &
	)		[virtual]

Get/Set the Scale to transform the data bounds.

virtual void vtkCubeAxesRepresentation::GetScale

(

double

[3]

)

[virtual]

Get/Set the Scale to transform the data bounds.

virtual double* vtkCubeAxesRepresentation::GetDataBounds

(

)

[virtual]

Get/Set the bounds of the data.

virtual void vtkCubeAxesRepresentation::GetDataBounds	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)		[virtual]

Get/Set the bounds of the data.

virtual void vtkCubeAxesRepresentation::GetDataBounds

(

double

[6]

)

[virtual]

Get/Set the bounds of the data.

virtual void vtkCubeAxesRepresentation::SetCustomBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)		[virtual]

Get/Set custom bounds to use. When corresponding CustomBoundsActive is true, the data bounds will be ignored for that direction and CustomBounds will be used instead.

virtual void vtkCubeAxesRepresentation::SetCustomBounds

(

double

[6]

)

[virtual]

Get/Set custom bounds to use. When corresponding CustomBoundsActive is true, the data bounds will be ignored for that direction and CustomBounds will be used instead.

virtual double* vtkCubeAxesRepresentation::GetCustomBounds

(

)

[virtual]

Get/Set custom bounds to use. When corresponding CustomBoundsActive is true, the data bounds will be ignored for that direction and CustomBounds will be used instead.

virtual void vtkCubeAxesRepresentation::GetCustomBounds	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)		[virtual]

Get/Set custom bounds to use. When corresponding CustomBoundsActive is true, the data bounds will be ignored for that direction and CustomBounds will be used instead.

virtual void vtkCubeAxesRepresentation::GetCustomBounds

(

double

[6]

)

[virtual]

Get/Set custom bounds to use. When corresponding CustomBoundsActive is true, the data bounds will be ignored for that direction and CustomBounds will be used instead.

virtual void vtkCubeAxesRepresentation::SetCustomBoundsActive	(	int	,
		int	,
		int
	)		[virtual]

Get/Set whether to use custom bounds for a particular dimension.

virtual void vtkCubeAxesRepresentation::SetCustomBoundsActive

(

int

[3]

)

[virtual]

Get/Set whether to use custom bounds for a particular dimension.

virtual int* vtkCubeAxesRepresentation::GetCustomBoundsActive

(

)

[virtual]

Get/Set whether to use custom bounds for a particular dimension.

virtual void vtkCubeAxesRepresentation::GetCustomBoundsActive	(	int &	,
		int &	,
		int &
	)		[virtual]

Get/Set whether to use custom bounds for a particular dimension.

virtual void vtkCubeAxesRepresentation::GetCustomBoundsActive

(

int

[3]

)

[virtual]

Get/Set whether to use custom bounds for a particular dimension.

virtual void vtkCubeAxesRepresentation::SetColor	(	double	r,
		double	g,
		double	b
	)		[virtual]

Set the actor color.

virtual void vtkCubeAxesRepresentation::SetColor

(

double

rgb[3]

)

[inline, virtual]

Set the actor color.

Definition at line 78 of file vtkCubeAxesRepresentation.h.

virtual void vtkCubeAxesRepresentation::MarkModified

(

)

[inline, virtual]

This needs to be called on all instances of vtkCubeAxesRepresentation when the input is modified.

Reimplemented from vtkPVDataRepresentation.

Definition at line 85 of file vtkCubeAxesRepresentation.h.

virtual int vtkCubeAxesRepresentation::ProcessViewRequest	(	vtkInformationRequestKey *	request_type,
		vtkInformation *	inInfo,
		vtkInformation *	outInfo
	)		[virtual]

vtkAlgorithm::ProcessRequest() equivalent for rendering passes. This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering.

Reimplemented from vtkPVDataRepresentation.

virtual void vtkCubeAxesRepresentation::SetVisibility

(

bool

visible

)

[virtual]

Set visibility of the representation.

Reimplemented from vtkPVDataRepresentation.

virtual void vtkCubeAxesRepresentation::EnableCustomAxisRange

(

bool

useCustomRange

)

[virtual]

Allow user to specify custom XYZAxisRanges based on arbitrary number

virtual void vtkCubeAxesRepresentation::SetFlyMode

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetInertia

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetCornerOffset

(

double

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetTickLocation

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetXTitle

(

const char *

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetXAxisVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetXAxisTickVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetXAxisMinorTickVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetDrawXGridlines

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetXAxisRange	(	double	min,
		double	max
	)		[virtual]

virtual void vtkCubeAxesRepresentation::SetYAxisVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetYTitle

(

const char *

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetYAxisTickVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetYAxisMinorTickVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetDrawYGridlines

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetYAxisRange	(	double	min,
		double	max
	)		[virtual]

virtual void vtkCubeAxesRepresentation::SetZAxisVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetZTitle

(

const char *

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetZAxisTickVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetZAxisMinorTickVisibility

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetDrawZGridlines

(

int

val

)

[virtual]

virtual void vtkCubeAxesRepresentation::SetZAxisRange	(	double	min,
		double	max
	)		[virtual]

virtual int vtkCubeAxesRepresentation::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)		[protected, virtual]

Reimplemented from vtkPassInputTypeAlgorithm.

virtual int vtkCubeAxesRepresentation::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		[protected, virtual]

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

virtual void vtkCubeAxesRepresentation::UpdateBounds

(

)

[protected, virtual]

virtual bool vtkCubeAxesRepresentation::AddToView

(

vtkView *

view

)

[protected, virtual]

Adds the representation to the view. This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Reimplemented from vtkPVDataRepresentation.

virtual bool vtkCubeAxesRepresentation::RemoveFromView

(

vtkView *

view

)

[protected, virtual]

Removes the representation to the view. This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Reimplemented from vtkPVDataRepresentation.

---

Member Data Documentation

vtkWeakPointer<vtkPVRenderView> vtkCubeAxesRepresentation::View [protected]

Definition at line 152 of file vtkCubeAxesRepresentation.h.

vtkTimeStamp vtkCubeAxesRepresentation::BoundsUpdateTime [protected]

Definition at line 153 of file vtkCubeAxesRepresentation.h.

vtkCubeAxesActor* vtkCubeAxesRepresentation::CubeAxesActor [protected]

Definition at line 154 of file vtkCubeAxesRepresentation.h.

double vtkCubeAxesRepresentation::Position[3] [protected]

Definition at line 155 of file vtkCubeAxesRepresentation.h.

double vtkCubeAxesRepresentation::Scale[3] [protected]

Definition at line 156 of file vtkCubeAxesRepresentation.h.

double vtkCubeAxesRepresentation::Orientation[3] [protected]

Definition at line 157 of file vtkCubeAxesRepresentation.h.

double vtkCubeAxesRepresentation::CustomBounds[6] [protected]

Definition at line 158 of file vtkCubeAxesRepresentation.h.

int vtkCubeAxesRepresentation::CustomBoundsActive[3] [protected]

Definition at line 159 of file vtkCubeAxesRepresentation.h.

double vtkCubeAxesRepresentation::DataBounds[6] [protected]

Definition at line 160 of file vtkCubeAxesRepresentation.h.

bool vtkCubeAxesRepresentation::UseBoundsRangeAsLabel [protected]

Definition at line 161 of file vtkCubeAxesRepresentation.h.

---

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

• dox/ParaViewCore/ClientServerCore/vtkCubeAxesRepresentation.h