VTK  9.0.20201123
Public Types | Public Member Functions | Static 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 Types

enum  Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual vtkRendererGetRenderer ()
 
virtual void BuildRepresentation ()=0
 
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))
 
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 ()
 
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 ()
 
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)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
double * GetBounds () 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...
 
- 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 SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 
virtual void DragableOn ()
 
virtual void DragableOff ()
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently. 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 ()
 
virtual void UseBoundsOn ()
 
virtual void UseBoundsOff ()
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkAssemblyPathGetNextPath ()
 
virtual int GetNumberOfPaths ()
 
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 vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 
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 vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. 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...
 
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...
 
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 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)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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)
 
bool NearbyEvent (int X, int Y, double bounds[6])
 
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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 66 of file vtkWidgetRepresentation.h.

Member Enumeration Documentation

◆ Axis

Axis labels.

Enumerator
NONE 
XAxis 
YAxis 
ZAxis 

Definition at line 236 of file vtkWidgetRepresentation.h.

Constructor & Destructor Documentation

◆ vtkWidgetRepresentation()

vtkWidgetRepresentation::vtkWidgetRepresentation ( )
protected

◆ ~vtkWidgetRepresentation()

vtkWidgetRepresentation::~vtkWidgetRepresentation ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkProp.

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWidgetRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProp.

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

◆ NewInstance()

vtkWidgetRepresentation* vtkWidgetRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkOpenVRMenuRepresentation, vtkOpenVRPanelRepresentation, and vtkXYPlotRepresentation.

◆ PickingManagedOn()

virtual void vtkWidgetRepresentation::PickingManagedOn ( )
virtual

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

Enabled by default.

◆ PickingManagedOff()

virtual void vtkWidgetRepresentation::PickingManagedOff ( )
virtual

◆ SetPickingManaged()

void vtkWidgetRepresentation::SetPickingManaged ( bool  managed)

◆ GetPickingManaged()

virtual bool vtkWidgetRepresentation::GetPickingManaged ( )
virtual

◆ SetRenderer()

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, vtkOrientedGlyphContourRepresentation, and vtkMagnifierRepresentation.

◆ GetRenderer()

virtual vtkRenderer* vtkWidgetRepresentation::GetRenderer ( )
virtual

◆ BuildRepresentation()

virtual void vtkWidgetRepresentation::BuildRepresentation ( )
pure virtual

Implemented in vtkContourRepresentation, vtkCurveRepresentation, vtkImplicitPlaneRepresentation, vtkImplicitCylinderRepresentation, vtkSphereRepresentation, vtkTensorRepresentation, vtkBorderRepresentation, vtkConstrainedPointHandleRepresentation, vtkBalloonRepresentation, vtkBoxRepresentation, vtkLineRepresentation, vtkDistanceRepresentation, vtkPointHandleRepresentation3D, vtkParallelopipedRepresentation, vtkSliderRepresentation3D, vtkTexturedButtonRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkPointCloudRepresentation, vtkResliceCursorRepresentation, vtkDistanceRepresentation3D, vtkSeedRepresentation, vtkSliderRepresentation2D, vtkCenteredSliderRepresentation, vtkMagnifierRepresentation, vtkFinitePlaneRepresentation, vtkLightRepresentation, vtkProgressBarRepresentation, vtkTexturedButtonRepresentation2D, vtkCompassRepresentation, vtkSphereHandleRepresentation, vtkCheckerboardRepresentation, vtkCameraRepresentation, vtkSplineRepresentation, vtkAngleRepresentation3D, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkBiDimensionalRepresentation2D, vtkRectilinearWipeRepresentation, vtkOrientedGlyphContourRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkFixedSizeHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation2D, vtkCaptionRepresentation, vtkAngleRepresentation2D, vtkDistanceRepresentation2D, vtkMeasurementCubeHandleRepresentation3D, vtkPolyLineRepresentation, vtkImplicitImageRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, vtkQWidgetRepresentation, vtkScalarBarRepresentation, vtkOpenVRPanelRepresentation, vtkResliceCursorLineRepresentation, vtkOpenVRMenuRepresentation, vtkXYPlotRepresentation, vtkContinuousValueWidgetRepresentation, vtkTensorProbeRepresentation, and vtkEllipsoidTensorProbeRepresentation.

