VTK  9.3.20240522
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHandleRepresentation Class Reference

abstract class for representing widget handles More...

#include <vtkHandleRepresentation.h>

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

Public Types

enum  InteractionStateType {
  Outside = 0 , Nearby , Selecting , Translating ,
  Scaling
}
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis {
  NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 ,
  Custom = 3
}
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class.
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual int CheckConstraint (vtkRenderer *renderer, double pos[2])
 Method has to be overridden in the subclasses which has constraints on placing the handle (Ex.
 
vtkMTimeType GetMTime () override
 Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation.
 
virtual void SetDisplayPosition (double pos[2])
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
 
virtual void GetDisplayPosition (double pos[2])
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
 
virtual double * GetDisplayPosition ()
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
 
virtual void SetWorldPosition (double pos[3])
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
 
virtual void GetWorldPosition (double pos[3])
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
 
virtual double * GetWorldPosition ()
 Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active.
 
virtual int GetTolerance ()
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active.
 
virtual void SetActiveRepresentation (vtkTypeBool)
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
 
virtual vtkTypeBool GetActiveRepresentation ()
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
 
virtual void ActiveRepresentationOn ()
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
 
virtual void ActiveRepresentationOff ()
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).
 
virtual void SetInteractionState (int)
 The interaction state may be set from a widget (e.g., HandleWidget) or other object.
 
virtual void SetConstrained (vtkTypeBool)
 Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
 
virtual vtkTypeBool GetConstrained ()
 Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
 
virtual void ConstrainedOn ()
 Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
 
virtual void ConstrainedOff ()
 Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
virtual void DeepCopy (vtkProp *prop)
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
void SetRenderer (vtkRenderer *ren) override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
virtual void SetPointPlacer (vtkPointPlacer *)
 Set/Get the point placer.
 
virtual vtkPointPlacerGetPointPlacer ()
 Set/Get the point placer.
 
virtual void GetTranslationVector (const double *p1, const double *p2, double *v) const
 Gets the translation vector.
 
virtual void Translate (const double *p1, const double *p2)
 Translates world position by vector p1p2 projected on the constraint axis if any.
 
virtual void Translate (const double *v)
 Translates world position by vector v projected on the constraint axis if any.
 
virtual int GetTranslationAxis ()
 Gets/Sets the constraint axis for translations.
 
virtual void SetTranslationAxis (int)
 Gets/Sets the constraint axis for translations.
 
void SetXTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetYTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetZTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetCustomTranslationAxisOn ()
 Toggles constraint translation axis on/off.
 
void SetTranslationAxisOff ()
 Toggles constraint translation axis on/off.
 
virtual double * GetCustomTranslationAxis ()
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
 
virtual void GetCustomTranslationAxis (double &, double &, double &)
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
 
virtual void GetCustomTranslationAxis (double[3])
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
 
virtual void SetCustomTranslationAxis (double, double, double)
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
 
virtual void SetCustomTranslationAxis (double[3])
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.
 
bool IsTranslationConstrained ()
 Returns true if ConstrainedAxis.
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PlaceWidget (double vtkNotUsed(bounds)[6])
 The following is a suggested API for widget representations.
 
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))
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp.
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp.
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
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.
 
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.
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager.
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager.
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking.
 
virtual void PickingManagedOff ()
 Enable/Disable the use of a manager to process the picking.
 
void SetPickingManaged (bool managed)
 Enable/Disable the use of a manager to process the picking.
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking.
 
virtual vtkRendererGetRenderer ()
 Subclasses of vtkWidgetRepresentation must implement these methods.
 
virtual void BuildRepresentation ()=0
 Subclasses of vtkWidgetRepresentation must implement these methods.
 
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).
 
virtual double GetPlaceFactor ()
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
 
virtual void SetHandleSize (double)
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
 
virtual double GetHandleSize ()
 Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
 
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).
 
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).
 
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).
 
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).
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class.
 
- Public Member Functions inherited from vtkProp
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked.
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently.
 
virtual double * GetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
 
virtual void ShallowCopy (vtkProp *prop)
 Shallow copy of this vtkProp.
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys.
 
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.
 
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.
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys.
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 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.
 
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.
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp.
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp.
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable.
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable.
 
