VTK
|
represent a vtkBorderWidget More...
#include <vtkBorderRepresentation.h>
represent a vtkBorderWidget
This class is used to represent and render a vtBorderWidget. To use this class, you need to specify the two corners of a rectangular region.
The class is typically subclassed so that specialized representations can be created. The class defines an API and a default implementation that the vtkBorderRepresentation interacts with to render itself in the scene.
Definition at line 57 of file vtkBorderRepresentation.h.
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
Definition at line 65 of file vtkBorderRepresentation.h.
anonymous enum |
Definition at line 82 of file vtkBorderRepresentation.h.
Define the various states that the representation can be in.
Outside | |
Inside | |
AdjustingP0 | |
AdjustingP1 | |
AdjustingP2 | |
AdjustingP3 | |
AdjustingE0 | |
AdjustingE1 | |
AdjustingE2 | |
AdjustingE3 |
Definition at line 167 of file vtkBorderRepresentation.h.
vtkBorderRepresentation::vtkBorderRepresentation | ( | ) | [protected] |
vtkBorderRepresentation::~vtkBorderRepresentation | ( | ) | [protected] |
static vtkBorderRepresentation* vtkBorderRepresentation::New | ( | ) | [static] |
Instantiate this class.
Reimplemented from vtkObject.
Reimplemented in vtkScalarBarRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkXYPlotRepresentation, and vtkTextRepresentation.
static int vtkBorderRepresentation::IsTypeOf | ( | const char * | type | ) | [static] |
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual int vtkBorderRepresentation::IsA | ( | const char * | type | ) | [virtual] |
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
static vtkBorderRepresentation* vtkBorderRepresentation::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual vtkObjectBase* vtkBorderRepresentation::NewInstanceInternal | ( | ) | const [protected, virtual] |
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
void vtkBorderRepresentation::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) | [virtual] |
Define standard methods.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual vtkCoordinate* vtkBorderRepresentation::GetPositionCoordinate | ( | ) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual void vtkBorderRepresentation::SetPosition | ( | float | x[2] | ) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual void vtkBorderRepresentation::SetPosition | ( | float | x, |
float | y | ||
) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual float* vtkBorderRepresentation::GetPosition | ( | ) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual vtkCoordinate* vtkBorderRepresentation::GetPosition2Coordinate | ( | ) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual void vtkBorderRepresentation::SetPosition2 | ( | float | x[2] | ) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual void vtkBorderRepresentation::SetPosition2 | ( | float | x, |
float | y | ||
) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual float* vtkBorderRepresentation::GetPosition2 | ( | ) | [virtual] |
Specify opposite corners of the box defining the boundary of the widget. By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.
virtual void vtkBorderRepresentation::SetShowBorder | ( | int | border | ) | [virtual] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
virtual int vtkBorderRepresentation::GetShowBorderMinValue | ( | ) | [virtual] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
virtual int vtkBorderRepresentation::GetShowBorderMaxValue | ( | ) | [virtual] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
virtual int vtkBorderRepresentation::GetShowBorder | ( | ) | [virtual] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
void vtkBorderRepresentation::SetShowBorderToOff | ( | ) | [inline] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
Definition at line 96 of file vtkBorderRepresentation.h.
void vtkBorderRepresentation::SetShowBorderToOn | ( | ) | [inline] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
Definition at line 97 of file vtkBorderRepresentation.h.
void vtkBorderRepresentation::SetShowBorderToActive | ( | ) | [inline] |
Specify when and if the border should appear. If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()
Definition at line 98 of file vtkBorderRepresentation.h.
virtual void vtkBorderRepresentation::SetShowVerticalBorder | ( | int | ) | [virtual] |
Specify when and if the vertical border should appear. See Also: SetShowBorder(), SetShowHorizontalBorder()
virtual int vtkBorderRepresentation::GetShowVerticalBorder | ( | ) | [virtual] |
Specify when and if the vertical border should appear. See Also: SetShowBorder(), SetShowHorizontalBorder()
virtual void vtkBorderRepresentation::SetShowHorizontalBorder | ( | int | ) | [virtual] |
Specify when and if the horizontal border should appear. See Also: SetShowBorder(), SetShowVerticalBorder()
virtual int vtkBorderRepresentation::GetShowHorizontalBorder | ( | ) | [virtual] |
Specify when and if the horizontal border should appear. See Also: SetShowBorder(), SetShowVerticalBorder()
virtual vtkProperty2D* vtkBorderRepresentation::GetBorderProperty | ( | ) | [virtual] |
Specify the properties of the border.
virtual void vtkBorderRepresentation::SetProportionalResize | ( | int | ) | [virtual] |
Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.
virtual int vtkBorderRepresentation::GetProportionalResize | ( | ) | [virtual] |
Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.
virtual void vtkBorderRepresentation::ProportionalResizeOn | ( | ) | [virtual] |
Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.
virtual void vtkBorderRepresentation::ProportionalResizeOff | ( | ) | [virtual] |
Indicate whether resizing operations should keep the x-y directions proportional to one another. Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.
virtual void vtkBorderRepresentation::SetMinimumSize | ( | int | , |
int | |||
) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
void vtkBorderRepresentation::SetMinimumSize | ( | int | [2] | ) |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual int* vtkBorderRepresentation::GetMinimumSize | ( | ) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual void vtkBorderRepresentation::GetMinimumSize | ( | int & | , |
int & | |||
) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual void vtkBorderRepresentation::GetMinimumSize | ( | int | [2] | ) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual void vtkBorderRepresentation::SetMaximumSize | ( | int | , |
int | |||
) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
void vtkBorderRepresentation::SetMaximumSize | ( | int | [2] | ) |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual int* vtkBorderRepresentation::GetMaximumSize | ( | ) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual void vtkBorderRepresentation::GetMaximumSize | ( | int & | , |
int & | |||
) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual void vtkBorderRepresentation::GetMaximumSize | ( | int | [2] | ) | [virtual] |
Specify a minimum and/or maximum size (in pixels) that this representation can take. These methods require two values: size values in the x and y directions, respectively.
virtual void vtkBorderRepresentation::SetTolerance | ( | int | ) | [virtual] |
The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).
virtual int vtkBorderRepresentation::GetTolerance | ( | ) | [virtual] |
The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).
virtual double* vtkBorderRepresentation::GetSelectionPoint | ( | ) | [virtual] |
After a selection event within the region interior to the border; the normalized selection coordinates may be obtained.
virtual void vtkBorderRepresentation::GetSelectionPoint | ( | double | data[2] | ) | [virtual] |
After a selection event within the region interior to the border; the normalized selection coordinates may be obtained.
virtual void vtkBorderRepresentation::SetMoving | ( | int | ) | [virtual] |
This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion.
virtual int vtkBorderRepresentation::GetMoving | ( | ) | [virtual] |
This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion.
virtual void vtkBorderRepresentation::MovingOn | ( | ) | [virtual] |
This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion.
virtual void vtkBorderRepresentation::MovingOff | ( | ) | [virtual] |
This is a modifier of the interaction state. When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion.
virtual void vtkBorderRepresentation::BuildRepresentation | ( | ) | [virtual] |
Subclasses should implement these methods. See the superclasses' documentation for more information.
Implements vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkLogoRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual void vtkBorderRepresentation::StartWidgetInteraction | ( | double | eventPos[2] | ) | [virtual] |
Subclasses should implement these methods. See the superclasses' documentation for more information.
Reimplemented from vtkWidgetRepresentation.
virtual void vtkBorderRepresentation::WidgetInteraction | ( | double | eventPos[2] | ) | [virtual] |
Subclasses should implement these methods. See the superclasses' documentation for more information.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkScalarBarRepresentation, and vtkXYPlotRepresentation.
virtual void vtkBorderRepresentation::GetSize | ( | double | size[2] | ) | [inline, virtual] |
Subclasses should implement these methods. See the superclasses' documentation for more information.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
Definition at line 189 of file vtkBorderRepresentation.h.
virtual int vtkBorderRepresentation::ComputeInteractionState | ( | int | X, |
int | Y, | ||
int | modify = 0 |
||
) | [virtual] |
Subclasses should implement these methods. See the superclasses' documentation for more information.
Reimplemented from vtkWidgetRepresentation.
virtual void vtkBorderRepresentation::GetActors2D | ( | vtkPropCollection * | ) | [virtual] |
These methods are necessary to make this representation behave as a vtkProp.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual void vtkBorderRepresentation::ReleaseGraphicsResources | ( | vtkWindow * | ) | [virtual] |
These methods are necessary to make this representation behave as a vtkProp.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual int vtkBorderRepresentation::RenderOverlay | ( | vtkViewport * | ) | [virtual] |
These methods are necessary to make this representation behave as a vtkProp.
Reimplemented from vtkProp.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkLogoRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual int vtkBorderRepresentation::RenderOpaqueGeometry | ( | vtkViewport * | ) | [virtual] |
These methods are necessary to make this representation behave as a vtkProp.
Reimplemented from vtkProp.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual int vtkBorderRepresentation::RenderTranslucentPolygonalGeometry | ( | vtkViewport * | ) | [virtual] |
These methods are necessary to make this representation behave as a vtkProp.
Reimplemented from vtkProp.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual int vtkBorderRepresentation::HasTranslucentPolygonalGeometry | ( | ) | [virtual] |
These methods are necessary to make this representation behave as a vtkProp.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.
virtual void vtkBorderRepresentation::NegotiateLayout | ( | ) | [protected, virtual] |
virtual void vtkBorderRepresentation::UpdateShowBorder | ( | ) | [protected, virtual] |
int vtkBorderRepresentation::ShowVerticalBorder [protected] |
Definition at line 210 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::ShowHorizontalBorder [protected] |
Definition at line 211 of file vtkBorderRepresentation.h.
vtkProperty2D* vtkBorderRepresentation::BorderProperty [protected] |
Definition at line 212 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::ProportionalResize [protected] |
Definition at line 213 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::Tolerance [protected] |
Definition at line 214 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::Moving [protected] |
Definition at line 215 of file vtkBorderRepresentation.h.
double vtkBorderRepresentation::SelectionPoint[2] [protected] |
Definition at line 216 of file vtkBorderRepresentation.h.
vtkCoordinate* vtkBorderRepresentation::PositionCoordinate [protected] |
Definition at line 219 of file vtkBorderRepresentation.h.
Definition at line 220 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::Negotiated [protected] |
Definition at line 224 of file vtkBorderRepresentation.h.
double vtkBorderRepresentation::StartPosition[2] [protected] |
Definition at line 233 of file vtkBorderRepresentation.h.
vtkPoints* vtkBorderRepresentation::BWPoints [protected] |
Definition at line 237 of file vtkBorderRepresentation.h.
vtkPolyData* vtkBorderRepresentation::BWPolyData [protected] |
Definition at line 238 of file vtkBorderRepresentation.h.
vtkTransform* vtkBorderRepresentation::BWTransform [protected] |
Definition at line 239 of file vtkBorderRepresentation.h.
Definition at line 240 of file vtkBorderRepresentation.h.
vtkPolyDataMapper2D* vtkBorderRepresentation::BWMapper [protected] |
Definition at line 241 of file vtkBorderRepresentation.h.
vtkActor2D* vtkBorderRepresentation::BWActor [protected] |
Definition at line 242 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::MinimumSize[2] [protected] |
Definition at line 245 of file vtkBorderRepresentation.h.
int vtkBorderRepresentation::MaximumSize[2] [protected] |
Definition at line 246 of file vtkBorderRepresentation.h.