vtkConstrainedPointHandleRepresentation Class Reference

#include <vtkConstrainedPointHandleRepresentation.h>

Inheritance diagram for vtkConstrainedPointHandleRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkConstrainedPointHandleRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

point representation constrained to a 2D plane

This class is used to represent a vtkHandleWidget. It represents a position in 3D world coordinates that is constrained to a specified plane. The default look is to draw a white point when this widget is not selected or active, a thin green circle when it is highlighted, and a thicker cyan circle when it is active (being positioned). Defaults can be adjusted - but take care to define cursor geometry that makes sense for this widget. The geometry will be aligned on the constraining plane, with the plane normal aligned with the X axis of the geometry (similar behavior to vtkGlyph3D).

TODO: still need to work on 1) translation when mouse is outside bounding planes 2) size of the widget

See also:
vtkHandleRepresentation vtkHandleWidget
Tests:
vtkConstrainedPointHandleRepresentation (Tests)

Definition at line 56 of file vtkConstrainedPointHandleRepresentation.h.

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

Public Types

enum  { XAxis = 0, YAxis, ZAxis, Oblique }

Public Member Functions

void SetProjectionNormalToXAxis ()
void SetProjectionNormalToYAxis ()
void SetProjectionNormalToZAxis ()
void SetProjectionNormalToOblique ()
virtual int CheckConstraint (vtkRenderer *renderer, double pos[2])
virtual void SetDisplayPosition (double pos[3])
void SetCursorShape (vtkPolyData *cursorShape)
vtkPolyDataGetCursorShape ()
void SetActiveCursorShape (vtkPolyData *activeShape)
vtkPolyDataGetActiveCursorShape ()
virtual void SetProjectionNormal (int)
virtual int GetProjectionNormal ()
void SetObliquePlane (vtkPlane *)
virtual vtkPlaneGetObliquePlane ()
void SetProjectionPosition (double position)
virtual double GetProjectionPosition ()
void AddBoundingPlane (vtkPlane *plane)
void RemoveBoundingPlane (vtkPlane *plane)
void RemoveAllBoundingPlanes ()
virtual void SetBoundingPlanes (vtkPlaneCollection *)
virtual vtkPlaneCollectionGetBoundingPlanes ()
void SetBoundingPlanes (vtkPlanes *planes)
void SetPosition (double x, double y, double z)
void SetPosition (double xyz[3])
double * GetPosition ()
void GetPosition (double xyz[3])
virtual vtkPropertyGetProperty ()
virtual vtkPropertyGetSelectedProperty ()
virtual vtkPropertyGetActiveProperty ()
virtual void SetRenderer (vtkRenderer *ren)
virtual void BuildRepresentation ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double eventPos[2])
virtual int ComputeInteractionState (int X, int Y, int modify)
virtual void GetActors (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOverlay (vtkViewport *viewport)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *viewport)
virtual int HasTranslucentPolygonalGeometry ()
virtual void ShallowCopy (vtkProp *prop)

Static Public Member Functions

static
vtkConstrainedPointHandleRepresentation
New ()

Protected Member Functions

 vtkConstrainedPointHandleRepresentation ()
 ~vtkConstrainedPointHandleRepresentation ()
void Translate (double eventPos[2])
void Scale (double eventPos[2])
void Highlight (int highlight)
void CreateDefaultProperties ()
int GetIntersectionPosition (double eventPos[2], double worldPos[3], double tolerance=0.0, vtkRenderer *renderer=0)
void GetProjectionNormal (double normal[3])
void GetProjectionOrigin (double origin[3])

Protected Attributes

vtkActorActor
vtkPolyDataMapperMapper
vtkGlyph3DGlypher
vtkPolyDataCursorShape
vtkPolyDataActiveCursorShape
vtkPolyDataFocalData
vtkPointsFocalPoint
double LastPickPosition [3]
double LastEventPosition [2]
vtkPropertyProperty
vtkPropertySelectedProperty
vtkPropertyActiveProperty
int ProjectionNormal
double ProjectionPosition
int ProjectToPlane
vtkPlaneObliquePlane
vtkPlaneCollectionBoundingPlanes
double InteractionOffset [2]

Member Typedef Documentation

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

Definition at line 64 of file vtkConstrainedPointHandleRepresentation.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
XAxis 
YAxis 
ZAxis 
Oblique 

Definition at line 194 of file vtkConstrainedPointHandleRepresentation.h.


Constructor & Destructor Documentation

vtkConstrainedPointHandleRepresentation::vtkConstrainedPointHandleRepresentation (  )  [protected]

vtkConstrainedPointHandleRepresentation::~vtkConstrainedPointHandleRepresentation (  )  [protected]


Member Function Documentation

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

Instantiate this class.

Reimplemented from vtkObject.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

void vtkConstrainedPointHandleRepresentation::SetCursorShape ( vtkPolyData cursorShape  ) 

Specify the cursor shape. Keep in mind that the shape will be aligned with the constraining plane by orienting it such that the x axis of the geometry lies along the normal of the plane.

vtkPolyData* vtkConstrainedPointHandleRepresentation::GetCursorShape (  ) 

Specify the cursor shape. Keep in mind that the shape will be aligned with the constraining plane by orienting it such that the x axis of the geometry lies along the normal of the plane.

void vtkConstrainedPointHandleRepresentation::SetActiveCursorShape ( vtkPolyData activeShape  ) 

Specify the shape of the cursor (handle) when it is active. This is the geometry that will be used when the mouse is close to the handle or if the user is manipulating the handle.

vtkPolyData* vtkConstrainedPointHandleRepresentation::GetActiveCursorShape (  ) 

Specify the shape of the cursor (handle) when it is active. This is the geometry that will be used when the mouse is close to the handle or if the user is manipulating the handle.

