Documentation for vtkCursor3D

vtkCursor3D - generate a 3D cursor representation

Super Class: vtkPolyDataSource

Description:

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.

 

Methods:

void vtkCursor3D ()
void vtkCursor3D ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkCursor3D *New ()
void SetModelBounds (float ,float ,float ,float ,float ,float )
void SetModelBounds (float *)
float *GetModelBounds ()
void SetFocalPoint (float ,float ,float )
void SetFocalPoint (float *)
float *GetFocalPoint ()
void SetOutline (int )
int GetOutline ()
void OutlineOn ()
void OutlineOff ()
void SetAxes (int )
int GetAxes ()
void AxesOn ()
void AxesOff ()
void SetXShadows (int )
int GetXShadows ()
void XShadowsOn ()
void XShadowsOff ()
void SetYShadows (int )
int GetYShadows ()
void YShadowsOn ()
void YShadowsOff ()
void SetZShadows (int )
int GetZShadows ()
void ZShadowsOn ()
void ZShadowsOff ()
void SetWrap (int )
int GetWrap ()
void WrapOn ()
void WrapOff ()
vtkPolyData *GetFocus ()
void AllOn ()
void AllOff ()
void Execute ()

 

Detailed Method Descriptions:

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

static vtkCursor3D *New ()

Set / get the boundary of the 3D cursor.

void SetModelBounds (float ,float ,float ,float ,float ,float )
void SetModelBounds (float *)
float *GetModelBounds ()

Specify the position of cursor focus.

void SetFocalPoint (float ,float ,float )
void SetFocalPoint (float *)
float *GetFocalPoint ()

Turn on/off the wireframe bounding box.

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

Turn on/off the wireframe axes.

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

Turn on/off the wireframe x-shadows.

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

Turn on/off the wireframe y-shadows.

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

Turn on/off the wireframe z-shadows.

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

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 SetWrap (int )
int GetWrap ()
void WrapOn ()
void WrapOff ()

Get the focus for this filter.

vtkPolyData *GetFocus ()

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

void AllOn ()
void AllOff ()