vtkPointHandleRepresentation3D Class Reference

#include <vtkPointHandleRepresentation3D.h>

Inheritance diagram for vtkPointHandleRepresentation3D:

Inheritance graph
[legend]
Collaboration diagram for vtkPointHandleRepresentation3D:

Collaboration graph
[legend]

List of all members.


Detailed Description

represent the position of a point in 3D space

This class is used to represent a vtkHandleWidget. It represents a position in 3D world coordinates using a x-y-z cursor. The cursor can be configured to show a bounding box and/or shadows.

See also:
vtkHandleRepresentation vtkHandleWidget vtkCursor3D
Tests:
vtkPointHandleRepresentation3D (Tests)

Definition at line 41 of file vtkPointHandleRepresentation3D.h.

typedef vtkHandleRepresentation Superclass
static int IsTypeOf (const char *type)
static
vtkPointHandleRepresentation3D
SafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions

virtual void SetHandleSize (double size)
virtual void SetWorldPosition (double p[3])
virtual void SetDisplayPosition (double p[3])
void SetOutline (int o)
int GetOutline ()
void OutlineOn ()
void OutlineOff ()
void SetXShadows (int o)
int GetXShadows ()
void XShadowsOn ()
void XShadowsOff ()
void SetYShadows (int o)
int GetYShadows ()
void YShadowsOn ()
void YShadowsOff ()
void SetZShadows (int o)
int GetZShadows ()
void ZShadowsOn ()
void ZShadowsOff ()
virtual void SetTranslationMode (int)
virtual int GetTranslationMode ()
virtual void TranslationModeOn ()
virtual void TranslationModeOff ()
void AllOn ()
void AllOff ()
void SetProperty (vtkProperty *)
void SetSelectedProperty (vtkProperty *)
virtual vtkPropertyGetProperty ()
virtual vtkPropertyGetSelectedProperty ()
virtual void SetHotSpotSize (double)
virtual double GetHotSpotSize ()
virtual double * GetBounds ()
virtual void BuildRepresentation ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double eventPos[2])
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void PlaceWidget (double bounds[6])
virtual void ShallowCopy (vtkProp *prop)
virtual void GetActors (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
virtual int HasTranslucentPolygonalGeometry ()

Static Public Member Functions

static
vtkPointHandleRepresentation3D
New ()

Protected Member Functions

 vtkPointHandleRepresentation3D ()
 ~vtkPointHandleRepresentation3D ()
void Highlight (int highlight)
void Translate (double *p1, double *p2)
void Scale (double *p1, double *p2, double eventPos[2])
void MoveFocus (double *p1, double *p2)
void SizeBounds ()
void MoveFocusRequest (double *p1, double *p2, double requestedDisplayPos[3])
void CreateDefaultProperties ()
int DetermineConstraintAxis (int constraint, double *x, double *startPoint)

Protected Attributes

vtkActorActor
vtkPolyDataMapperMapper
vtkCursor3DCursor3D
vtkCellPickerCursorPicker
double LastPickPosition [3]
double LastEventPosition [2]
int ConstraintAxis
vtkPropertyProperty
vtkPropertySelectedProperty
double HotSpotSize
int WaitingForMotion
int WaitCount
double CurrentHandleSize
int TranslationMode

Member Typedef Documentation

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Definition at line 49 of file vtkPointHandleRepresentation3D.h.


Constructor & Destructor Documentation

vtkPointHandleRepresentation3D::vtkPointHandleRepresentation3D (  )  [protected]

vtkPointHandleRepresentation3D::~vtkPointHandleRepresentation3D (  )  [protected]


Member Function Documentation

static vtkPointHandleRepresentation3D* vtkPointHandleRepresentation3D::New (  )  [static]

Instantiate this class.

Reimplemented from vtkObject.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

static int vtkPointHandleRepresentation3D::IsTypeOf ( const char *  type  )  [static]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

virtual int vtkPointHandleRepresentation3D::IsA ( const char *  type  )  [virtual]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

void vtkPointHandleRepresentation3D::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

virtual void vtkPointHandleRepresentation3D::SetWorldPosition ( double  p[3]  )  [virtual]

Set the position of the point in world and display coordinates. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box. This method overloads the superclasses' SetWorldPosition() and SetDisplayPosition() in order to set the focal point of the cursor properly.

Reimplemented from vtkHandleRepresentation.

virtual void vtkPointHandleRepresentation3D::SetDisplayPosition ( double  p[3]  )  [virtual]

Set the position of the point in world and display coordinates. Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box. This method overloads the superclasses' SetWorldPosition() and SetDisplayPosition() in order to set the focal point of the cursor properly.

Reimplemented from vtkHandleRepresentation.

void vtkPointHandleRepresentation3D::SetOutline ( int  o  )  [inline]

Turn on/off the wireframe bounding box.

Definition at line 65 of file vtkPointHandleRepresentation3D.h.

int vtkPointHandleRepresentation3D::GetOutline (  )  [inline]

Turn on/off the wireframe bounding box.

Definition at line 67 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::OutlineOn (  )  [inline]

Turn on/off the wireframe bounding box.

Definition at line 69 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::OutlineOff (  )  [inline]

Turn on/off the wireframe bounding box.

Definition at line 71 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::SetXShadows ( int  o  )  [inline]

Turn on/off the wireframe x-shadows.

Definition at line 77 of file vtkPointHandleRepresentation3D.h.

int vtkPointHandleRepresentation3D::GetXShadows (  )  [inline]

Turn on/off the wireframe x-shadows.

Definition at line 79 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::XShadowsOn (  )  [inline]

Turn on/off the wireframe x-shadows.

Definition at line 81 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::XShadowsOff (  )  [inline]

Turn on/off the wireframe x-shadows.

Definition at line 83 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::SetYShadows ( int  o  )  [inline]

Turn on/off the wireframe y-shadows.

Definition at line 89 of file vtkPointHandleRepresentation3D.h.

int vtkPointHandleRepresentation3D::GetYShadows (  )  [inline]

Turn on/off the wireframe y-shadows.

Definition at line 91 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::YShadowsOn (  )  [inline]

Turn on/off the wireframe y-shadows.

Definition at line 93 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::YShadowsOff (  )  [inline]

Turn on/off the wireframe y-shadows.

Definition at line 95 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::SetZShadows ( int  o  )  [inline]

Turn on/off the wireframe z-shadows.

Definition at line 101 of file vtkPointHandleRepresentation3D.h.

int vtkPointHandleRepresentation3D::GetZShadows (  )  [inline]

Turn on/off the wireframe z-shadows.

Definition at line 103 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::ZShadowsOn (  )  [inline]

Turn on/off the wireframe z-shadows.

Definition at line 105 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::ZShadowsOff (  )  [inline]

Turn on/off the wireframe z-shadows.

Definition at line 107 of file vtkPointHandleRepresentation3D.h.

virtual void vtkPointHandleRepresentation3D::SetTranslationMode ( int   )  [virtual]

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated and sized simultaneously as the point moves (i.e., the left and middle mouse buttons act the same). If translation mode is off, the cursor does not scale itself (based on the specified handle size), and the bounding box and shadows do not move or size themselves as the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button, and the bounds can be manually set with the SetBounds() method.)