virtual void vtkConstrainedPointHandleRepresentation::SetProjectionNormal ( int   )  [virtual]

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

virtual int vtkConstrainedPointHandleRepresentation::GetProjectionNormal (  )  [virtual]

Set the projection normal to lie along the x, y, or z axis, or to be oblique. If it is oblique, then the plane is defined in the ObliquePlane ivar.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToXAxis (  )  [inline]

Definition at line 94 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToYAxis (  )  [inline]

Definition at line 96 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToZAxis (  )  [inline]

Definition at line 98 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetProjectionNormalToOblique (  )  [inline]

Definition at line 100 of file vtkConstrainedPointHandleRepresentation.h.

void vtkConstrainedPointHandleRepresentation::SetObliquePlane ( vtkPlane  ) 

If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position

virtual vtkPlane* vtkConstrainedPointHandleRepresentation::GetObliquePlane (  )  [virtual]

If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position

void vtkConstrainedPointHandleRepresentation::SetProjectionPosition ( double  position  ) 

The position of the bounding plane from the origin along the normal. The origin and normal are defined in the oblique plane when the ProjectionNormal is Oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

virtual double vtkConstrainedPointHandleRepresentation::GetProjectionPosition (  )  [virtual]

The position of the bounding plane from the origin along the normal. The origin and normal are defined in the oblique plane when the ProjectionNormal is Oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

void vtkConstrainedPointHandleRepresentation::AddBoundingPlane ( vtkPlane plane  ) 

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these contraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void vtkConstrainedPointHandleRepresentation::RemoveBoundingPlane ( vtkPlane plane  ) 

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these contraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void vtkConstrainedPointHandleRepresentation::RemoveAllBoundingPlanes (  ) 

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these contraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

virtual void vtkConstrainedPointHandleRepresentation::SetBoundingPlanes ( vtkPlaneCollection  )  [virtual]

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these contraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

virtual vtkPlaneCollection* vtkConstrainedPointHandleRepresentation::GetBoundingPlanes (  )  [virtual]

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these contraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

void vtkConstrainedPointHandleRepresentation::SetBoundingPlanes ( vtkPlanes planes  ) 

A collection of plane equations used to bound the position of the point. This is in addition to confining the point to a plane - these contraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

virtual int vtkConstrainedPointHandleRepresentation::CheckConstraint ( vtkRenderer renderer,
double  pos[2] 
) [virtual]

Overridden from the base class. It converts the display co-ordinates to world co-ordinates. It returns 1 if the point lies within the constrained region, otherwise return 0

Reimplemented from vtkHandleRepresentation.

void vtkConstrainedPointHandleRepresentation::SetPosition ( double  x,
double  y,
double  z 
)

Set/Get the position of the point in display coordinates. These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

void vtkConstrainedPointHandleRepresentation::SetPosition ( double  xyz[3]  ) 

Set/Get the position of the point in display coordinates. These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

double* vtkConstrainedPointHandleRepresentation::GetPosition (  ) 

Set/Get the position of the point in display coordinates. These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

void vtkConstrainedPointHandleRepresentation::GetPosition ( double  xyz[3]  ) 

Set/Get the position of the point in display coordinates. These are convenience methods that extend the superclasses' GetHandlePosition() method. Note that only the x-y coordinate values are used

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

This is the property used when the handle is not active (the mouse is not near the handle)

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

This is the property used when the mouse is near the handle (but the user is not yet interacting with it)

virtual vtkProperty* vtkConstrainedPointHandleRepresentation::GetActiveProperty (  )  [virtual]

This is the property used when the user is interacting with the handle.

virtual void vtkConstrainedPointHandleRepresentation::SetRenderer ( vtkRenderer ren  )  [virtual]

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkHandleRepresentation.

virtual void vtkConstrainedPointHandleRepresentation::BuildRepresentation (  )  [virtual]

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Implements vtkWidgetRepresentation.

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

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

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

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkConstrainedPointHandleRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify 
) [virtual]

Subclasses of vtkConstrainedPointHandleRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkConstrainedPointHandleRepresentation::SetDisplayPosition ( double  pos[3]  )  [virtual]

Method overridden from Superclass. computes the world co-ordinates using GetIntersectionPosition()

Reimplemented from vtkHandleRepresentation.

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

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

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

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkConstrainedPointHandleRepresentation::RenderOverlay ( vtkViewport viewport  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

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

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

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

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

virtual int vtkConstrainedPointHandleRepresentation::HasTranslucentPolygonalGeometry (  )  [virtual]

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

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

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

void vtkConstrainedPointHandleRepresentation::Translate ( double  eventPos[2]  )  [protected]

void vtkConstrainedPointHandleRepresentation::Scale ( double  eventPos[2]  )  [protected]

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

void vtkConstrainedPointHandleRepresentation::CreateDefaultProperties (  )  [protected]

int vtkConstrainedPointHandleRepresentation::GetIntersectionPosition ( double  eventPos[2],
double  worldPos[3],
double  tolerance = 0.0,
vtkRenderer renderer = 0 
) [protected]

void vtkConstrainedPointHandleRepresentation::GetProjectionNormal ( double  normal[3]  )  [protected]

void vtkConstrainedPointHandleRepresentation::GetProjectionOrigin ( double  origin[3]  )  [protected]


Member Data Documentation

Definition at line 202 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 203 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 204 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 205 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 206 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 207 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 208 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 211 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 212 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 221 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 222 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 223 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 227 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 228 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 229 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 230 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 232 of file vtkConstrainedPointHandleRepresentation.h.

Definition at line 251 of file vtkConstrainedPointHandleRepresentation.h.


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

Generated on Wed Jun 3 18:58:02 2009 for VTK by  doxygen 1.5.6