VTK
Public Member Functions | 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 PlaceWidget (double *vtkNotUsed(bounds[6]))
 The following is a suggested API for widget representations. More...
 
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))
 
doubleGetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking. More...
 
void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual void BuildRepresentation ()=0
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual void StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual void EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
 
virtual int ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual double GetHandleSize ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...
 
virtual vtkTypeBool GetNeedToRender ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void SetNeedToRender (vtkTypeBool)
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void NeedToRenderOn ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
virtual void NeedToRenderOff ()
 Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...
 
vtkAssemblyPathGetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
void UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2)
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkWeakPointer< vtkRendererRenderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
vtkTypeBool NeedToRender
 
vtkTimeStamp BuildTime
 
vtkNew< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of this class. More...
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instances of this class. More...
 

Additional Inherited Members

- Public Types inherited from vtkProp
typedef vtkObject Superclass
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

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 60 of file vtkWidgetRepresentation.h.

Member Typedef Documentation

Standard methods for instances of this class.

Definition at line 67 of file vtkWidgetRepresentation.h.

Constructor & Destructor Documentation

vtkWidgetRepresentation::vtkWidgetRepresentation ( )
protected
vtkWidgetRepresentation::~vtkWidgetRepresentation ( )
overrideprotected

Member Function Documentation

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

Standard methods for instances of this class.

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

Standard methods for instances of this class.

Reimplemented from vtkProp.

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

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

Standard methods for instances of this class.

virtual vtkObjectBase* vtkWidgetRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkProp.

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

vtkWidgetRepresentation* vtkWidgetRepresentation::NewInstance ( ) const

Standard methods for instances of this class.

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

Standard methods for instances of this class.

Reimplemented from vtkObject.

Reimplemented in vtkOpenVRMenuRepresentation, vtkOpenVRPanelRepresentation, and vtkXYPlotRepresentation.

virtual void vtkWidgetRepresentation::PickingManagedOn ( )
virtual

Enable/Disable the use of a manager to process the picking.

Enabled by default.

virtual void vtkWidgetRepresentation::PickingManagedOff ( )
virtual

Enable/Disable the use of a manager to process the picking.

Enabled by default.

void vtkWidgetRepresentation::SetPickingManaged ( bool  managed)

Enable/Disable the use of a manager to process the picking.

Enabled by default.

virtual bool vtkWidgetRepresentation::GetPickingManaged ( )
virtual

Enable/Disable the use of a manager to process the picking.

Enabled by default.

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 representations draws itself.
Typically the renderer is set by the associated widget.
Use the widget's SetCurrentRenderer() method in most cases;
otherwise there is a risk of inconsistent behavior as events
and drawing may be performed in different viewports.
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 representations draws itself.
Typically the renderer is set by the associated widget.
Use the widget's SetCurrentRenderer() method in most cases;
otherwise there is a risk of inconsistent behavior as events
and drawing may be performed in different viewports.
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 representations draws itself.
Typically the renderer is set by the associated widget.
Use the widget's SetCurrentRenderer() method in most cases;
otherwise there is a risk of inconsistent behavior as events
and drawing may be performed in different viewports.
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, vtkImplicitPlaneRepresentation, vtkImplicitCylinderRepresentation, vtkSphereRepresentation, vtkBorderRepresentation, vtkCurveRepresentation, vtkConstrainedPointHandleRepresentation, vtkBoxRepresentation, vtkBalloonRepresentation, vtkPointHandleRepresentation3D, vtkLineRepresentation, vtkDistanceRepresentation, vtkParallelopipedRepresentation, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkAffineRepresentation2D, vtkDistanceRepresentation3D, vtkSeedRepresentation, vtkSliderRepresentation2D, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkCenteredSliderRepresentation, vtkFinitePlaneRepresentation, vtkResliceCursorRepresentation, vtkTexturedButtonRepresentation2D, vtkCompassRepresentation, vtkCheckerboardRepresentation, vtkSphereHandleRepresentation, vtkCameraRepresentation, vtkSplineRepresentation, vtkAngleRepresentation3D, vtkRectilinearWipeRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkProgressBarRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkBiDimensionalRepresentation2D, vtkDistanceRepresentation2D, vtkPointHandleRepresentation2D, vtkProp3DButtonRepresentation, vtkCaptionRepresentation, vtkMeasurementCubeHandleRepresentation3D, vtkAngleRepresentation2D, vtkFixedSizeHandleRepresentation3D, vtkPolyLineRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, vtkQWidgetRepresentation, vtkScalarBarRepresentation, vtkResliceCursorLineRepresentation, vtkOpenVRPanelRepresentation, vtkOpenVRMenuRepresentation, vtkXYPlotRepresentation, 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 135 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::StartWidgetInteraction ( double  eventPos[2])
inlinevirtual
virtual void vtkWidgetRepresentation::WidgetInteraction ( double  newEventPos[2])
inlinevirtual
virtual void vtkWidgetRepresentation::EndWidgetInteraction ( double  newEventPos[2])
inlinevirtual
virtual int vtkWidgetRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
virtual
virtual int vtkWidgetRepresentation::GetInteractionState ( )
inlinevirtual

Definition at line 140 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::Highlight ( int   vtkNotUsedhighlightOn)
inlinevirtual

