VTK
Protected Member Functions | Protected Attributes | List of all members
vtkWidgetRepresentation Class Referenceabstract

abstract class defines interface between the widget and widget representation classes More...

#include <vtkWidgetRepresentation.h>

Inheritance diagram for vtkWidgetRepresentation:
[legend]
Collaboration diagram for vtkWidgetRepresentation:
[legend]

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 ()
 
- Public Member Functions inherited from vtkProp
virtual void Pick ()
 
virtual unsigned long GetRedrawMTime ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 
virtual void SetVisibility (int)
 
virtual int GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (int)
 
virtual int GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void SetDragable (int)
 
virtual int GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual void SetUseBounds (bool)
 
virtual bool GetUseBounds ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 
virtual void RestoreEstimatedRenderTime ()
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 
virtual double GetAllocatedRenderTime ()
 
void SetRenderTimeMultiplier (double t)
 
virtual double GetRenderTimeMultiplier ()
 
virtual bool GetSupportsSelection ()
 
virtual int GetNumberOfConsumers ()
 
void AddConsumer (vtkObject *c)
 
void RemoveConsumer (vtkObject *c)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

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 Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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
 
- Protected Attributes inherited from vtkProp
int Visibility
 
int Pickable
 
int Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
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)
 

Additional Inherited Members

- Public Types inherited from vtkProp
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 
- Static Public Member Functions inherited from vtkProp
static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

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.

Member Typedef Documentation

Standard methods for instances of this class.

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

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

Standard methods for instances of this class.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

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

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

Standard methods for instances of this class.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

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 vtkLineRepresentation, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkCompassRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, and vtkOrientedGlyphContourRepresentation.

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

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

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])
inlinevirtual

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 vtkContourRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkImplicitPlaneRepresentation, vtkConstrainedPointHandleRepresentation, vtkBalloonRepresentation, vtkPointHandleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkLineRepresentation, vtkDistanceRepresentation, vtkAffineRepresentation2D, vtkSliderRepresentation3D, vtkAngleRepresentation, vtkSliderRepresentation2D, vtkAxesTransformRepresentation, vtkCenteredSliderRepresentation, vtkCompassRepresentation, vtkSphereHandleRepresentation, vtkRectilinearWipeRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkPointHandleRepresentation2D, and vtkContinuousValueWidgetRepresentation.

Definition at line 100 of file vtkWidgetRepresentation.h.

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

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 vtkContourRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkImplicitPlaneRepresentation, vtkConstrainedPointHandleRepresentation, vtkPointHandleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkLineRepresentation, vtkDistanceRepresentation, vtkAffineRepresentation2D, vtkSliderRepresentation3D, vtkAngleRepresentation, vtkSliderRepresentation2D, vtkAxesTransformRepresentation, vtkCenteredSliderRepresentation, vtkCompassRepresentation, vtkSphereHandleRepresentation, vtkRectilinearWipeRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkBiDimensionalRepresentation2D, vtkOrientedGlyphContourRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkScalarBarRepresentation, and vtkContinuousValueWidgetRepresentation.

Definition at line 101 of file vtkWidgetRepresentation.h.

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

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 vtkSplineRepresentation, vtkImplicitPlaneRepresentation, vtkBalloonRepresentation, and vtkAffineRepresentation2D.

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 vtkContourRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkImplicitPlaneRepresentation, vtkBalloonRepresentation, vtkConstrainedPointHandleRepresentation, vtkBorderRepresentation, vtkPointHandleRepresentation3D, vtkBoxRepresentation, vtkLineRepresentation, vtkParallelopipedRepresentation, vtkAffineRepresentation2D, vtkDistanceRepresentation, vtkTexturedButtonRepresentation, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkCenteredSliderRepresentation, vtkSeedRepresentation, vtkCompassRepresentation, vtkSphereHandleRepresentation, vtkTexturedButtonRepresentation2D, vtkRectilinearWipeRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkBiDimensionalRepresentation2D, vtkProp3DButtonRepresentation, and vtkPointHandleRepresentation2D.

virtual int vtkWidgetRepresentation::GetInteractionState ( )
inlinevirtual

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)
inlinevirtual

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  )
inlinevirtual

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 vtkSphereRepresentation, vtkSplineRepresentation, vtkImplicitPlaneRepresentation, vtkPointHandleRepresentation3D, vtkBoxRepresentation, vtkLineRepresentation, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkOrientedGlyphContourRepresentation, vtkDistanceRepresentation3D, vtkAxesTransformRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkSphereHandleRepresentation, vtkParallelopipedRepresentation, vtkProp3DButtonRepresentation, and vtkPointHandleRepresentation2D.

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 vtkConstrainedPointHandleRepresentation, vtkPointHandleRepresentation3D, vtkAffineRepresentation2D, vtkTexturedButtonRepresentation, vtkHandleRepresentation, vtkTexturedButtonRepresentation2D, vtkSphereHandleRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkButtonRepresentation, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation2D, and vtkAffineRepresentation.

virtual void vtkWidgetRepresentation::GetActors ( vtkPropCollection )
inlinevirtual

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 vtkImplicitPlaneRepresentation, vtkConstrainedPointHandleRepresentation, vtkPointHandleRepresentation3D, vtkLineRepresentation, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkCenteredSliderRepresentation, vtkCompassRepresentation, vtkSphereHandleRepresentation, vtkCheckerboardRepresentation, vtkOrientedGlyphContourRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkTensorProbeRepresentation, vtkParallelopipedRepresentation, and vtkEllipsoidTensorProbeRepresentation.

Definition at line 151 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::GetActors2D ( vtkPropCollection )
inlinevirtual

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 vtkBorderRepresentation, vtkAffineRepresentation2D, vtkSliderRepresentation2D, vtkRectilinearWipeRepresentation, vtkCameraRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkCaptionRepresentation, vtkPointHandleRepresentation2D, vtkPlaybackRepresentation, vtkLogoRepresentation, vtkTextRepresentation, and vtkScalarBarRepresentation.

Definition at line 152 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::GetVolumes ( vtkPropCollection )
inlinevirtual

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 )
inlinevirtual

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

Definition at line 154 of file vtkWidgetRepresentation.h.

virtual int vtkWidgetRepresentation::RenderOverlay ( vtkViewport vtkNotUsedviewport)
inlinevirtual

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)
inlinevirtual

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)
inlinevirtual

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)
inlinevirtual

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 ( )
inlinevirtual
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

vtkRenderer* vtkWidgetRepresentation::Renderer
protected

Definition at line 167 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::InteractionState
protected

Definition at line 170 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::StartEventPosition[3]
protected

Definition at line 174 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::PlaceFactor
protected

Definition at line 177 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::Placed
protected

Definition at line 178 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::InitialBounds[6]
protected

Definition at line 180 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::InitialLength
protected

Definition at line 181 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::ValidPick
protected

Definition at line 188 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::HandleSize
protected

Definition at line 193 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::NeedToRender
protected

Definition at line 198 of file vtkWidgetRepresentation.h.

vtkTimeStamp vtkWidgetRepresentation::BuildTime
protected

Definition at line 202 of file vtkWidgetRepresentation.h.


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