represent the vtkDistanceWidget More...
#include <vtkDistanceRepresentation.h>
Detailed Description
represent the vtkDistanceWidget
The vtkDistanceRepresentation is a superclass for various types of representations for the vtkDistanceWidget. Logically subclasses consist of an axis and two handles for placing/manipulating the end points.
- See also:
- vtkDistanceWidget vtkHandleRepresentation vtkDistanceRepresentation2D vtkDistanceRepresentation
Definition at line 35 of file vtkDistanceRepresentation.h.
Member Typedef Documentation
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
Definition at line 40 of file vtkDistanceRepresentation.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 130 of file vtkDistanceRepresentation.h.
Constructor & Destructor Documentation
| vtkDistanceRepresentation::vtkDistanceRepresentation | ( | ) | [protected] |
| vtkDistanceRepresentation::~vtkDistanceRepresentation | ( | ) | [protected] |
Member Function Documentation
| static int vtkDistanceRepresentation::IsTypeOf | ( | const char * | type | ) | [static] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual int vtkDistanceRepresentation::IsA | ( | const char * | type | ) | [virtual] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| static vtkDistanceRepresentation* vtkDistanceRepresentation::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual vtkObjectBase* vtkDistanceRepresentation::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| void vtkDistanceRepresentation::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual double vtkDistanceRepresentation::GetDistance | ( | ) | [pure virtual] |
This representation and all subclasses must keep a distance consistent with the state of the widget.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::GetPoint1WorldPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::GetPoint2WorldPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual double* vtkDistanceRepresentation::GetPoint1WorldPosition | ( | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual double* vtkDistanceRepresentation::GetPoint2WorldPosition | ( | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::SetPoint1DisplayPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::SetPoint2DisplayPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::GetPoint1DisplayPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::GetPoint2DisplayPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::SetPoint1WorldPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual void vtkDistanceRepresentation::SetPoint2WorldPosition | ( | double | pos[3] | ) | [pure virtual] |
Methods to Set/Get the coordinates of the two points defining this representation. Note that methods are available for both display and world coordinates.
Implemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
This method is used to specify the type of handle representation to use for the two internal vtkHandleWidgets within vtkDistanceWidget. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkDistanceRepresentation uses this dummy to clone two vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkDistance widget.)
This method is used to specify the type of handle representation to use for the two internal vtkHandleWidgets within vtkDistanceWidget. To use this method, create a dummy vtkHandleWidget (or subclass), and then invoke this method with this dummy. Then the vtkDistanceRepresentation uses this dummy to clone two vtkHandleWidgets of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkDistance widget.)
| virtual vtkHandleRepresentation* vtkDistanceRepresentation::GetPoint1Representation | ( | ) | [virtual] |
Set/Get the two handle representations used for the vtkDistanceWidget. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)
| virtual vtkHandleRepresentation* vtkDistanceRepresentation::GetPoint2Representation | ( | ) | [virtual] |
Set/Get the two handle representations used for the vtkDistanceWidget. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)
| virtual void vtkDistanceRepresentation::SetTolerance | ( | int | ) | [virtual] |
The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the end points of the widget to be active.
| virtual int vtkDistanceRepresentation::GetTolerance | ( | ) | [virtual] |
The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the end points of the widget to be active.
| virtual void vtkDistanceRepresentation::SetLabelFormat | ( | const char * | ) | [virtual] |
Specify the format to use for labelling the distance. Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.
| virtual char* vtkDistanceRepresentation::GetLabelFormat | ( | ) | [virtual] |
Specify the format to use for labelling the distance. Note that an empty string results in no label, or a format string without a "%" character will not print the distance value.
| virtual void vtkDistanceRepresentation::SetRulerMode | ( | int | ) | [virtual] |
Enable or disable ruler mode. When enabled, the ticks on the distance widget are separated by the amount specified by RulerDistance. Otherwise, the ivar NumberOfRulerTicks is used to draw the tick marks.
| virtual int vtkDistanceRepresentation::GetRulerMode | ( | ) | [virtual] |
Enable or disable ruler mode. When enabled, the ticks on the distance widget are separated by the amount specified by RulerDistance. Otherwise, the ivar NumberOfRulerTicks is used to draw the tick marks.
| virtual void vtkDistanceRepresentation::RulerModeOn | ( | ) | [virtual] |
Enable or disable ruler mode. When enabled, the ticks on the distance widget are separated by the amount specified by RulerDistance. Otherwise, the ivar NumberOfRulerTicks is used to draw the tick marks.
| virtual void vtkDistanceRepresentation::RulerModeOff | ( | ) | [virtual] |
Enable or disable ruler mode. When enabled, the ticks on the distance widget are separated by the amount specified by RulerDistance. Otherwise, the ivar NumberOfRulerTicks is used to draw the tick marks.
| virtual void vtkDistanceRepresentation::SetRulerDistance | ( | double | ) | [virtual] |
Specify the RulerDistance which indicates the spacing of the major ticks. This ivar only has effect when the RulerMode is on.
| virtual double vtkDistanceRepresentation::GetRulerDistance | ( | ) | [virtual] |
Specify the RulerDistance which indicates the spacing of the major ticks. This ivar only has effect when the RulerMode is on.
| virtual void vtkDistanceRepresentation::SetNumberOfRulerTicks | ( | int | ) | [virtual] |
Specify the number of major ruler ticks. This overrides any subclasses (e.g., vtkDistanceRepresentation2D) that have alternative methods to specify the number of major ticks. Note: the number of ticks is the number between the two handle endpoints. This ivar only has effect when the RulerMode is off.
| virtual int vtkDistanceRepresentation::GetNumberOfRulerTicks | ( | ) | [virtual] |
Specify the number of major ruler ticks. This overrides any subclasses (e.g., vtkDistanceRepresentation2D) that have alternative methods to specify the number of major ticks. Note: the number of ticks is the number between the two handle endpoints. This ivar only has effect when the RulerMode is off.
| virtual void vtkDistanceRepresentation::BuildRepresentation | ( | ) | [virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Implements vtkWidgetRepresentation.
Reimplemented in vtkDistanceRepresentation3D, and vtkDistanceRepresentation2D.
| virtual int vtkDistanceRepresentation::ComputeInteractionState | ( | int | X, |
| int | Y, | ||
| int | modify = 0 |
||
| ) | [virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Reimplemented from vtkWidgetRepresentation.
| virtual void vtkDistanceRepresentation::StartWidgetInteraction | ( | double | e[2] | ) | [virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Reimplemented from vtkWidgetRepresentation.
| virtual void vtkDistanceRepresentation::WidgetInteraction | ( | double | e[2] | ) | [virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Reimplemented from vtkWidgetRepresentation.
Member Data Documentation
Definition at line 146 of file vtkDistanceRepresentation.h.
Definition at line 147 of file vtkDistanceRepresentation.h.
Definition at line 148 of file vtkDistanceRepresentation.h.
int vtkDistanceRepresentation::Tolerance [protected] |
Definition at line 151 of file vtkDistanceRepresentation.h.
char* vtkDistanceRepresentation::LabelFormat [protected] |
Definition at line 154 of file vtkDistanceRepresentation.h.
int vtkDistanceRepresentation::RulerMode [protected] |
Definition at line 157 of file vtkDistanceRepresentation.h.
double vtkDistanceRepresentation::RulerDistance [protected] |
Definition at line 158 of file vtkDistanceRepresentation.h.
int vtkDistanceRepresentation::NumberOfRulerTicks [protected] |
Definition at line 159 of file vtkDistanceRepresentation.h.
The documentation for this class was generated from the following file:
- dox/Interaction/Widgets/vtkDistanceRepresentation.h