Definition at line 142 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::StartComplexInteraction ( vtkRenderWindowInteractor ,
vtkAbstractWidget ,
unsigned long  ,
void *   
)
inlinevirtual
virtual void vtkWidgetRepresentation::ComplexInteraction ( vtkRenderWindowInteractor ,
vtkAbstractWidget ,
unsigned long  ,
void *   
)
inlinevirtual
virtual void vtkWidgetRepresentation::EndComplexInteraction ( vtkRenderWindowInteractor ,
vtkAbstractWidget ,
unsigned long  ,
void *   
)
inlinevirtual
virtual int vtkWidgetRepresentation::ComputeComplexInteractionState ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  callData,
int  modify = 0 
)
virtual
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 vtkTypeBool 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 ( vtkTypeBool  )
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).

double* vtkWidgetRepresentation::GetBounds ( void  )
inlineoverridevirtual

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 215 of file vtkWidgetRepresentation.h.

void vtkWidgetRepresentation::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this vtkProp.

Reimplemented from vtkProp.

void vtkWidgetRepresentation::GetActors ( vtkPropCollection )
inlineoverridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

These methods are used in that process.

Reimplemented from vtkProp.

Definition at line 217 of file vtkWidgetRepresentation.h.

void vtkWidgetRepresentation::GetActors2D ( vtkPropCollection )
inlineoverridevirtual

Reimplemented from vtkProp.

Reimplemented in vtkXYPlotRepresentation.

Definition at line 218 of file vtkWidgetRepresentation.h.

void vtkWidgetRepresentation::GetVolumes ( vtkPropCollection )
inlineoverridevirtual

Reimplemented from vtkProp.

Definition at line 219 of file vtkWidgetRepresentation.h.

void vtkWidgetRepresentation::ReleaseGraphicsResources ( vtkWindow )
inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

Reimplemented in vtkOpenVRPanelRepresentation, vtkOpenVRMenuRepresentation, and vtkXYPlotRepresentation.

Definition at line 220 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::RenderOverlay ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 221 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::RenderOpaqueGeometry ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 222 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 223 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::RenderVolumetricGeometry ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 224 of file vtkWidgetRepresentation.h.

vtkTypeBool vtkWidgetRepresentation::HasTranslucentPolygonalGeometry ( )
inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.

A simple prop that has some translucent polygonal geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some translucent polygonal geometry will return true. Default implementation return false.

Reimplemented from vtkProp.

Reimplemented in vtkOpenVRPanelRepresentation, vtkOpenVRMenuRepresentation, and vtkXYPlotRepresentation.

Definition at line 225 of file vtkWidgetRepresentation.h.

virtual void vtkWidgetRepresentation::RegisterPickers ( )
virtual
virtual void vtkWidgetRepresentation::UnRegisterPickers ( )
virtual

Unregister internal pickers from the Picking Manager.

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

Return the picking manager associated on the context on which the widget representation currently belong.

vtkAssemblyPath* vtkWidgetRepresentation::GetAssemblyPath ( double  X,
double  Y,
double  Z,
vtkAbstractPropPicker picker 
)
protected

Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path.

vtkAssemblyPath* vtkWidgetRepresentation::GetAssemblyPath3DPoint ( double  pos[3],
vtkAbstractPropPicker picker 
)
protected
double vtkWidgetRepresentation::SizeHandlesRelativeToViewport ( double  factor,
double  pos[3] 
)
protected
double vtkWidgetRepresentation::SizeHandlesInPixels ( double  factor,
double  pos[3] 
)
protected
void vtkWidgetRepresentation::UpdatePropPose ( vtkProp3D prop,
const double pos1,
const double orient1,
const double pos2,
const double orient2 
)
protected

Member Data Documentation

vtkWeakPointer<vtkRenderer> vtkWidgetRepresentation::Renderer
protected

Definition at line 244 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::InteractionState
protected

Definition at line 247 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::StartEventPosition[3]
protected

Definition at line 251 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::PlaceFactor
protected

Definition at line 254 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::Placed
protected

Definition at line 255 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::InitialBounds[6]
protected

Definition at line 257 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::InitialLength
protected

Definition at line 258 of file vtkWidgetRepresentation.h.

int vtkWidgetRepresentation::ValidPick
protected

Definition at line 265 of file vtkWidgetRepresentation.h.

bool vtkWidgetRepresentation::PickingManaged
protected

Definition at line 269 of file vtkWidgetRepresentation.h.

double vtkWidgetRepresentation::HandleSize
protected

Definition at line 290 of file vtkWidgetRepresentation.h.

vtkTypeBool vtkWidgetRepresentation::NeedToRender
protected

Definition at line 295 of file vtkWidgetRepresentation.h.

vtkTimeStamp vtkWidgetRepresentation::BuildTime
protected

Definition at line 299 of file vtkWidgetRepresentation.h.

vtkNew<vtkTransform> vtkWidgetRepresentation::TempTransform
protected

Definition at line 306 of file vtkWidgetRepresentation.h.

vtkNew<vtkMatrix4x4> vtkWidgetRepresentation::TempMatrix
protected

Definition at line 307 of file vtkWidgetRepresentation.h.


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