virtual void PickableOn ()
 Set/Get the pickable instance variable.
 
virtual void PickableOff ()
 Set/Get the pickable instance variable.
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable.
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable.
 
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().
 
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().
 
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().
 
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().
 
virtual void InitPathTraversal ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys.
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys.
 
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.
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers.
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,.
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property.
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property.
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Protected Member Functions

 vtkHandleRepresentation ()
 
 ~vtkHandleRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 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.
 
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.
 
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
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Tolerance = 15
 
vtkTypeBool ActiveRepresentation = false
 
vtkTypeBool Constrained = false
 
vtkNew< vtkCoordinateDisplayPosition
 
vtkNew< vtkCoordinateWorldPosition
 
vtkTimeStamp DisplayPositionTime
 
vtkTimeStamp WorldPositionTime
 
vtkPointPlacerPointPlacer
 
int TranslationAxis = Axis::NONE
 
double CustomTranslationAxis [3] = { 1.0, 0.0, 0.0 }
 
- Protected Attributes inherited from vtkWidgetRepresentation
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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for instances of this class.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class.
 
static vtkHandleRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of this class.
 
vtkHandleRepresentationNewInstance () const
 Standard methods for instances of this class.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instances of this class.
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class.
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class.
 
- 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.
 
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.
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

abstract class for representing widget handles

This class defines an API for widget handle representations. These representations interact with vtkHandleWidget. Various representations can be used depending on the nature of the handle. The basic functionality of the handle representation is to maintain a position. The position is represented via a vtkCoordinate, meaning that the position can be easily obtained in a variety of coordinate systems.

Optional features for this representation include an active mode (the widget appears only when the mouse pointer is close to it). The active distance is expressed in pixels and represents a circle in display space.

The class may be subclassed so that alternative representations can be created. The class defines an API and a default implementation that the vtkHandleWidget interacts with to render itself in the scene.

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).
See also
vtkRectilinearWipeWidget vtkWidgetRepresentation vtkAbstractWidget
Tests:
vtkHandleRepresentation (Tests)

Definition at line 48 of file vtkHandleRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 56 of file vtkHandleRepresentation.h.

Member Enumeration Documentation

◆ InteractionStateType

Enumerator
Outside 
Nearby 
Selecting 
Translating 
Scaling 

Definition at line 102 of file vtkHandleRepresentation.h.

Constructor & Destructor Documentation

◆ vtkHandleRepresentation()

vtkHandleRepresentation::vtkHandleRepresentation ( )
protected

◆ ~vtkHandleRepresentation()

vtkHandleRepresentation::~vtkHandleRepresentation ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

Standard methods for instances of this class.

◆ IsA()

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

◆ SafeDownCast()

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

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHandleRepresentation::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkHandleRepresentation * vtkHandleRepresentation::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

◆ SetDisplayPosition()

virtual void vtkHandleRepresentation::SetDisplayPosition ( double  pos[2])
virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

◆ GetDisplayPosition() [1/2]

virtual void vtkHandleRepresentation::GetDisplayPosition ( double  pos[2])
virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

◆ GetDisplayPosition() [2/2]

virtual double * vtkHandleRepresentation::GetDisplayPosition ( )
virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

◆ SetWorldPosition()

virtual void vtkHandleRepresentation::SetWorldPosition ( double  pos[3])
virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkMeasurementCubeHandleRepresentation3D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, and vtkSphereHandleRepresentation.

◆ GetWorldPosition() [1/2]

virtual void vtkHandleRepresentation::GetWorldPosition ( double  pos[3])
virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

◆ GetWorldPosition() [2/2]

virtual double * vtkHandleRepresentation::GetWorldPosition ( )
virtual

Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates.

(Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.

◆ SetTolerance()

virtual void vtkHandleRepresentation::SetTolerance ( int  )
virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active.

◆ GetTolerance()

virtual int vtkHandleRepresentation::GetTolerance ( )
virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active.

◆ SetActiveRepresentation()

virtual void vtkHandleRepresentation::SetActiveRepresentation ( vtkTypeBool  )
virtual

Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).

