vtkWidgetRepresentation Class Reference

#include <vtkWidgetRepresentation.h>

Inheritance diagram for vtkWidgetRepresentation:

[legend]

Collaboration diagram for vtkWidgetRepresentation:

[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 vtkWidgetRepresentation *	SafeDownCast (vtkObject *o)
Public Member Functions

virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderer *	GetRenderer ()
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
vtkRenderer *	Renderer
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

typedef vtkProp vtkWidgetRepresentation::Superclass

Standard methods for instances of this class.

Reimplemented from vtkProp.

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

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, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, and vtkTextRepresentation.

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, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, and vtkTextRepresentation.

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, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, and vtkTextRepresentation.

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, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, and vtkTextRepresentation.

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, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkEllipsoidTensorProbeRepresentation, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, and vtkTextRepresentation.

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.

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.