Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
303 lines (250 sloc) 10.8 KB
Program: Visualization Toolkit
Module: vtkLineRepresentation.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or for details.
This software is distributed WITHOUT ANY WARRANTY; without even
PURPOSE. See the above copyright notice for more information.
// .NAME vtkLineRepresentation - a class defining the representation for a vtkLineWidget2
// .SECTION Description
// 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.
// .SECTION Caveats
// This class, and vtkLineWidget2, are next generation VTK
// widgets. An earlier version of this functionality was defined in the
// class vtkLineWidget.
// .SECTION See Also
// vtkLineWidget2 vtkLineWidget
#ifndef __vtkLineRepresentation_h
#define __vtkLineRepresentation_h
#include "vtkWidgetRepresentation.h"
class vtkActor;
class vtkPolyDataMapper;
class vtkLineSource;
class vtkSphereSource;
class vtkProperty;
class vtkPolyData;
class vtkPolyDataAlgorithm;
class vtkPointHandleRepresentation3D;
class vtkBox;
class vtkFollower;
class vtkVectorText;
class vtkPolyDataMapper;
class vtkCellPicker;
class VTK_WIDGETS_EXPORT vtkLineRepresentation : public vtkWidgetRepresentation
// Description:
// Instantiate the class.
static vtkLineRepresentation *New();
// Description:
// Standard methods for the class.
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// 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 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]);
// Description:
// 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 SetHandleRepresentation(vtkPointHandleRepresentation3D *handle);
void InstantiateHandleRepresentation();
// Description:
// Get the three handle representations used for the vtkLineWidget2.
// Description:
// Get the end-point (sphere) properties. The properties of the end-points
// when selected and unselected can be manipulated.
// Description:
// Get the end-point (sphere) properties. The properties of the end-points
// when selected and unselected can be manipulated.
// Description:
// Get the line properties. The properties of the line when selected
// and unselected can be manipulated.
// Description:
// 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.
// Description:
// 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 SetResolution(int res);
int GetResolution();
// Description:
// 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.
void GetPolyData(vtkPolyData *pd);
// Description:
// These are methods that satisfy vtkWidgetRepresentation's API.
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();
// Description:
// Methods supporting the rendering process.
virtual void GetActors(vtkPropCollection *pc);
virtual void ReleaseGraphicsResources(vtkWindow*);
virtual int RenderOpaqueGeometry(vtkViewport*);
virtual int RenderTranslucentPolygonalGeometry(vtkViewport*);
virtual int HasTranslucentPolygonalGeometry();
//BTX - manage the state of the widget
enum {Outside=0,OnP1,OnP2,TranslatingP1,TranslatingP2,OnLine,Scaling};
// Description:
// 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.
// Description:
// Sets the visual appearance of the representation based on the
// state it is in. This state is usually the same as InteractionState.
virtual void SetRepresentationState(int);
vtkGetMacro(RepresentationState, int);
// Description:
// Overload the superclasses' GetMTime() because internal classes
// are used to keep the state of the representation.
virtual unsigned long GetMTime();
// Description:
// Overridden to set the rendererer on the internal representations.
virtual void SetRenderer(vtkRenderer *ren);
// Description:
// Show the distance between the points
vtkSetMacro( DistanceAnnotationVisibility, int );
vtkGetMacro( DistanceAnnotationVisibility, int );
vtkBooleanMacro( DistanceAnnotationVisibility, int );
// Description:
// Specify the format to use for labelling the angle. Note that an empty
// string results in no label, or a format string without a "%" character
// will not print the angle value.
// Description:
// Scale text (font size along each dimension).
virtual void SetDistanceAnnotationScale( double scale[3] );
virtual double * GetDistanceAnnotationScale();
// Description:
// Get the distance between the points.
double GetDistance();
// Description:
// Convenience method to set the line color.
// Ideally one should use GetLineProperty()->SetColor().
void SetLineColor(double r, double g, double b);
// Description:
// Get the distance annotation property
virtual vtkProperty *GetDistanceAnnotationProperty();
// Description:
// Get the text actor
vtkGetObjectMacro(TextActor, vtkFollower);
// The handle and the rep used to close the handles
vtkPointHandleRepresentation3D *HandleRepresentation;
vtkPointHandleRepresentation3D *Point1Representation;
vtkPointHandleRepresentation3D *Point2Representation;
vtkPointHandleRepresentation3D *LineHandleRepresentation;
// Manage how the representation appears
int RepresentationState;
// the line
vtkActor *LineActor;
vtkPolyDataMapper *LineMapper;
vtkLineSource *LineSource;
// glyphs representing hot spots (e.g., handles)
vtkActor **Handle;
vtkPolyDataMapper **HandleMapper;
vtkSphereSource **HandleGeometry;
// Properties used to control the appearance of selected objects and
// the manipulator in general.
vtkProperty *EndPointProperty;
vtkProperty *SelectedEndPointProperty;
vtkProperty *EndPoint2Property;
vtkProperty *SelectedEndPoint2Property;
vtkProperty *LineProperty;
vtkProperty *SelectedLineProperty;
void CreateDefaultProperties();
// Selection tolerance for the handles and the line
int Tolerance;
// Helper members
int ClampToBounds;
void ClampPosition(double x[3]);
void HighlightPoint(int ptId, int highlight);
void HighlightLine(int highlight);
int InBounds(double x[3]);
void SizeHandles();
// Ivars used during widget interaction to hold initial positions
double StartP1[3];
double StartP2[3];
double StartLineHandle[3];
double Length;
double LastEventPosition[3];
// Support GetBounds() method
vtkBox *BoundingBox;
// Need to keep track if we have successfully initialized the display position.
// The widget tends to do stuff in world coordinates, put if the renderer has
// not been assigned, then certain operations do not properly update the display
// position.
int InitializedDisplayPosition;
// Format for the label
int DistanceAnnotationVisibility;
char *DistanceAnnotationFormat;
vtkFollower *TextActor;
vtkPolyDataMapper *TextMapper;
vtkVectorText *TextInput;
double Distance;
bool AnnotationTextScaleInitialized;
vtkCellPicker *LinePicker;
vtkLineRepresentation(const vtkLineRepresentation&); //Not implemented
void operator=(const vtkLineRepresentation&); //Not implemented