vtkLineRepresentation Class Reference
#include <vtkLineRepresentation.h>
Detailed Description
a class defining the representation for a vtkLineWidget2This 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
Definition at line 59 of file vtkLineRepresentation.h.
Member Typedef Documentation
Standard methods for the class.
Reimplemented from vtkWidgetRepresentation.
Definition at line 67 of file vtkLineRepresentation.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 174 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::GetEndPoint2Property | ( | ) | [virtual] |
Get the end-point (sphere) properties. The properties of the end-points when selected and unselected can be manipulated.
| virtual vtkProperty* vtkLineRepresentation::GetSelectedEndPoint2Property | ( | ) | [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::GetActors | ( | vtkPropCollection * | pc | ) | [virtual] |
Methods supporting the rendering process.
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.
| virtual void vtkLineRepresentation::SetDistanceAnnotationVisibility | ( | int | ) | [virtual] |
Show the distance between the points
| virtual int vtkLineRepresentation::GetDistanceAnnotationVisibility | ( | ) | [virtual] |
Show the distance between the points
| virtual void vtkLineRepresentation::DistanceAnnotationVisibilityOn | ( | ) | [virtual] |
Show the distance between the points
| virtual void vtkLineRepresentation::DistanceAnnotationVisibilityOff | ( | ) | [virtual] |
Show the distance between the points
| virtual void vtkLineRepresentation::SetDistanceAnnotationFormat | ( | const char * | ) | [virtual] |
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.
| virtual char* vtkLineRepresentation::GetDistanceAnnotationFormat | ( | ) | [virtual] |
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.
| virtual void vtkLineRepresentation::SetDistanceAnnotationScale | ( | double | scale[3] | ) | [virtual] |
Scale text (font size along each dimension).
| virtual double* vtkLineRepresentation::GetDistanceAnnotationScale | ( | ) | [virtual] |
Scale text (font size along each dimension).
| double vtkLineRepresentation::GetDistance | ( | ) |
Get the distance between the points.
| void vtkLineRepresentation::SetLineColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) |
Convenience method to set the line color. Ideally one should use GetLineProperty()->SetColor().
| virtual vtkProperty* vtkLineRepresentation::GetDistanceAnnotationProperty | ( | ) | [virtual] |
Get the distance annotation property
| virtual vtkFollower* vtkLineRepresentation::GetTextActor | ( | ) | [virtual] |
Get the text actor
| 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 244 of file vtkLineRepresentation.h.
Definition at line 245 of file vtkLineRepresentation.h.
Definition at line 246 of file vtkLineRepresentation.h.
Definition at line 247 of file vtkLineRepresentation.h.
int vtkLineRepresentation::RepresentationState [protected] |
Definition at line 250 of file vtkLineRepresentation.h.
vtkActor* vtkLineRepresentation::LineActor [protected] |
Definition at line 253 of file vtkLineRepresentation.h.
vtkPolyDataMapper* vtkLineRepresentation::LineMapper [protected] |
Definition at line 254 of file vtkLineRepresentation.h.
vtkLineSource* vtkLineRepresentation::LineSource [protected] |
Definition at line 255 of file vtkLineRepresentation.h.
vtkActor** vtkLineRepresentation::Handle [protected] |
Definition at line 258 of file vtkLineRepresentation.h.
vtkPolyDataMapper** vtkLineRepresentation::HandleMapper [protected] |
Definition at line 259 of file vtkLineRepresentation.h.
vtkSphereSource** vtkLineRepresentation::HandleGeometry [protected] |
Definition at line 260 of file vtkLineRepresentation.h.
vtkProperty* vtkLineRepresentation::EndPointProperty [protected] |
Definition at line 264 of file vtkLineRepresentation.h.
Definition at line 265 of file vtkLineRepresentation.h.
vtkProperty* vtkLineRepresentation::EndPoint2Property [protected] |
Definition at line 266 of file vtkLineRepresentation.h.
Definition at line 267 of file vtkLineRepresentation.h.
vtkProperty* vtkLineRepresentation::LineProperty [protected] |
Definition at line 268 of file vtkLineRepresentation.h.
vtkProperty* vtkLineRepresentation::SelectedLineProperty [protected] |
Definition at line 269 of file vtkLineRepresentation.h.
int vtkLineRepresentation::Tolerance [protected] |
Definition at line 273 of file vtkLineRepresentation.h.
int vtkLineRepresentation::ClampToBounds [protected] |
Definition at line 276 of file vtkLineRepresentation.h.
double vtkLineRepresentation::StartP1[3] [protected] |
Definition at line 284 of file vtkLineRepresentation.h.
double vtkLineRepresentation::StartP2[3] [protected] |
Definition at line 285 of file vtkLineRepresentation.h.
double vtkLineRepresentation::StartLineHandle[3] [protected] |
Definition at line 286 of file vtkLineRepresentation.h.
double vtkLineRepresentation::Length [protected] |
Definition at line 287 of file vtkLineRepresentation.h.
double vtkLineRepresentation::LastEventPosition[3] [protected] |
Definition at line 288 of file vtkLineRepresentation.h.
vtkBox* vtkLineRepresentation::BoundingBox [protected] |
Definition at line 291 of file vtkLineRepresentation.h.
int vtkLineRepresentation::InitializedDisplayPosition [protected] |
Definition at line 297 of file vtkLineRepresentation.h.
int vtkLineRepresentation::DistanceAnnotationVisibility [protected] |
Definition at line 300 of file vtkLineRepresentation.h.
char* vtkLineRepresentation::DistanceAnnotationFormat [protected] |
Definition at line 301 of file vtkLineRepresentation.h.
vtkFollower* vtkLineRepresentation::TextActor [protected] |
Definition at line 303 of file vtkLineRepresentation.h.
vtkPolyDataMapper* vtkLineRepresentation::TextMapper [protected] |
Definition at line 304 of file vtkLineRepresentation.h.
vtkVectorText* vtkLineRepresentation::TextInput [protected] |
Definition at line 305 of file vtkLineRepresentation.h.
double vtkLineRepresentation::Distance [protected] |
Definition at line 306 of file vtkLineRepresentation.h.
bool vtkLineRepresentation::AnnotationTextScaleInitialized [protected] |
Definition at line 307 of file vtkLineRepresentation.h.
vtkCellPicker* vtkLineRepresentation::LinePicker [protected] |
Definition at line 309 of file vtkLineRepresentation.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkLineRepresentation.h
