generate a 3D cursor representation More...

#include <vtkCursor3D.h>

Inheritance diagram for vtkCursor3D:

Collaboration diagram for vtkCursor3D:

Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkCursor3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
vtkPolyData *	GetFocus ()

void	SetModelBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
void	SetModelBounds (double bounds[6])
virtual double *	GetModelBounds ()
virtual void	GetModelBounds (double data[6])

void	SetFocalPoint (double x[3])
void	SetFocalPoint (double x, double y, double z)
virtual double *	GetFocalPoint ()
virtual void	GetFocalPoint (double data[3])

virtual void	SetOutline (int)
virtual int	GetOutline ()
virtual void	OutlineOn ()
virtual void	OutlineOff ()

virtual void	SetAxes (int)
virtual int	GetAxes ()
virtual void	AxesOn ()
virtual void	AxesOff ()

virtual void	SetXShadows (int)
virtual int	GetXShadows ()
virtual void	XShadowsOn ()
virtual void	XShadowsOff ()

virtual void	SetYShadows (int)
virtual int	GetYShadows ()
virtual void	YShadowsOn ()
virtual void	YShadowsOff ()

virtual void	SetZShadows (int)
virtual int	GetZShadows ()
virtual void	ZShadowsOn ()
virtual void	ZShadowsOff ()

virtual void	SetTranslationMode (int)
virtual int	GetTranslationMode ()
virtual void	TranslationModeOn ()
virtual void	TranslationModeOff ()

virtual void	SetWrap (int)
virtual int	GetWrap ()
virtual void	WrapOn ()
virtual void	WrapOff ()

void	AllOn ()
void	AllOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCursor3D *	SafeDownCast (vtkObjectBase *o)
static vtkCursor3D *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCursor3D ()
	~vtkCursor3D ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
vtkPolyData *	Focus
double	ModelBounds [6]
double	FocalPoint [3]
int	Outline
int	Axes
int	XShadows
int	YShadows
int	ZShadows
int	TranslationMode
int	Wrap

Detailed Description

generate a 3D cursor representation

vtkCursor3D is an object that generates a 3D representation of a cursor. The cursor consists of a wireframe bounding box, three intersecting axes lines that meet at the cursor focus, and "shadows" or projections of the axes against the sides of the bounding box. Each of these components can be turned on/off.

This filter generates two output datasets. The first (Output) is just the geometric representation of the cursor. The second (Focus) is a single point at the focal point.

Tests:: vtkCursor3D (Tests)

Definition at line 38 of file vtkCursor3D.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkCursor3D::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 41 of file vtkCursor3D.h.

Constructor & Destructor Documentation

vtkCursor3D::vtkCursor3D ( ) [protected]

vtkCursor3D::~vtkCursor3D ( ) [protected]

Member Function Documentation

static int vtkCursor3D::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkCursor3D::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

static vtkCursor3D* vtkCursor3D::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

virtual vtkObjectBase* vtkCursor3D::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.

vtkCursor3D* vtkCursor3D::NewInstance ( ) const

Reimplemented from vtkPolyDataAlgorithm.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

static vtkCursor3D* vtkCursor3D::New ( ) [static]

Construct with model bounds = (-1,1,-1,1,-1,1), focal point = (0,0,0), all parts of cursor visible, and wrapping off.

Reimplemented from vtkPolyDataAlgorithm.

void vtkCursor3D::SetModelBounds	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

Set / get the boundary of the 3D cursor.

void vtkCursor3D::SetModelBounds ( double bounds[6] )

Set / get the boundary of the 3D cursor.

virtual double* vtkCursor3D::GetModelBounds ( ) [virtual]

Set / get the boundary of the 3D cursor.

virtual void vtkCursor3D::GetModelBounds ( double data[6] ) [virtual]

Set / get the boundary of the 3D cursor.

void vtkCursor3D::SetFocalPoint ( double x[3] )

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.)

void vtkCursor3D::SetFocalPoint	(	double	x,
		double	y,
		double	z
	)		`[inline]`

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.)

Definition at line 63 of file vtkCursor3D.h.

