VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkLineRepresentation Class Reference

a class defining the representation for a vtkLineWidget2 More...

#include <vtkLineRepresentation.h>

Inheritance diagram for vtkLineRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkLineRepresentation:
Collaboration graph
[legend]

List of all members.

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)
double GetDistance ()
void SetLineColor (double r, double g, double b)
virtual vtkPropertyGetDistanceAnnotationProperty ()
void GetPoint1WorldPosition (double pos[3])
doubleGetPoint1WorldPosition ()
void GetPoint1DisplayPosition (double pos[3])
doubleGetPoint1DisplayPosition ()
void SetPoint1WorldPosition (double pos[3])
void SetPoint1DisplayPosition (double pos[3])
void GetPoint2DisplayPosition (double pos[3])
doubleGetPoint2DisplayPosition ()
void GetPoint2WorldPosition (double pos[3])
doubleGetPoint2WorldPosition ()
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 vtkPropertyGetEndPoint2Property ()
virtual vtkPropertyGetSelectedEndPoint2Property ()
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 doubleGetBounds ()
virtual void GetActors (vtkPropCollection *pc)
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 ()
virtual void SetDistanceAnnotationVisibility (int)
virtual int GetDistanceAnnotationVisibility ()
virtual void DistanceAnnotationVisibilityOn ()
virtual void DistanceAnnotationVisibilityOff ()
virtual void SetDistanceAnnotationFormat (const char *)
virtual char * GetDistanceAnnotationFormat ()
void SetDistanceAnnotationScale (double x, double y, double z)
virtual void SetDistanceAnnotationScale (double scale[3])
virtual doubleGetDistanceAnnotationScale ()
virtual vtkFollowerGetTextActor ()

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
vtkPropertyEndPoint2Property
vtkPropertySelectedEndPoint2Property
vtkPropertyLineProperty
vtkPropertySelectedLineProperty
int Tolerance
int ClampToBounds
double StartP1 [3]
double StartP2 [3]
double StartLineHandle [3]
double Length
double LastEventPosition [3]
vtkBoxBoundingBox
int InitializedDisplayPosition
int DistanceAnnotationVisibility
char * DistanceAnnotationFormat
vtkFollowerTextActor
vtkPolyDataMapperTextMapper
vtkVectorTextTextInput
double Distance
bool AnnotationTextScaleInitialized
vtkCellPickerLinePicker
typedef vtkWidgetRepresentation Superclass
static int IsTypeOf (const char *type)
static vtkLineRepresentationSafeDownCast (vtkObjectBase *o)
virtual int IsA (const char *type)
vtkLineRepresentationNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBaseNewInstanceInternal () const

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 initially 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 60 of file vtkLineRepresentation.h.


Member Typedef Documentation

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Definition at line 68 of file vtkLineRepresentation.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
Outside 
OnP1 
OnP2 
TranslatingP1 
TranslatingP2 
OnLine 
Scaling 

Definition at line 175 of file vtkLineRepresentation.h.


Constructor & Destructor Documentation


Member Function Documentation

Instantiate the class.

Reimplemented from vtkObject.

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.

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

virtual vtkObjectBase* vtkLineRepresentation::NewInstanceInternal ( ) const [protected, virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

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

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

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

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

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

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

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

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

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

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

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

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.)

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.)

Get the three handle representations used for the vtkLineWidget2.

Get the three handle representations used for the vtkLineWidget2.

Get the three handle representations used for the vtkLineWidget2.

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

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

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

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

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

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.

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.

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.

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.

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::GetActors ( vtkPropCollection pc) [virtual]

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

Methods supporting the rendering process.

Reimplemented from vtkProp.

Methods supporting the rendering process.

Reimplemented from vtkProp.

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.

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.

Show the distance between the points.

Show the distance between the points.

Show the distance between the points.

Show the distance between the points.

virtual void vtkLineRepresentation::SetDistanceAnnotationFormat ( const char *  ) [virtual]

Specify the format to use for labelling the line. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

Specify the format to use for labelling the line. Note that an empty string results in no label, or a format string without a "%" character will not print the angle value.

Scale text (font size along each dimension).

Definition at line 220 of file vtkLineRepresentation.h.

virtual void vtkLineRepresentation::SetDistanceAnnotationScale ( double  scale[3]) [virtual]

Scale text (font size along each dimension).

Scale text (font size along each dimension).

Get the distance between the points.

Convenience method to set the line color. Ideally one should use GetLineProperty()->SetColor().

Get the distance annotation property

Get the text actor

void vtkLineRepresentation::ClampPosition ( double  x[3]) [protected]
void vtkLineRepresentation::HighlightPoint ( int  ptId,
int  highlight 
) [protected]
void vtkLineRepresentation::HighlightLine ( int  highlight) [protected]
void vtkLineRepresentation::SizeHandles ( ) [protected]

Member Data Documentation

Definition at line 253 of file vtkLineRepresentation.h.

Definition at line 254 of file vtkLineRepresentation.h.

Definition at line 255 of file vtkLineRepresentation.h.

Definition at line 256 of file vtkLineRepresentation.h.

Definition at line 259 of file vtkLineRepresentation.h.

Definition at line 262 of file vtkLineRepresentation.h.

Definition at line 263 of file vtkLineRepresentation.h.

Definition at line 264 of file vtkLineRepresentation.h.

Definition at line 267 of file vtkLineRepresentation.h.

Definition at line 268 of file vtkLineRepresentation.h.

Definition at line 269 of file vtkLineRepresentation.h.

Definition at line 273 of file vtkLineRepresentation.h.

Definition at line 274 of file vtkLineRepresentation.h.

Definition at line 275 of file vtkLineRepresentation.h.

Definition at line 276 of file vtkLineRepresentation.h.

Definition at line 277 of file vtkLineRepresentation.h.

Definition at line 278 of file vtkLineRepresentation.h.

Definition at line 282 of file vtkLineRepresentation.h.

Definition at line 285 of file vtkLineRepresentation.h.

Definition at line 293 of file vtkLineRepresentation.h.

Definition at line 294 of file vtkLineRepresentation.h.

Definition at line 295 of file vtkLineRepresentation.h.

Definition at line 296 of file vtkLineRepresentation.h.

Definition at line 297 of file vtkLineRepresentation.h.

Definition at line 300 of file vtkLineRepresentation.h.

Definition at line 306 of file vtkLineRepresentation.h.

Definition at line 309 of file vtkLineRepresentation.h.

Definition at line 310 of file vtkLineRepresentation.h.

Definition at line 312 of file vtkLineRepresentation.h.

Definition at line 313 of file vtkLineRepresentation.h.

Definition at line 314 of file vtkLineRepresentation.h.

Definition at line 315 of file vtkLineRepresentation.h.

Definition at line 316 of file vtkLineRepresentation.h.

Definition at line 318 of file vtkLineRepresentation.h.


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