VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCursor3D Class Reference

generate a 3D cursor representation More...

#include <vtkCursor3D.h>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCursor3DNewInstance () 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 vtkCursor3DSafeDownCast (vtkObjectBase *o)
 
static vtkCursor3DNew ()
 

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

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 *  type)
static
virtual int vtkCursor3D::IsA ( const char *  type)
virtual
static vtkCursor3D* vtkCursor3D::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCursor3D::NewInstanceInternal ( ) const
protectedvirtual
vtkCursor3D* vtkCursor3D::NewInstance ( ) const
void vtkCursor3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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 *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

vtkPolyData* vtkCursor3D::Focus
protected

Definition at line 140 of file vtkCursor3D.h.

double vtkCursor3D::ModelBounds[6]
protected

Definition at line 141 of file vtkCursor3D.h.

double vtkCursor3D::FocalPoint[3]
protected

Definition at line 142 of file vtkCursor3D.h.

int vtkCursor3D::Outline
protected

Definition at line 143 of file vtkCursor3D.h.

int vtkCursor3D::Axes
protected

Definition at line 144 of file vtkCursor3D.h.

int vtkCursor3D::XShadows
protected

Definition at line 145 of file vtkCursor3D.h.

int vtkCursor3D::YShadows
protected

Definition at line 146 of file vtkCursor3D.h.

int vtkCursor3D::ZShadows
protected

Definition at line 147 of file vtkCursor3D.h.

int vtkCursor3D::TranslationMode
protected

Definition at line 148 of file vtkCursor3D.h.

int vtkCursor3D::Wrap
protected

Definition at line 149 of file vtkCursor3D.h.


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