◆ PlaceWidget()

virtual void vtkWidgetRepresentation::PlaceWidget ( double *  vtkNotUsedbounds[6])
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 ensure 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.

◆ StartWidgetInteraction()

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

◆ WidgetInteraction()

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

◆ EndWidgetInteraction()

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

◆ ComputeInteractionState()

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

◆ GetInteractionState()

virtual int vtkWidgetRepresentation::GetInteractionState ( )
inlinevirtual

Definition at line 139 of file vtkWidgetRepresentation.h.

◆ Highlight()

virtual void vtkWidgetRepresentation::Highlight ( int   vtkNotUsedhighlightOn)
inlinevirtual

Definition at line 140 of file vtkWidgetRepresentation.h.

◆ StartComplexInteraction()

virtual void vtkWidgetRepresentation::StartComplexInteraction ( vtkRenderWindowInteractor ,
vtkAbstractWidget ,
unsigned long  ,
void *   
)
inlinevirtual

◆ ComplexInteraction()

virtual void vtkWidgetRepresentation::ComplexInteraction ( vtkRenderWindowInteractor ,
vtkAbstractWidget ,
unsigned long  ,
void *   
)
inlinevirtual

◆ EndComplexInteraction()

virtual void vtkWidgetRepresentation::EndComplexInteraction ( vtkRenderWindowInteractor ,
vtkAbstractWidget ,
unsigned long  ,
void *   
)
inlinevirtual

◆ ComputeComplexInteractionState()

virtual int vtkWidgetRepresentation::ComputeComplexInteractionState ( vtkRenderWindowInteractor iren,
vtkAbstractWidget widget,
unsigned long  event,
void *  callData,
int  modify = 0 
)
virtual

◆ SetPlaceFactor()

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.

◆ GetPlaceFactor()

virtual double vtkWidgetRepresentation::GetPlaceFactor ( )
virtual

◆ SetHandleSize()

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.

◆ GetHandleSize()

virtual double vtkWidgetRepresentation::GetHandleSize ( )
virtual

◆ GetNeedToRender()

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

◆ SetNeedToRender()

virtual void vtkWidgetRepresentation::SetNeedToRender ( vtkTypeBool  )
virtual

◆ NeedToRenderOn()

virtual void vtkWidgetRepresentation::NeedToRenderOn ( )
virtual

◆ NeedToRenderOff()

virtual void vtkWidgetRepresentation::NeedToRenderOff ( )
virtual

◆ GetBounds()

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

◆ ShallowCopy()

void vtkWidgetRepresentation::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this vtkProp.

Reimplemented from vtkProp.

◆ GetActors()

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

◆ GetActors2D()

void vtkWidgetRepresentation::GetActors2D ( vtkPropCollection )
inlineoverridevirtual

Reimplemented from vtkProp.

Reimplemented in vtkXYPlotRepresentation.

Definition at line 211 of file vtkWidgetRepresentation.h.

◆ GetVolumes()

void vtkWidgetRepresentation::GetVolumes ( vtkPropCollection )
inlineoverridevirtual

Reimplemented from vtkProp.

Definition at line 212 of file vtkWidgetRepresentation.h.

◆ ReleaseGraphicsResources()

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 vtkXYPlotRepresentation, vtkOpenVRPanelRepresentation, and vtkOpenVRMenuRepresentation.

Definition at line 213 of file vtkWidgetRepresentation.h.

◆ RenderOverlay()

int vtkWidgetRepresentation::RenderOverlay ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 214 of file vtkWidgetRepresentation.h.

◆ RenderOpaqueGeometry()

