---

vtkCursor3D Class Reference

generate a 3D cursor representation. More...

#include <vtkCursor3D.h>

Inheritance diagram for vtkCursor3D:

[legend]Collaboration diagram for vtkCursor3D:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetModelBounds (float xmin, float xmax, float ymin, float ymax, float zmin, float zmax)
void	SetModelBounds (float *bounds)
virtual float *	GetModelBounds ()
virtual void	GetModelBounds (float data[6])
virtual void	SetFocalPoint (float, float, float)
virtual void	SetFocalPoint (float[3])
virtual float *	GetFocalPoint ()
virtual void	GetFocalPoint (float 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	SetWrap (int)
virtual int	GetWrap ()
virtual void	WrapOn ()
virtual void	WrapOff ()
vtkPolyData *	GetFocus ()
void	AllOn ()
void	AllOff ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkCursor3D *	SafeDownCast (vtkObject *o)
vtkCursor3D *	New ()
Protected Methods
	vtkCursor3D ()
	~vtkCursor3D ()
	vtkCursor3D (const vtkCursor3D &)
void	operator= (const vtkCursor3D &)
void	Execute ()
Protected Attributes
vtkPolyData *	Focus
float	ModelBounds [6]
float	FocalPoint [3]
int	Outline
int	Axes
int	XShadows
int	YShadows
int	ZShadows
int	Wrap

---

Detailed Description

generate a 3D cursor representation.

Date:

2000/12/10 20:08:33

Revision:

1.32

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.

Examples:

vtkCursor3D (examples)

Definition at line 65 of file vtkCursor3D.h.

---

Constructor & Destructor Documentation

vtkCursor3D::vtkCursor3D (    )  [protected]

vtkCursor3D::~vtkCursor3D (    )  [protected]

vtkCursor3D::vtkCursor3D (  const vtkCursor3D &    )  [inline, protected]

Definition at line 127 of file vtkCursor3D.h.

---

Member Function Documentation

virtual const char* vtkCursor3D::GetClassName (    )  [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkPolyDataSource.

int vtkCursor3D::IsTypeOf (  const char *    type )  [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 vtkPolyDataSource.

virtual int vtkCursor3D::IsA (  const char *    type )  [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 vtkPolyDataSource.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkPolyDataSource.

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

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

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

Set / get the boundary of the 3D cursor.

void vtkCursor3D::SetModelBounds (  float *    bounds )

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

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

virtual void vtkCursor3D::SetFocalPoint (  float   , float   , float    )  [virtual]

Specify the position of cursor focus.

virtual void vtkCursor3D::SetFocalPoint (  float   [3] )  [virtual]

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

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

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

Turn on/off the wireframe bounding box.

virtual int vtkCursor3D::GetOutline (    )  [virtual]

virtual void vtkCursor3D::OutlineOn (    )  [virtual]

virtual void vtkCursor3D::OutlineOff (    )  [virtual]

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

Turn on/off the wireframe axes.

virtual int vtkCursor3D::GetAxes (    )  [virtual]

virtual void vtkCursor3D::AxesOn (    )  [virtual]

virtual void vtkCursor3D::AxesOff (    )  [virtual]

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

Turn on/off the wireframe x-shadows.

virtual int vtkCursor3D::GetXShadows (    )  [virtual]

virtual void vtkCursor3D::XShadowsOn (    )  [virtual]

virtual void vtkCursor3D::XShadowsOff (    )  [virtual]

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

Turn on/off the wireframe y-shadows.

virtual int vtkCursor3D::GetYShadows (    )  [virtual]

virtual void vtkCursor3D::YShadowsOn (    )  [virtual]

virtual void vtkCursor3D::YShadowsOff (    )  [virtual]

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

Turn on/off the wireframe z-shadows.

virtual int vtkCursor3D::GetZShadows (    )  [virtual]

virtual void vtkCursor3D::ZShadowsOn (    )  [virtual]

virtual void vtkCursor3D::ZShadowsOff (    )  [virtual]

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]

virtual void vtkCursor3D::WrapOn (    )  [virtual]

virtual void vtkCursor3D::WrapOff (    )  [virtual]

vtkPolyData* vtkCursor3D::GetFocus (    )  [inline]

Get the focus for this filter. Definition at line 118 of file vtkCursor3D.h.

void vtkCursor3D::AllOn (    )

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

void vtkCursor3D::AllOff (    )

void vtkCursor3D::operator= (  const vtkCursor3D &    )  [inline, protected]

Definition at line 128 of file vtkCursor3D.h.

void vtkCursor3D::Execute (    )  [protected, virtual]

Reimplemented from vtkSource.

---

Member Data Documentation

vtkPolyData* vtkCursor3D::Focus [protected]

Definition at line 132 of file vtkCursor3D.h.

float vtkCursor3D::ModelBounds[6] [protected]

Definition at line 133 of file vtkCursor3D.h.

float vtkCursor3D::FocalPoint[3] [protected]

Definition at line 134 of file vtkCursor3D.h.

int vtkCursor3D::Outline [protected]

Definition at line 135 of file vtkCursor3D.h.

int vtkCursor3D::Axes [protected]

Definition at line 136 of file vtkCursor3D.h.

int vtkCursor3D::XShadows [protected]

Definition at line 137 of file vtkCursor3D.h.

int vtkCursor3D::YShadows [protected]

Definition at line 138 of file vtkCursor3D.h.

int vtkCursor3D::ZShadows [protected]

Definition at line 139 of file vtkCursor3D.h.

int vtkCursor3D::Wrap [protected]

Definition at line 140 of file vtkCursor3D.h.

---

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

• graphics/vtkCursor3D.h

---