---

vtkImageCursor3D Class Reference

Paints a cursor on top of an image or volume. More...

#include <vtkImageCursor3D.h>

Inheritance diagram for vtkImageCursor3D:

[legend]Collaboration diagram for vtkImageCursor3D:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetCursorPosition (float, float, float)
virtual void	SetCursorPosition (float[3])
virtual float *	GetCursorPosition ()
virtual void	GetCursorPosition (float &, float &, float &)
virtual void	GetCursorPosition (float[3])
virtual void	SetCursorValue (float)
virtual float	GetCursorValue ()
virtual void	SetCursorRadius (int)
virtual int	GetCursorRadius ()
Static Public Methods
vtkImageCursor3D *	New ()
int	IsTypeOf (const char *type)
vtkImageCursor3D *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageCursor3D ()
	~vtkImageCursor3D ()
	vtkImageCursor3D (const vtkImageCursor3D &)
void	operator= (const vtkImageCursor3D &)
void	Execute (vtkImageData *inData, vtkImageData *outData)
void	Execute ()
void	Execute (vtkImageData *outData)
Protected Attributes
float	CursorPosition [3]
float	CursorValue
int	CursorRadius

---

Detailed Description

Paints a cursor on top of an image or volume.

Date:

2000/12/10 20:09:04

Revision:

1.14

Thanks:

Thanks to C. Charles Law who developed this class.

vtkImageCursor3D will draw a cursor on a 2d image or 3d volume.

Examples:

vtkImageCursor3D (examples)

Definition at line 58 of file vtkImageCursor3D.h.

---

Constructor & Destructor Documentation

vtkImageCursor3D::vtkImageCursor3D (    )  [protected]

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

Definition at line 82 of file vtkImageCursor3D.h.

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

Definition at line 83 of file vtkImageCursor3D.h.

---

Member Function Documentation

vtkImageCursor3D* vtkImageCursor3D::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageInPlaceFilter.

virtual const char* vtkImageCursor3D::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 vtkImageInPlaceFilter.

int vtkImageCursor3D::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 vtkImageInPlaceFilter.

virtual int vtkImageCursor3D::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 vtkImageInPlaceFilter.

vtkImageCursor3D* vtkImageCursor3D::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 vtkImageInPlaceFilter.

void vtkImageCursor3D::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 vtkImageToImageFilter.

virtual void vtkImageCursor3D::SetCursorPosition (  float   , float   , float    )  [virtual]

Sets/Gets the center point of the 3d cursor.

virtual void vtkImageCursor3D::SetCursorPosition (  float   [3] )  [virtual]

virtual float* vtkImageCursor3D::GetCursorPosition (    )  [virtual]

virtual void vtkImageCursor3D::GetCursorPosition (  float &   , float &   , float &    )  [virtual]

virtual void vtkImageCursor3D::GetCursorPosition (  float   [3] )  [virtual]

virtual void vtkImageCursor3D::SetCursorValue (  float    )  [virtual]

Sets/Gets what pixel value to draw the cursor in.

virtual float vtkImageCursor3D::GetCursorValue (    )  [virtual]

virtual void vtkImageCursor3D::SetCursorRadius (  int    )  [virtual]

Sets/Gets the radius of the cursor. The radius determines how far the axis lines project out from the cursors center.

virtual int vtkImageCursor3D::GetCursorRadius (    )  [virtual]

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

Definition at line 84 of file vtkImageCursor3D.h.

void vtkImageCursor3D::Execute (  vtkImageData *    inData, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageInPlaceFilter.

void vtkImageCursor3D::Execute (    )  [inline, protected, virtual]

Reimplemented from vtkImageInPlaceFilter. Definition at line 93 of file vtkImageCursor3D.h.

void vtkImageCursor3D::Execute (  vtkImageData *    outData )  [inline, protected, virtual]

Reimplemented from vtkImageInPlaceFilter. Definition at line 94 of file vtkImageCursor3D.h.

---

Member Data Documentation

float vtkImageCursor3D::CursorPosition[3] [protected]

Definition at line 86 of file vtkImageCursor3D.h.

float vtkImageCursor3D::CursorValue [protected]

Definition at line 87 of file vtkImageCursor3D.h.

int vtkImageCursor3D::CursorRadius [protected]

Definition at line 88 of file vtkImageCursor3D.h.

---

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

• imaging/vtkImageCursor3D.h

---