virtual double* vtkCursor3D::GetFocalPoint ( ) [virtual]

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.)

virtual void vtkCursor3D::GetFocalPoint ( double data[3] ) [virtual]

Set/Get the position of cursor focus. If translation mode is on, then the entire cursor (including bounding box, cursor, and shadows) is translated. Otherwise, the focal point will either be clamped to the bounding box, or wrapped, if Wrap is on. (Note: this behavior requires that the bounding box is set prior to the focal point.)

virtual void vtkCursor3D::SetOutline ( int ) [virtual]

Turn on/off the wireframe bounding box.

virtual int vtkCursor3D::GetOutline ( ) [virtual]

Turn on/off the wireframe bounding box.

virtual void vtkCursor3D::OutlineOn ( ) [virtual]

Turn on/off the wireframe bounding box.

virtual void vtkCursor3D::OutlineOff ( ) [virtual]

Turn on/off the wireframe bounding box.

virtual void vtkCursor3D::SetAxes ( int ) [virtual]

Turn on/off the wireframe axes.

virtual int vtkCursor3D::GetAxes ( ) [virtual]

Turn on/off the wireframe axes.

virtual void vtkCursor3D::AxesOn ( ) [virtual]

Turn on/off the wireframe axes.

virtual void vtkCursor3D::AxesOff ( ) [virtual]

Turn on/off the wireframe axes.

virtual void vtkCursor3D::SetXShadows ( int ) [virtual]

Turn on/off the wireframe x-shadows.

virtual int vtkCursor3D::GetXShadows ( ) [virtual]

Turn on/off the wireframe x-shadows.

virtual void vtkCursor3D::XShadowsOn ( ) [virtual]

Turn on/off the wireframe x-shadows.

virtual void vtkCursor3D::XShadowsOff ( ) [virtual]

Turn on/off the wireframe x-shadows.

virtual void vtkCursor3D::SetYShadows ( int ) [virtual]

Turn on/off the wireframe y-shadows.

virtual int vtkCursor3D::GetYShadows ( ) [virtual]

Turn on/off the wireframe y-shadows.

virtual void vtkCursor3D::YShadowsOn ( ) [virtual]

Turn on/off the wireframe y-shadows.

virtual void vtkCursor3D::YShadowsOff ( ) [virtual]

Turn on/off the wireframe y-shadows.

virtual void vtkCursor3D::SetZShadows ( int ) [virtual]

Turn on/off the wireframe z-shadows.

virtual int vtkCursor3D::GetZShadows ( ) [virtual]

Turn on/off the wireframe z-shadows.

virtual void vtkCursor3D::ZShadowsOn ( ) [virtual]

Turn on/off the wireframe z-shadows.

virtual void vtkCursor3D::ZShadowsOff ( ) [virtual]

Turn on/off the wireframe z-shadows.

virtual void vtkCursor3D::SetTranslationMode ( int ) [virtual]

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual int vtkCursor3D::GetTranslationMode ( ) [virtual]

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual void vtkCursor3D::TranslationModeOn ( ) [virtual]

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual void vtkCursor3D::TranslationModeOff ( ) [virtual]

Enable/disable the translation mode. If on, changes in cursor position cause the entire widget to translate along with the cursor. By default, translation mode is off.

virtual void vtkCursor3D::SetWrap ( int ) [virtual]

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

virtual int vtkCursor3D::GetWrap ( ) [virtual]

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

virtual void vtkCursor3D::WrapOn ( ) [virtual]

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

virtual void vtkCursor3D::WrapOff ( ) [virtual]

Turn on/off cursor wrapping. If the cursor focus moves outside the specified bounds, the cursor will either be restrained against the nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).

vtkPolyData* vtkCursor3D::GetFocus ( ) [inline]

Get the focus for this filter.

Definition at line 126 of file vtkCursor3D.h.

void vtkCursor3D::AllOn ( )

Turn every part of the 3D cursor on or off.

void vtkCursor3D::AllOff ( )

Turn every part of the 3D cursor on or off.

int vtkCursor3D::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`