generate a 2D cursor representation More...

#include <vtkCursor2D.h>

Inheritance diagram for vtkCursor2D:

Collaboration diagram for vtkCursor2D:

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

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	SetRadius (double)
virtual double	GetRadius ()

virtual void	SetPoint (int)
virtual int	GetPoint ()
virtual void	PointOn ()
virtual void	PointOff ()

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 vtkCursor2D *	SafeDownCast (vtkObjectBase *o)
static vtkCursor2D *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCursor2D ()
	~vtkCursor2D ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
double	ModelBounds [6]
double	FocalPoint [3]
int	Outline
int	Axes
int	Point
double	Radius
int	TranslationMode
int	Wrap

Detailed Description

generate a 2D cursor representation

vtkCursor2D is a class that generates a 2D cursor representation. The cursor consists of two intersection axes lines that meet at the cursor focus. Several optional features are available as well. An optional 2D bounding box may be enabled. An inner radius, centered at the focal point, can be set that erases the intersecting lines (e.g., it leaves a clear area under the focal point so you can see what you are selecting). And finally, an optional point can be enabled located at the focal point. All of these features can be turned on and off independently.

Tests:: vtkCursor2D (Tests)

Definition at line 39 of file vtkCursor2D.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkCursor2D::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 42 of file vtkCursor2D.h.

Constructor & Destructor Documentation

vtkCursor2D::vtkCursor2D ( ) [protected]

vtkCursor2D::~vtkCursor2D ( ) [inline, protected]

Definition at line 129 of file vtkCursor2D.h.

Member Function Documentation

static int vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D* vtkCursor2D::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

vtkCursor2D* vtkCursor2D::NewInstance ( ) const

Reimplemented from vtkPolyDataAlgorithm.

void vtkCursor2D::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 vtkCursor2D* vtkCursor2D::New ( ) [static]

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

Reimplemented from vtkPolyDataAlgorithm.

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

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

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

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

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

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

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

Set / get the bounding box of the 2D cursor. This defines the outline of the cursor, and where the focal point should lie.

void vtkCursor2D::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.) Note that the method takes a 3D point but ignores the z-coordinate value.

void vtkCursor2D::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.) Note that the method takes a 3D point but ignores the z-coordinate value.

Definition at line 66 of file vtkCursor2D.h.

virtual double* vtkCursor2D::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.) Note that the method takes a 3D point but ignores the z-coordinate value.

virtual void vtkCursor2D::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.) Note that the method takes a 3D point but ignores the z-coordinate value.

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

Turn on/off the wireframe bounding box.

virtual int vtkCursor2D::GetOutline ( ) [virtual]

Turn on/off the wireframe bounding box.

virtual void vtkCursor2D::OutlineOn ( ) [virtual]

Turn on/off the wireframe bounding box.

virtual void vtkCursor2D::OutlineOff ( ) [virtual]

Turn on/off the wireframe bounding box.

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

Turn on/off the wireframe axes.

virtual int vtkCursor2D::GetAxes ( ) [virtual]

Turn on/off the wireframe axes.

virtual void vtkCursor2D::AxesOn ( ) [virtual]

Turn on/off the wireframe axes.

virtual void vtkCursor2D::AxesOff ( ) [virtual]

Turn on/off the wireframe axes.

virtual void vtkCursor2D::SetRadius ( double ) [virtual]

Specify a radius for a circle. This erases the cursor lines around the focal point.

virtual double vtkCursor2D::GetRadius ( ) [virtual]

Specify a radius for a circle. This erases the cursor lines around the focal point.

virtual void vtkCursor2D::SetPoint ( int ) [virtual]

Turn on/off the point located at the cursor focus.

virtual int vtkCursor2D::GetPoint ( ) [virtual]

Turn on/off the point located at the cursor focus.

virtual void vtkCursor2D::PointOn ( ) [virtual]

Turn on/off the point located at the cursor focus.

virtual void vtkCursor2D::PointOff ( ) [virtual]

Turn on/off the point located at the cursor focus.

virtual void vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D::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 vtkCursor2D::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).

void vtkCursor2D::AllOn ( )

Turn every part of the cursor on or off.

void vtkCursor2D::AllOff ( )

Turn every part of the cursor on or off.

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