virtual int vtkPointHandleRepresentation3D::GetTranslationMode (  )  [virtual]

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated and sized simultaneously as the point moves (i.e., the left and middle mouse buttons act the same). If translation mode is off, the cursor does not scale itself (based on the specified handle size), and the bounding box and shadows do not move or size themselves as the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button, and the bounds can be manually set with the SetBounds() method.)

virtual void vtkPointHandleRepresentation3D::TranslationModeOn (  )  [virtual]

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated and sized simultaneously as the point moves (i.e., the left and middle mouse buttons act the same). If translation mode is off, the cursor does not scale itself (based on the specified handle size), and the bounding box and shadows do not move or size themselves as the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button, and the bounds can be manually set with the SetBounds() method.)

virtual void vtkPointHandleRepresentation3D::TranslationModeOff (  )  [virtual]

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated and sized simultaneously as the point moves (i.e., the left and middle mouse buttons act the same). If translation mode is off, the cursor does not scale itself (based on the specified handle size), and the bounding box and shadows do not move or size themselves as the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button, and the bounds can be manually set with the SetBounds() method.)

void vtkPointHandleRepresentation3D::AllOn (  )  [inline]

Convenience methods to turn outline and shadows on and off.

Definition at line 129 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::AllOff (  )  [inline]

Convenience methods to turn outline and shadows on and off.

