vtkBiDimensionalRepresentation Class Reference
#include <vtkBiDimensionalRepresentation.h>
Detailed Description
represent the vtkBiDimensionalWidgetThe vtkBiDimensionalRepresentation is used to represent the bi-dimensional measure of an object. This representation consists of two perpendicular lines defined by four vtkHandleRepresentations. The four handles can be independently manipulated consistent with the orthogonal constraint on the lines. (Note: the four points are referred to as Point1, Point2, Point3 and Point4. Point1 and Point2 define the first line; and Point3 and Point4 define the second orthogonal line.) This particular class is an abstract class, contrete subclasses (e.g., vtkBiDimensionalRepresentation2D) actual implement the widget.
To create this widget, you click to place the first two points. The third point is mirrored with the fourth point; when you place the third point (which is orthogonal to the lined defined by the first two points), the fourth point is dropped as well. After definition, the four points can be moved (in constrained fashion, preserving orthogonality). Further, the entire widget can be translated by grabbing the center point of the widget; each line can be moved along the other line; and the entire widget can be rotated around its center point.
Definition at line 50 of file vtkBiDimensionalRepresentation.h.
Member Typedef Documentation
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 55 of file vtkBiDimensionalRepresentation.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 144 of file vtkBiDimensionalRepresentation.h.
Constructor & Destructor Documentation
| vtkBiDimensionalRepresentation::vtkBiDimensionalRepresentation | ( | ) | [protected] |
| vtkBiDimensionalRepresentation::~vtkBiDimensionalRepresentation | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkBiDimensionalRepresentation::GetClassName | ( | ) | [virtual] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkBiDimensionalRepresentation2D.
| static int vtkBiDimensionalRepresentation::IsTypeOf | ( | const char * | type | ) | [static] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkBiDimensionalRepresentation2D.
| virtual int vtkBiDimensionalRepresentation::IsA | ( | const char * | type | ) | [virtual] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkBiDimensionalRepresentation2D.
| static vtkBiDimensionalRepresentation* vtkBiDimensionalRepresentation::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkBiDimensionalRepresentation2D.
| void vtkBiDimensionalRepresentation::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Standard VTK methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::SetPoint1WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint2WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint3WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint4WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint1WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint2WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint3WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint4WorldPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint1DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint2DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint3DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::SetPoint4DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint1DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint2DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint3DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual void vtkBiDimensionalRepresentation::GetPoint4DisplayPosition | ( | double | pos[3] | ) | [virtual] |
Methods to Set/Get the coordinates of the four points defining this representation. Note that methods are available for both display and world coordinates.
| virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint1Representation | ( | ) | [virtual] |
Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)
| virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint2Representation | ( | ) | [virtual] |
Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)
| virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint3Representation | ( | ) | [virtual] |
Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)
| virtual vtkHandleRepresentation* vtkBiDimensionalRepresentation::GetPoint4Representation | ( | ) | [virtual] |
Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. (Note: properties can be set by grabbing these representations and setting the properties appropriately.)
| virtual void vtkBiDimensionalRepresentation::SetLine1Visibility | ( | int | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual int vtkBiDimensionalRepresentation::GetLine1Visibility | ( | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual void vtkBiDimensionalRepresentation::Line1VisibilityOn | ( | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual void vtkBiDimensionalRepresentation::Line1VisibilityOff | ( | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual void vtkBiDimensionalRepresentation::SetLine2Visibility | ( | int | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual int vtkBiDimensionalRepresentation::GetLine2Visibility | ( | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual void vtkBiDimensionalRepresentation::Line2VisibilityOn | ( | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| virtual void vtkBiDimensionalRepresentation::Line2VisibilityOff | ( | ) | [virtual] |
Special methods for turning off the lines that define the bi-dimensional measure. Generally these methods are used by the vtkBiDimensionalWidget to control the appearance of the widget. Note: turning off Line1 actually turns off Line1 and Line2.
| void vtkBiDimensionalRepresentation::SetHandleRepresentation | ( | vtkHandleRepresentation * | handle | ) |
This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkBiDimensionalRepresentation uses this dummy to clone four vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkBiDimensionalWidget for the purposes of cloning.)
| virtual void vtkBiDimensionalRepresentation::InstantiateHandleRepresentation | ( | ) | [virtual] |
This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation. To use this method, create a dummy vtkHandleRepresentation (or subclass), and then invoke this method with this dummy. Then the vtkBiDimensionalRepresentation uses this dummy to clone four vtkHandleRepresentations of the same type. Make sure you set the handle representation before the widget is enabled. (The method InstantiateHandleRepresentation() is invoked by the vtkBiDimensionalWidget for the purposes of cloning.)
| virtual void vtkBiDimensionalRepresentation::SetTolerance | ( | int | ) | [virtual] |
The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active.
| virtual int vtkBiDimensionalRepresentation::GetTolerance | ( | ) | [virtual] |
The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active.
| virtual double vtkBiDimensionalRepresentation::GetLength1 | ( | ) | [virtual] |
Return the length of the line defined by (Point1,Point2). This is the distance in the world coordinate system.
| virtual double vtkBiDimensionalRepresentation::GetLength2 | ( | ) | [virtual] |
Return the length of the line defined by (Point3,Point4). This is the distance in the world coordinate system.
| virtual void vtkBiDimensionalRepresentation::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* vtkBiDimensionalRepresentation::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 vtkBiDimensionalRepresentation::SetShowLabelAboveWidget | ( | int | ) | [virtual] |
Toggle whether to display the label above or below the widget. Defaults to 1.
| virtual int vtkBiDimensionalRepresentation::GetShowLabelAboveWidget | ( | ) | [virtual] |
Toggle whether to display the label above or below the widget. Defaults to 1.
| virtual void vtkBiDimensionalRepresentation::ShowLabelAboveWidgetOn | ( | ) | [virtual] |
Toggle whether to display the label above or below the widget. Defaults to 1.
| virtual void vtkBiDimensionalRepresentation::ShowLabelAboveWidgetOff | ( | ) | [virtual] |
Toggle whether to display the label above or below the widget. Defaults to 1.
| void vtkBiDimensionalRepresentation::SetID | ( | vtkIdType | id | ) |
Set/get the id to display in the label.
| virtual vtkIdType vtkBiDimensionalRepresentation::GetID | ( | ) | [virtual] |
Set/get the id to display in the label.
| virtual char* vtkBiDimensionalRepresentation::GetLabelText | ( | ) | [pure virtual] |
Get the text shown in the widget's label.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual double* vtkBiDimensionalRepresentation::GetLabelPosition | ( | ) | [pure virtual] |
Get the position of the widget's label in display coordinates.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::GetLabelPosition | ( | double | pos[3] | ) | [pure virtual] |
Get the position of the widget's label in display coordinates.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::GetWorldLabelPosition | ( | double | pos[3] | ) | [pure virtual] |
Get the position of the widget's label in display coordinates.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::StartWidgetDefinition | ( | double | e[2] | ) | [pure virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::Point2WidgetInteraction | ( | double | e[2] | ) | [pure virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::Point3WidgetInteraction | ( | double | e[2] | ) | [pure virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Implemented in vtkBiDimensionalRepresentation2D.
| virtual void vtkBiDimensionalRepresentation::StartWidgetManipulation | ( | double | e[2] | ) | [pure virtual] |
These are methods that satisfy vtkWidgetRepresentation's API.
Implemented in vtkBiDimensionalRepresentation2D.
Member Data Documentation
int vtkBiDimensionalRepresentation::Modifier [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 184 of file vtkBiDimensionalRepresentation.h.
Definition at line 187 of file vtkBiDimensionalRepresentation.h.
Definition at line 188 of file vtkBiDimensionalRepresentation.h.
Definition at line 189 of file vtkBiDimensionalRepresentation.h.
Definition at line 190 of file vtkBiDimensionalRepresentation.h.
Definition at line 191 of file vtkBiDimensionalRepresentation.h.
int vtkBiDimensionalRepresentation::Tolerance [protected] |
Definition at line 194 of file vtkBiDimensionalRepresentation.h.
int vtkBiDimensionalRepresentation::Line1Visibility [protected] |
Definition at line 197 of file vtkBiDimensionalRepresentation.h.
int vtkBiDimensionalRepresentation::Line2Visibility [protected] |
Definition at line 198 of file vtkBiDimensionalRepresentation.h.
vtkIdType vtkBiDimensionalRepresentation::ID [protected] |
Definition at line 200 of file vtkBiDimensionalRepresentation.h.
int vtkBiDimensionalRepresentation::IDInitialized [protected] |
Definition at line 201 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::P1World[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 204 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::P2World[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 205 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::P3World[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 206 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::P4World[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 207 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::P21World[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 208 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::P43World[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 209 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::T21 [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 210 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::T43 [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 211 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::CenterWorld[3] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 212 of file vtkBiDimensionalRepresentation.h.
double vtkBiDimensionalRepresentation::StartEventPositionWorld[4] [protected] |
Reimplemented in vtkBiDimensionalRepresentation2D.
Definition at line 213 of file vtkBiDimensionalRepresentation.h.
char* vtkBiDimensionalRepresentation::LabelFormat [protected] |
Definition at line 216 of file vtkBiDimensionalRepresentation.h.
int vtkBiDimensionalRepresentation::ShowLabelAboveWidget [protected] |
Definition at line 219 of file vtkBiDimensionalRepresentation.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkBiDimensionalRepresentation.h
