vtkWidgetRepresentation Class Reference

#include <vtkWidgetRepresentation.h>

Inheritance diagram for vtkWidgetRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkWidgetRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

abstract class defines interface between the widget and widget representation classes

This class is used to define the API for, and partially implement, a representation for different types of widgets. Note that the widget representation (i.e., subclasses of vtkWidgetRepresentation) are a type of vtkProp; meaning that they can be associated with a vtkRenderer end embedded in a scene like any other vtkActor. However, vtkWidgetRepresentation also defines an API that enables it to be paired with a subclass vtkAbstractWidget, meaning that it can be driven by a widget, serving to represent the widget as the widget responds to registered events.

The API defined here should be regarded as a guideline for implementing widgets and widget representations. Widget behavior is complex, as is the way the representation responds to the registered widget events, so the API may vary from widget to widget to reflect this complexity.

Warning:
The separation of the widget event handling and representation 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).

Definition at line 49 of file vtkWidgetRepresentation.h.

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

Public Member Functions

virtual void SetRenderer (vtkRenderer *ren)
virtual vtkRendererGetRenderer ()
virtual void BuildRepresentation ()=0
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double newEventPos[2])
virtual void EndWidgetInteraction (double newEventPos[2])
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual int GetInteractionState ()
virtual void Highlight (int vtkNotUsed(highlightOn))
virtual void SetPlaceFactor (double)
virtual double GetPlaceFactor ()
virtual void SetHandleSize (double)
virtual double GetHandleSize ()
virtual int GetNeedToRender ()
virtual void SetNeedToRender (int)
virtual void NeedToRenderOn ()
virtual void NeedToRenderOff ()
virtual double * GetBounds ()
virtual void ShallowCopy (vtkProp *prop)
virtual void GetActors (vtkPropCollection *)
virtual void GetActors2D (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOverlay (vtkViewport *vtkNotUsed(viewport))
virtual int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int HasTranslucentPolygonalGeometry ()

Protected Member Functions

 vtkWidgetRepresentation ()
 ~vtkWidgetRepresentation ()
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double SizeHandlesRelativeToViewport (double factor, double pos[3])
double SizeHandlesInPixels (double factor, double pos[3])

Protected Attributes

vtkRendererRenderer
int InteractionState
double StartEventPosition [3]
double PlaceFactor
int Placed
double InitialBounds [6]
double InitialLength
int ValidPick
double HandleSize
int NeedToRender
vtkTimeStamp BuildTime

Member Typedef Documentation

Standard methods for instances of this class.

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

Definition at line 54 of file vtkWidgetRepresentation.h.


Constructor & Destructor Documentation

vtkWidgetRepresentation::vtkWidgetRepresentation (  )  [protected]

vtkWidgetRepresentation::~vtkWidgetRepresentation (  )  [protected]


Member Function Documentation

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual void vtkWidgetRepresentation::SetRenderer ( vtkRenderer ren  )  [virtual]

Subclasses of vtkWidgetRepresentation must implement these methods. This is considered the minimum API for a widget representation.

      SetRenderer() - the renderer in which the widget is to appear must be
      set. BuildRepresentation() - update the geometry of the widget based
      on its current state. 
WARNING: The renderer is NOT reference counted by the representation, in order to avoid reference loops. Be sure that the representation lifetime does not extend beyond the renderer lifetime.

Reimplemented in vtkCompassRepresentation, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

virtual vtkRenderer* vtkWidgetRepresentation::GetRenderer (  )  [virtual]

Subclasses of vtkWidgetRepresentation must implement these methods. This is considered the minimum API for a widget representation.

      SetRenderer() - the renderer in which the widget is to appear must be
      set. BuildRepresentation() - update the geometry of the widget based
      on its current state. 
WARNING: The renderer is NOT reference counted by the representation, in order to avoid reference loops. Be sure that the representation lifetime does not extend beyond the renderer lifetime.

virtual void vtkWidgetRepresentation::BuildRepresentation (  )  [pure virtual]

Subclasses of vtkWidgetRepresentation must implement these methods. This is considered the minimum API for a widget representation.

      SetRenderer() - the renderer in which the widget is to appear must be
      set. BuildRepresentation() - update the geometry of the widget based
      on its current state. 
WARNING: The renderer is NOT reference counted by the representation, in order to avoid reference loops. Be sure that the representation lifetime does not extend beyond the renderer lifetime.

Implemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual void vtkWidgetRepresentation::PlaceWidget ( double *  vtkNotUsedbounds[6]  )  [inline, virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Definition at line 99 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::StartWidgetInteraction ( double  eventPos[2]  )  [inline, virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBorderRepresentation, vtkBoxRepresentation, vtkCenteredSliderRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, and vtkSplineRepresentation.

Definition at line 100 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::WidgetInteraction ( double  newEventPos[2]  )  [inline, virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCenteredSliderRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, and vtkSplineRepresentation.

Definition at line 101 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::EndWidgetInteraction ( double  newEventPos[2]  )  [inline, virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Reimplemented in vtkAffineRepresentation2D, vtkBalloonRepresentation, vtkImplicitPlaneRepresentation, and vtkSplineRepresentation.

Definition at line 102 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
) [virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCenteredSliderRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkSeedRepresentation, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual int vtkWidgetRepresentation::GetInteractionState (  )  [inline, virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Definition at line 104 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::Highlight ( int   vtkNotUsedhighlightOn  )  [inline, virtual]

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
      (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
      current orientation of the widget is preserved, only scaling and
      translation is performed. StartWidgetInteraction() - generally
      corresponds to a initial event (e.g., mouse down) that starts the
      interaction process with the widget. WidgetInteraction() - invoked
      when an event causes the widget to change appearance.
      EndWidgetInteraction() - generally corresponds to a final event
      (e.g., mouse up) and completes the interaction sequence.
      ComputeInteractionState() - given (X,Y) display coordinates in a
      renderer, with a possible flag that modifies the computation, what is
      the state of the widget? GetInteractionState() - return the current
      state of the widget. Note that the value of "0" typically refers to
      "outside". The interaction state is strictly a function of the
      representation, and the widget/represent must agree on what they
      mean. Highlight() - turn on or off any highlights associated with the
      widget. Highlights are generally turned on when the widget is
      selected. 
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Definition at line 106 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::SetPlaceFactor ( double   )  [virtual]

Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.

virtual double vtkWidgetRepresentation::GetPlaceFactor (  )  [virtual]

Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.

virtual void vtkWidgetRepresentation::SetHandleSize ( double   )  [virtual]

Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). These handles (like spheres, etc.) are used to manipulate the widget. The HandleSize data member allows you to change the relative size of the handles. Note that while the handle size is typically expressed in pixels, some subclasses may use a relative size with respect to the viewport. (As a corollary, the value of this ivar is often set by subclasses of this class during instance instantiation.)

Reimplemented in vtkPointHandleRepresentation3D, and vtkSphereHandleRepresentation.

virtual double vtkWidgetRepresentation::GetHandleSize (  )  [virtual]

Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). These handles (like spheres, etc.) are used to manipulate the widget. The HandleSize data member allows you to change the relative size of the handles. Note that while the handle size is typically expressed in pixels, some subclasses may use a relative size with respect to the viewport. (As a corollary, the value of this ivar is often set by subclasses of this class during instance instantiation.)

virtual int vtkWidgetRepresentation::GetNeedToRender (  )  [virtual]

Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

virtual void vtkWidgetRepresentation::SetNeedToRender ( int   )  [virtual]

Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

virtual void vtkWidgetRepresentation::NeedToRenderOn (  )  [virtual]

Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

virtual void vtkWidgetRepresentation::NeedToRenderOff (  )  [virtual]

Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).

virtual double* vtkWidgetRepresentation::GetBounds ( void   )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkAxesTransformRepresentation, vtkBoxRepresentation, vtkDistanceRepresentation3D, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

Definition at line 149 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::ShallowCopy ( vtkProp prop  )  [virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkButtonRepresentation, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkSphereHandleRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual void vtkWidgetRepresentation::GetActors ( vtkPropCollection  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkTensorProbeRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

Definition at line 151 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::GetActors2D ( vtkPropCollection  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Reimplemented in vtkAffineRepresentation2D, vtkBorderRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, and vtkTextRepresentation.

Definition at line 152 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::GetVolumes ( vtkPropCollection  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Definition at line 153 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::ReleaseGraphicsResources ( vtkWindow  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

Definition at line 154 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::RenderOverlay ( vtkViewport vtkNotUsedviewport  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Definition at line 155 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::RenderOpaqueGeometry ( vtkViewport vtkNotUsedviewport  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Definition at line 156 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport vtkNotUsedviewport  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Definition at line 157 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::RenderVolumetricGeometry ( vtkViewport vtkNotUsedviewport  )  [inline, virtual]

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Definition at line 158 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::HasTranslucentPolygonalGeometry (  )  [inline, virtual]

void vtkWidgetRepresentation::AdjustBounds ( double  bounds[6],
double  newBounds[6],
double  center[3] 
) [protected]

double vtkWidgetRepresentation::SizeHandlesRelativeToViewport ( double  factor,
double  pos[3] 
) [protected]

double vtkWidgetRepresentation::SizeHandlesInPixels ( double  factor,
double  pos[3] 
) [protected]


Member Data Documentation

Definition at line 167 of file vtkWidgetRepresentation.h.

Definition at line 170 of file vtkWidgetRepresentation.h.

Definition at line 174 of file vtkWidgetRepresentation.h.

Definition at line 177 of file vtkWidgetRepresentation.h.

Definition at line 178 of file vtkWidgetRepresentation.h.

Definition at line 180 of file vtkWidgetRepresentation.h.

Definition at line 181 of file vtkWidgetRepresentation.h.

Definition at line 188 of file vtkWidgetRepresentation.h.

Definition at line 193 of file vtkWidgetRepresentation.h.

Definition at line 198 of file vtkWidgetRepresentation.h.

Definition at line 202 of file vtkWidgetRepresentation.h.


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

Generated on Wed Aug 24 12:19:55 2011 for VTK by  doxygen 1.5.6