vtkLineRepresentation Class Reference

#include <vtkLineRepresentation.h>

Inheritance diagram for vtkLineRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkLineRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

a class defining the representation for a vtkLineWidget2

This class is a concrete representation for the vtkLineWidget2. It represents a straight line with three handles: one at the beginning and ending of the line, and one used to translate the line. Through interaction with the widget, the line representation can be arbitrarily placed in the 3D space.

To use this representation, you normally specify the position of the two end points (either in world or display coordinates). The PlaceWidget() method is also used to intially position the representation.

Warning:
This class, and vtkLineWidget2, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkLineWidget.
See also:
vtkLineWidget2 vtkLineWidget
Tests:
vtkLineRepresentation (Tests)

Definition at line 56 of file vtkLineRepresentation.h.

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

Public Types

enum  {
  Outside = 0, OnP1, OnP2, TranslatingP1,
  TranslatingP2, OnLine, Scaling
}

Public Member Functions

void GetPolyData (vtkPolyData *pd)
virtual unsigned long GetMTime ()
virtual void SetRenderer (vtkRenderer *ren)
void GetPoint1WorldPosition (double pos[3])
double * GetPoint1WorldPosition ()
void GetPoint1DisplayPosition (double pos[3])
double * GetPoint1DisplayPosition ()
void SetPoint1WorldPosition (double pos[3])
void SetPoint1DisplayPosition (double pos[3])
void GetPoint2DisplayPosition (double pos[3])
double * GetPoint2DisplayPosition ()
void GetPoint2WorldPosition (double pos[3])
double * GetPoint2WorldPosition ()
void SetPoint2WorldPosition (double pos[3])
void SetPoint2DisplayPosition (double pos[3])
void SetHandleRepresentation (vtkPointHandleRepresentation3D *handle)
void InstantiateHandleRepresentation ()
virtual
vtkPointHandleRepresentation3D
GetPoint1Representation ()
virtual
vtkPointHandleRepresentation3D
GetPoint2Representation ()
virtual
vtkPointHandleRepresentation3D
GetLineHandleRepresentation ()
virtual vtkPropertyGetEndPointProperty ()
virtual vtkPropertyGetSelectedEndPointProperty ()
virtual vtkPropertyGetLineProperty ()
virtual vtkPropertyGetSelectedLineProperty ()
virtual void SetTolerance (int)
virtual int GetTolerance ()
void SetResolution (int res)
int GetResolution ()
virtual void PlaceWidget (double bounds[6])
virtual void BuildRepresentation ()
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void StartWidgetInteraction (double e[2])
virtual void WidgetInteraction (double e[2])
virtual double * GetBounds ()
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int HasTranslucentPolygonalGeometry ()
virtual void SetInteractionState (int)
virtual void SetRepresentationState (int)
virtual int GetRepresentationState ()

Static Public Member Functions

static vtkLineRepresentationNew ()

Protected Member Functions

 vtkLineRepresentation ()
 ~vtkLineRepresentation ()
void CreateDefaultProperties ()
void ClampPosition (double x[3])
void HighlightPoint (int ptId, int highlight)
void HighlightLine (int highlight)
int InBounds (double x[3])
void SizeHandles ()

Protected Attributes

vtkPointHandleRepresentation3DHandleRepresentation
vtkPointHandleRepresentation3DPoint1Representation
vtkPointHandleRepresentation3DPoint2Representation
vtkPointHandleRepresentation3DLineHandleRepresentation
int RepresentationState
vtkActorLineActor
vtkPolyDataMapperLineMapper
vtkLineSourceLineSource
vtkActor ** Handle
vtkPolyDataMapper ** HandleMapper
vtkSphereSource ** HandleGeometry
vtkPropertyEndPointProperty
vtkPropertySelectedEndPointProperty
vtkPropertyLineProperty
vtkPropertySelectedLineProperty
int Tolerance
int ClampToBounds
double StartP1 [3]
double StartP2 [3]
double StartLineHandle [3]
double Length
double LastEventPosition [3]
vtkBoxBoundingBox
int InitializedDisplayPosition

Member Typedef Documentation

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Definition at line 64 of file vtkLineRepresentation.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
Outside 
OnP1 
OnP2 
TranslatingP1 
TranslatingP2 
OnLine 
Scaling 

Definition at line 163 of file vtkLineRepresentation.h.


Constructor & Destructor Documentation

vtkLineRepresentation::vtkLineRepresentation (  )  [protected]

vtkLineRepresentation::~vtkLineRepresentation (  )  [protected]


Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

void vtkLineRepresentation::GetPoint1WorldPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

double* vtkLineRepresentation::GetPoint1WorldPosition (  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::GetPoint1DisplayPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

double* vtkLineRepresentation::GetPoint1DisplayPosition (  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::SetPoint1WorldPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::SetPoint1DisplayPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::GetPoint2DisplayPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

double* vtkLineRepresentation::GetPoint2DisplayPosition (  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::GetPoint2WorldPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

double* vtkLineRepresentation::GetPoint2WorldPosition (  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::SetPoint2WorldPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::SetPoint2DisplayPosition ( double  pos[3]  ) 

Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.

void vtkLineRepresentation::SetHandleRepresentation ( vtkPointHandleRepresentation3D handle  ) 

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkLineWidget2. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkLineRepresentation uses this dummy to clone three vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkLineWidget2.)

void vtkLineRepresentation::InstantiateHandleRepresentation (  ) 

This method is used to specify the type of handle representation to use for the three internal vtkHandleWidgets within vtkLineWidget2. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkLineRepresentation uses this dummy to clone three vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkLineWidget2.)

virtual vtkPointHandleRepresentation3D* vtkLineRepresentation::GetPoint1Representation (  )  [virtual]

Get the three handle representations used for the vtkLineWidget2.

virtual vtkPointHandleRepresentation3D* vtkLineRepresentation::GetPoint2Representation (  )  [virtual]

Get the three handle representations used for the vtkLineWidget2.

virtual vtkPointHandleRepresentation3D* vtkLineRepresentation::GetLineHandleRepresentation (  )  [virtual]

Get the three handle representations used for the vtkLineWidget2.

virtual vtkProperty* vtkLineRepresentation::GetEndPointProperty (  )  [virtual]

Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated.

virtual vtkProperty* vtkLineRepresentation::GetSelectedEndPointProperty (  )  [virtual]

Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated.

virtual vtkProperty* vtkLineRepresentation::GetLineProperty (  )  [virtual]

Get the line properties. The properties of the line when selected and unselected can be manipulated.

virtual vtkProperty* vtkLineRepresentation::GetSelectedLineProperty (  )  [virtual]

Get the line properties. The properties of the line when selected and unselected can be manipulated.

virtual void vtkLineRepresentation::SetTolerance ( int   )  [virtual]

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active.

virtual int vtkLineRepresentation::GetTolerance (  )  [virtual]

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the line or end point to be active.

void vtkLineRepresentation::SetResolution ( int  res  ) 

Set/Get the resolution (number of subdivisions) of the line. A line with resolution greater than one is useful when points along the line are desired; e.g., generating a rake of streamlines.

int vtkLineRepresentation::GetResolution (  ) 

Set/Get the resolution (number of subdivisions) of the line. A line with resolution greater than one is useful when points along the line are desired; e.g., generating a rake of streamlines.

void vtkLineRepresentation::GetPolyData ( vtkPolyData pd  ) 

Retrieve the polydata (including points) that defines the line. The polydata consists of n+1 points, where n is the resolution of the line. These point values are guaranteed to be up-to-date whenever any one of the three handles are moved. To use this method, the user provides the vtkPolyData as an input argument, and the points and polyline are copied into it.

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

These are methods that satisfy vtkWidgetRepresentation's API.

virtual void vtkLineRepresentation::BuildRepresentation (  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

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

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkLineRepresentation::StartWidgetInteraction ( double  e[2]  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkLineRepresentation::WidgetInteraction ( double  e[2]  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

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

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

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

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkLineRepresentation::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

Methods supporting the rendering process.

Reimplemented from vtkProp.

virtual int vtkLineRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [virtual]

Methods supporting the rendering process.

Reimplemented from vtkProp.

virtual int vtkLineRepresentation::HasTranslucentPolygonalGeometry (  )  [virtual]

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkLineRepresentation::SetInteractionState ( int   )  [virtual]

The interaction state may be set from a widget (e.g., vtkLineWidget2) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further.

virtual void vtkLineRepresentation::SetRepresentationState ( int   )  [virtual]

Sets the visual appearance of the representation based on the state it is in. This state is usually the same as InteractionState.

virtual int vtkLineRepresentation::GetRepresentationState (  )  [virtual]

Sets the visual appearance of the representation based on the state it is in. This state is usually the same as InteractionState.

virtual unsigned long vtkLineRepresentation::GetMTime (  )  [virtual]

Overload the superclasses' GetMTime() because internal classes are used to keep the state of the representation.

Reimplemented from vtkObject.

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

Overridden to set the rendererer on the internal representations.

Reimplemented from vtkWidgetRepresentation.

void vtkLineRepresentation::CreateDefaultProperties (  )  [protected]

void vtkLineRepresentation::ClampPosition ( double  x[3]  )  [protected]

void vtkLineRepresentation::HighlightPoint ( int  ptId,
int  highlight 
) [protected]

void vtkLineRepresentation::HighlightLine ( int  highlight  )  [protected]

int vtkLineRepresentation::InBounds ( double  x[3]  )  [protected]

void vtkLineRepresentation::SizeHandles (  )  [protected]


Member Data Documentation

Definition at line 196 of file vtkLineRepresentation.h.

Definition at line 197 of file vtkLineRepresentation.h.

Definition at line 198 of file vtkLineRepresentation.h.

Definition at line 199 of file vtkLineRepresentation.h.

Definition at line 202 of file vtkLineRepresentation.h.

Definition at line 205 of file vtkLineRepresentation.h.

Definition at line 206 of file vtkLineRepresentation.h.

Definition at line 207 of file vtkLineRepresentation.h.

Definition at line 210 of file vtkLineRepresentation.h.

Definition at line 211 of file vtkLineRepresentation.h.

Definition at line 212 of file vtkLineRepresentation.h.

Definition at line 216 of file vtkLineRepresentation.h.

Definition at line 217 of file vtkLineRepresentation.h.

Definition at line 218 of file vtkLineRepresentation.h.

Definition at line 219 of file vtkLineRepresentation.h.

Definition at line 223 of file vtkLineRepresentation.h.

Definition at line 226 of file vtkLineRepresentation.h.

double vtkLineRepresentation::StartP1[3] [protected]

Definition at line 234 of file vtkLineRepresentation.h.

double vtkLineRepresentation::StartP2[3] [protected]

Definition at line 235 of file vtkLineRepresentation.h.

Definition at line 236 of file vtkLineRepresentation.h.

double vtkLineRepresentation::Length [protected]

Definition at line 237 of file vtkLineRepresentation.h.

Definition at line 238 of file vtkLineRepresentation.h.

Definition at line 241 of file vtkLineRepresentation.h.

Definition at line 247 of file vtkLineRepresentation.h.


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

Generated on Sat Dec 27 13:35:07 2008 for VTK by  doxygen 1.5.6