By default, ActiveRepresentation is off and the representation is always visible.

◆ GetActiveRepresentation()

virtual vtkTypeBool vtkHandleRepresentation::GetActiveRepresentation ( )
virtual

Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).

By default, ActiveRepresentation is off and the representation is always visible.

◆ ActiveRepresentationOn()

virtual void vtkHandleRepresentation::ActiveRepresentationOn ( )
virtual

Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).

By default, ActiveRepresentation is off and the representation is always visible.

◆ ActiveRepresentationOff()

virtual void vtkHandleRepresentation::ActiveRepresentationOff ( )
virtual

Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active).

By default, ActiveRepresentation is off and the representation is always visible.

◆ SetInteractionState()

virtual void vtkHandleRepresentation::SetInteractionState ( int  )
virtual

The interaction state may be set from a widget (e.g., HandleWidget) or other object.

This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking processwith the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further.

◆ SetConstrained()

virtual void vtkHandleRepresentation::SetConstrained ( vtkTypeBool  )
virtual

Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.

◆ GetConstrained()

virtual vtkTypeBool vtkHandleRepresentation::GetConstrained ( )
virtual

Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.

◆ ConstrainedOn()

virtual void vtkHandleRepresentation::ConstrainedOn ( )
virtual

Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.

◆ ConstrainedOff()

virtual void vtkHandleRepresentation::ConstrainedOff ( )
virtual

Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.

◆ CheckConstraint()

virtual int vtkHandleRepresentation::CheckConstraint ( vtkRenderer renderer,
double  pos[2] 
)
virtual

Method has to be overridden in the subclasses which has constraints on placing the handle (Ex.

vtkConstrainedPointHandleRepresentation). It should return 1 if the position is within the constraint, else it should return 0. By default it returns 1.

Reimplemented in vtkConstrainedPointHandleRepresentation.

◆ ShallowCopy()

void vtkHandleRepresentation::ShallowCopy ( vtkProp prop)
overridevirtual

◆ DeepCopy()

virtual void vtkHandleRepresentation::DeepCopy ( vtkProp prop)
virtual

◆ SetRenderer()

void vtkHandleRepresentation::SetRenderer ( vtkRenderer ren)
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

◆ GetMTime()

vtkMTimeType vtkHandleRepresentation::GetMTime ( )
overridevirtual

Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation.

Reimplemented from vtkObject.

◆ SetPointPlacer()

virtual void vtkHandleRepresentation::SetPointPlacer ( vtkPointPlacer )
virtual

Set/Get the point placer.

Point placers can be used to dictate constraints on the placement of handles. As an example, see vtkBoundedPlanePointPlacer (constrains the placement of handles to a set of bounded planes) vtkFocalPlanePointPlacer (constrains placement on the focal plane) etc. The default point placer is vtkPointPlacer (which does not apply any constraints, so the handles are free to move anywhere).

Reimplemented in vtkPointHandleRepresentation2D.

◆ GetPointPlacer()

virtual vtkPointPlacer * vtkHandleRepresentation::GetPointPlacer ( )
virtual

Set/Get the point placer.

Point placers can be used to dictate constraints on the placement of handles. As an example, see vtkBoundedPlanePointPlacer (constrains the placement of handles to a set of bounded planes) vtkFocalPlanePointPlacer (constrains placement on the focal plane) etc. The default point placer is vtkPointPlacer (which does not apply any constraints, so the handles are free to move anywhere).

◆ GetTranslationVector()

virtual void vtkHandleRepresentation::GetTranslationVector ( const double *  p1,
const double *  p2,
double *  v 
) const
virtual

Gets the translation vector.

◆ Translate() [1/2]

virtual void vtkHandleRepresentation::Translate ( const double *  p1,
const double *  p2 
)
virtual

◆ Translate() [2/2]

virtual void vtkHandleRepresentation::Translate ( const double *  v)
virtual

◆ GetTranslationAxis()

virtual int vtkHandleRepresentation::GetTranslationAxis ( )
virtual

Gets/Sets the constraint axis for translations.

Returns Axis::NONE if none.