int vtkWidgetRepresentation::RenderOpaqueGeometry ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 215 of file vtkWidgetRepresentation.h.

◆ RenderTranslucentPolygonalGeometry()

int vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 216 of file vtkWidgetRepresentation.h.

◆ RenderVolumetricGeometry()

int vtkWidgetRepresentation::RenderVolumetricGeometry ( vtkViewport vtkNotUsedviewport)
inlineoverride

Definition at line 217 of file vtkWidgetRepresentation.h.

◆ HasTranslucentPolygonalGeometry()

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

◆ RegisterPickers()

virtual void vtkWidgetRepresentation::RegisterPickers ( )
virtual

◆ UnRegisterPickers()

virtual void vtkWidgetRepresentation::UnRegisterPickers ( )
virtual

Unregister internal pickers from the Picking Manager.

◆ AdjustBounds()

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

◆ GetPickingManager()

vtkPickingManager* vtkWidgetRepresentation::GetPickingManager ( )
protected

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

◆ GetAssemblyPath()

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.

◆ GetAssemblyPath3DPoint()

vtkAssemblyPath* vtkWidgetRepresentation::GetAssemblyPath3DPoint ( double  pos[3],
vtkAbstractPropPicker picker 
)
protected

◆ NearbyEvent()

bool vtkWidgetRepresentation::NearbyEvent ( int  X,
int  Y,
double  bounds[6] 
)
protected

◆ SizeHandlesRelativeToViewport()

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

◆ SizeHandlesInPixels()

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

◆ UpdatePropPose()

void vtkWidgetRepresentation::UpdatePropPose ( vtkProp3D prop,
const double *  pos1,
const double *  orient1,
const double *  pos2,
const double *  orient2 
)
protected

Member Data Documentation

◆ Renderer

vtkWeakPointer<vtkRenderer> vtkWidgetRepresentation::Renderer
protected

Definition at line 250 of file vtkWidgetRepresentation.h.

◆ InteractionState

int vtkWidgetRepresentation::InteractionState
protected

Definition at line 253 of file vtkWidgetRepresentation.h.

◆ StartEventPosition

double vtkWidgetRepresentation::StartEventPosition[3]
protected

Definition at line 257 of file vtkWidgetRepresentation.h.

◆ PlaceFactor

double vtkWidgetRepresentation::PlaceFactor
protected

Definition at line 260 of file vtkWidgetRepresentation.h.

◆ Placed

int vtkWidgetRepresentation::Placed
protected

Definition at line 261 of file vtkWidgetRepresentation.h.

◆ InitialBounds

double vtkWidgetRepresentation::InitialBounds[6]
protected

Definition at line 263 of file vtkWidgetRepresentation.h.

◆ InitialLength

double vtkWidgetRepresentation::InitialLength
protected

Definition at line 264 of file vtkWidgetRepresentation.h.

◆ ValidPick

int vtkWidgetRepresentation::ValidPick
protected

Definition at line 271 of file vtkWidgetRepresentation.h.

◆ PickingManaged

bool vtkWidgetRepresentation::PickingManaged
protected

Definition at line 275 of file vtkWidgetRepresentation.h.

◆ HandleSize

double vtkWidgetRepresentation::HandleSize
protected

Definition at line 300 of file vtkWidgetRepresentation.h.

◆ NeedToRender

vtkTypeBool vtkWidgetRepresentation::NeedToRender
protected

Definition at line 305 of file vtkWidgetRepresentation.h.

◆ BuildTime

vtkTimeStamp vtkWidgetRepresentation::BuildTime
protected

Definition at line 309 of file vtkWidgetRepresentation.h.

◆ TempTransform

vtkNew<vtkTransform> vtkWidgetRepresentation::TempTransform
protected

Definition at line 315 of file vtkWidgetRepresentation.h.

◆ TempMatrix

vtkNew<vtkMatrix4x4> vtkWidgetRepresentation::TempMatrix
protected

Definition at line 316 of file vtkWidgetRepresentation.h.


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