vtkBorderRepresentation Class Reference

#include <vtkBorderRepresentation.h>

Inheritance diagram for vtkBorderRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkBorderRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

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.

Warning:
The separation of the widget event handling (e.g., vtkBorderWidget) from the representation (vtkBorderRepresentation) enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).
See also:
vtkBorderWidget vtkTextWidget
Tests:
vtkBorderRepresentation (Tests)

Definition at line 56 of file vtkBorderRepresentation.h.

typedef vtkWidgetRepresentation Superclass
static int IsTypeOf (const char *type)
static vtkBorderRepresentationSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Types

enum  { BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }
enum  _InteractionState {
  Outside = 0, Inside, AdjustingP0, AdjustingP1,
  AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1,
  AdjustingE2, AdjustingE3
}

Public Member Functions

virtual vtkCoordinateGetPositionCoordinate ()
virtual void SetPosition (float x[2])
virtual void SetPosition (float x, float y)
virtual float * GetPosition ()
virtual vtkCoordinateGetPosition2Coordinate ()
virtual void SetPosition2 (float x[2])
virtual void SetPosition2 (float x, float y)
virtual float * GetPosition2 ()
virtual void SetShowBorder (int)
virtual int GetShowBorder ()
void SetShowBorderToOff ()
void SetShowBorderToOn ()
void SetShowBorderToActive ()
virtual vtkProperty2DGetBorderProperty ()
virtual void SetProportionalResize (int)
virtual int GetProportionalResize ()
virtual void ProportionalResizeOn ()
virtual void ProportionalResizeOff ()
virtual void SetMinimumSize (int, int)
void SetMinimumSize (int[2])
virtual int * GetMinimumSize ()
virtual void GetMinimumSize (int &, int &)
virtual void GetMinimumSize (int[2])
virtual void SetMaximumSize (int, int)
void SetMaximumSize (int[2])
virtual int * GetMaximumSize ()
virtual void GetMaximumSize (int &, int &)
virtual void GetMaximumSize (int[2])
virtual void SetTolerance (int)
virtual int GetTolerance ()
virtual double * GetSelectionPoint ()
virtual void GetSelectionPoint (double data[2])
virtual void SetMoving (int)
virtual int GetMoving ()
virtual void MovingOn ()
virtual void MovingOff ()
virtual void BuildRepresentation ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double eventPos[2])
virtual void GetSize (double size[2])
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void GetActors2D (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOverlay (vtkViewport *)
virtual int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int HasTranslucentPolygonalGeometry ()

Static Public Member Functions

static vtkBorderRepresentationNew ()

Protected Member Functions

 vtkBorderRepresentation ()
 ~vtkBorderRepresentation ()
virtual void NegotiateLayout ()

Protected Attributes

int ShowBorder
vtkProperty2DBorderProperty
int ProportionalResize
int Tolerance
int Moving
double SelectionPoint [2]
vtkCoordinatePositionCoordinate
vtkCoordinatePosition2Coordinate
int Negotiated
double StartPosition [2]
vtkPointsBWPoints
vtkPolyDataBWPolyData
vtkTransformBWTransform
vtkTransformPolyDataFilterBWTransformFilter
vtkPolyDataMapper2DBWMapper
vtkActor2DBWActor
int MinimumSize [2]
int MaximumSize [2]

Member Typedef Documentation


Member Enumeration Documentation

anonymous enum

Enumerator:
BORDER_OFF 
BORDER_ON 
BORDER_ACTIVE 

Definition at line 82 of file vtkBorderRepresentation.h.

Define the various states that the representation can be in.

Enumerator:
Outside 
Inside 
AdjustingP0 
AdjustingP1 
AdjustingP2 
AdjustingP3 
AdjustingE0 
AdjustingE1 
AdjustingE2 
AdjustingE3 

Definition at line 149 of file vtkBorderRepresentation.h.


Constructor & Destructor Documentation

vtkBorderRepresentation::vtkBorderRepresentation (  )  [protected]

vtkBorderRepresentation::~vtkBorderRepresentation (  )  [protected]


Member Function Documentation

static vtkBorderRepresentation* vtkBorderRepresentation::New (  )  [static]

virtual const char* vtkBorderRepresentation::GetClassName (  )  [virtual]

static int vtkBorderRepresentation::IsTypeOf ( const char *  type  )  [static]

virtual int vtkBorderRepresentation::IsA ( const char *  type  )  [virtual]

static vtkBorderRepresentation* vtkBorderRepresentation::SafeDownCast ( vtkObject o  )  [static]

void vtkBorderRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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. Also,

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. Also,

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. Also,

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. Also,

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. Also,

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. Also,

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. Also,

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. Also,

virtual void vtkBorderRepresentation::SetShowBorder ( int   )  [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.

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.

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.

Definition at line 92 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.

Definition at line 93 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.

Definition at line 94 of file vtkBorderRepresentation.h.

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, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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.

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, and vtkTextRepresentation.

Definition at line 171 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, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, and vtkTextRepresentation.

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, and vtkTextRepresentation.

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, and vtkTextRepresentation.

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, and vtkTextRepresentation.

virtual void vtkBorderRepresentation::NegotiateLayout (  )  [protected, virtual]


Member Data Documentation

Definition at line 192 of file vtkBorderRepresentation.h.

Definition at line 193 of file vtkBorderRepresentation.h.

Definition at line 194 of file vtkBorderRepresentation.h.

Definition at line 195 of file vtkBorderRepresentation.h.

Definition at line 196 of file vtkBorderRepresentation.h.

Definition at line 197 of file vtkBorderRepresentation.h.

Definition at line 200 of file vtkBorderRepresentation.h.

Definition at line 201 of file vtkBorderRepresentation.h.

Definition at line 205 of file vtkBorderRepresentation.h.

Definition at line 209 of file vtkBorderRepresentation.h.

Definition at line 213 of file vtkBorderRepresentation.h.

Definition at line 214 of file vtkBorderRepresentation.h.

Definition at line 215 of file vtkBorderRepresentation.h.

Definition at line 216 of file vtkBorderRepresentation.h.

Definition at line 217 of file vtkBorderRepresentation.h.

Definition at line 218 of file vtkBorderRepresentation.h.

Definition at line 221 of file vtkBorderRepresentation.h.

Definition at line 222 of file vtkBorderRepresentation.h.


The documentation for this class was generated from the following file:

Generated on Sat Dec 27 13:17:51 2008 for VTK by  doxygen 1.5.6