◆ SetTranslationAxis()

virtual void vtkHandleRepresentation::SetTranslationAxis ( int  )
virtual

Gets/Sets the constraint axis for translations.

Returns Axis::NONE if none.

◆ SetXTranslationAxisOn()

void vtkHandleRepresentation::SetXTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 205 of file vtkHandleRepresentation.h.

◆ SetYTranslationAxisOn()

void vtkHandleRepresentation::SetYTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 206 of file vtkHandleRepresentation.h.

◆ SetZTranslationAxisOn()

void vtkHandleRepresentation::SetZTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 207 of file vtkHandleRepresentation.h.

◆ SetCustomTranslationAxisOn()

void vtkHandleRepresentation::SetCustomTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 208 of file vtkHandleRepresentation.h.

◆ SetTranslationAxisOff()

void vtkHandleRepresentation::SetTranslationAxisOff ( )
inline

Toggles constraint translation axis on/off.

Definition at line 209 of file vtkHandleRepresentation.h.

◆ GetCustomTranslationAxis() [1/3]

virtual double * vtkHandleRepresentation::GetCustomTranslationAxis ( )
virtual

Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.

See also
SetCustomTranslationAxisOn

◆ GetCustomTranslationAxis() [2/3]

virtual void vtkHandleRepresentation::GetCustomTranslationAxis ( double &  ,
double &  ,
double &   
)
virtual

Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.

See also
SetCustomTranslationAxisOn

◆ GetCustomTranslationAxis() [3/3]

virtual void vtkHandleRepresentation::GetCustomTranslationAxis ( double  [3])
virtual

Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.

See also
SetCustomTranslationAxisOn

◆ SetCustomTranslationAxis() [1/2]

virtual void vtkHandleRepresentation::SetCustomTranslationAxis ( double  ,
double  ,
double   
)
virtual

Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.

See also
SetCustomTranslationAxisOn

◆ SetCustomTranslationAxis() [2/2]

virtual void vtkHandleRepresentation::SetCustomTranslationAxis ( double  [3])
virtual

Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom.

See also
SetCustomTranslationAxisOn

◆ IsTranslationConstrained()

bool vtkHandleRepresentation::IsTranslationConstrained ( )
inline

Returns true if ConstrainedAxis.

Definition at line 227 of file vtkHandleRepresentation.h.

Member Data Documentation

◆ Tolerance

int vtkHandleRepresentation::Tolerance = 15
protected

Definition at line 234 of file vtkHandleRepresentation.h.

◆ ActiveRepresentation

vtkTypeBool vtkHandleRepresentation::ActiveRepresentation = false
protected

Definition at line 235 of file vtkHandleRepresentation.h.

◆ Constrained

vtkTypeBool vtkHandleRepresentation::Constrained = false
protected

Definition at line 236 of file vtkHandleRepresentation.h.

◆ DisplayPosition

vtkNew<vtkCoordinate> vtkHandleRepresentation::DisplayPosition
protected

Definition at line 242 of file vtkHandleRepresentation.h.

◆ WorldPosition

vtkNew<vtkCoordinate> vtkHandleRepresentation::WorldPosition
protected

Definition at line 243 of file vtkHandleRepresentation.h.

◆ DisplayPositionTime

vtkTimeStamp vtkHandleRepresentation::DisplayPositionTime
protected

Definition at line 246 of file vtkHandleRepresentation.h.

◆ WorldPositionTime

vtkTimeStamp vtkHandleRepresentation::WorldPositionTime
protected

Definition at line 247 of file vtkHandleRepresentation.h.

◆ PointPlacer

vtkPointPlacer* vtkHandleRepresentation::PointPlacer
protected

Definition at line 250 of file vtkHandleRepresentation.h.

◆ TranslationAxis

int vtkHandleRepresentation::TranslationAxis = Axis::NONE
protected

Definition at line 253 of file vtkHandleRepresentation.h.

◆ CustomTranslationAxis

double vtkHandleRepresentation::CustomTranslationAxis[3] = { 1.0, 0.0, 0.0 }
protected

Definition at line 254 of file vtkHandleRepresentation.h.


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