Definition at line 136 of file vtkPointHandleRepresentation3D.h.

void vtkPointHandleRepresentation3D::SetProperty ( vtkProperty  ) 

Set/Get the handle properties when unselected and selected.

void vtkPointHandleRepresentation3D::SetSelectedProperty ( vtkProperty  ) 

Set/Get the handle properties when unselected and selected.

virtual vtkProperty* vtkPointHandleRepresentation3D::GetProperty (  )  [virtual]

Set/Get the handle properties when unselected and selected.

virtual vtkProperty* vtkPointHandleRepresentation3D::GetSelectedProperty (  )  [virtual]

Set/Get the handle properties when unselected and selected.

virtual void vtkPointHandleRepresentation3D::SetHotSpotSize ( double   )  [virtual]

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

virtual double vtkPointHandleRepresentation3D::GetHotSpotSize (  )  [virtual]

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action. Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

virtual void vtkPointHandleRepresentation3D::SetHandleSize ( double  size  )  [virtual]

Overload the superclasses SetHandleSize() method to update internal variables.

Reimplemented from vtkWidgetRepresentation.

virtual double* vtkPointHandleRepresentation3D::GetBounds (  )  [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkPointHandleRepresentation3D::BuildRepresentation (  )  [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Implements vtkWidgetRepresentation.

virtual void vtkPointHandleRepresentation3D::StartWidgetInteraction ( double  eventPos[2]  )  [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkPointHandleRepresentation3D::WidgetInteraction ( double  eventPos[2]  )  [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkPointHandleRepresentation3D::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
) [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkPointHandleRepresentation3D::PlaceWidget ( double  bounds[6]  )  [virtual]

Methods to make this class properly act like a vtkWidgetRepresentation.

virtual void vtkPointHandleRepresentation3D::ShallowCopy ( vtkProp prop  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

virtual void vtkPointHandleRepresentation3D::GetActors ( vtkPropCollection  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkPointHandleRepresentation3D::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkPointHandleRepresentation3D::RenderOpaqueGeometry ( vtkViewport viewport  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

virtual int vtkPointHandleRepresentation3D::RenderTranslucentPolygonalGeometry ( vtkViewport viewport  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

virtual int vtkPointHandleRepresentation3D::HasTranslucentPolygonalGeometry (  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

void vtkPointHandleRepresentation3D::Highlight ( int  highlight  )  [protected]

void vtkPointHandleRepresentation3D::Translate ( double *  p1,
double *  p2 
) [protected]

void vtkPointHandleRepresentation3D::Scale ( double *  p1,
double *  p2,
double  eventPos[2] 
) [protected]

void vtkPointHandleRepresentation3D::MoveFocus ( double *  p1,
double *  p2 
) [protected]

void vtkPointHandleRepresentation3D::SizeBounds (  )  [protected]

void vtkPointHandleRepresentation3D::MoveFocusRequest ( double *  p1,
double *  p2,
double  requestedDisplayPos[3] 
) [protected]

void vtkPointHandleRepresentation3D::CreateDefaultProperties (  )  [protected]

int vtkPointHandleRepresentation3D::DetermineConstraintAxis ( int  constraint,
double *  x,
double *  startPoint 
) [protected]


Member Data Documentation

Definition at line 192 of file vtkPointHandleRepresentation3D.h.

Definition at line 193 of file vtkPointHandleRepresentation3D.h.

Definition at line 194 of file vtkPointHandleRepresentation3D.h.

Definition at line 198 of file vtkPointHandleRepresentation3D.h.

Definition at line 199 of file vtkPointHandleRepresentation3D.h.

Definition at line 200 of file vtkPointHandleRepresentation3D.h.

Definition at line 203 of file vtkPointHandleRepresentation3D.h.

Definition at line 220 of file vtkPointHandleRepresentation3D.h.

Definition at line 221 of file vtkPointHandleRepresentation3D.h.

Definition at line 225 of file vtkPointHandleRepresentation3D.h.

Definition at line 227 of file vtkPointHandleRepresentation3D.h.

Definition at line 228 of file vtkPointHandleRepresentation3D.h.

Definition at line 231 of file vtkPointHandleRepresentation3D.h.

Definition at line 234 of file vtkPointHandleRepresentation3D.h.


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

Generated on Sat Dec 27 13:42:54 2008 for VTK by  doxygen 1.5.6