VTK  9.3.20240328
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPolygonalHandleRepresentation3D Class Reference

represent a user defined handle geometry in 3D space More...

#include <vtkPolygonalHandleRepresentation3D.h>

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

Public Member Functions

void SetWorldPosition (double p[3]) override
 Set the position of the point in world and display coordinates. More...
 
virtual void SetOffset (double, double, double)
 Set/get the offset of the handle position with respect to the handle center, assumed to be the origin. More...
 
virtual void SetOffset (double[3])
 Set/get the offset of the handle position with respect to the handle center, assumed to be the origin. More...
 
virtual double * GetOffset ()
 Set/get the offset of the handle position with respect to the handle center, assumed to be the origin. More...
 
virtual void GetOffset (double &, double &, double &)
 Set/get the offset of the handle position with respect to the handle center, assumed to be the origin. More...
 
virtual void GetOffset (double[3])
 Set/get the offset of the handle position with respect to the handle center, assumed to be the origin. More...
 
- Public Member Functions inherited from vtkAbstractPolygonalHandleRepresentation3D
virtual vtkAbstractTransformGetTransform ()
 Get the transform used to transform the generic handle polydata before placing it in the render window. More...
 
virtual void SetUniformScale (double scale)
 The handle may be scaled uniformly in all three dimensions using this API. More...
 
void Highlight (int highlight) override
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
virtual void Translate (const double *p1, const double *p2)
 Translates world position by vector p1p2 projected on the constraint axis if any. More...
 
virtual void Translate (const double *v)
 Translates world position by vector v projected on the constraint axis if any. More...
 
void SetDisplayPosition (double p[3]) override
 Set the position of the point in world and display coordinates. More...
 
void SetHandle (vtkPolyData *)
 Set/get the handle polydata. More...
 
vtkPolyDataGetHandle ()
 Set/get the handle polydata. More...
 
void SetProperty (vtkProperty *)
 Set/Get the handle properties when unselected and selected. More...
 
void SetSelectedProperty (vtkProperty *)
 Set/Get the handle properties when unselected and selected. More...
 
virtual vtkPropertyGetProperty ()
 Set/Get the handle properties when unselected and selected. More...
 
virtual vtkPropertyGetSelectedProperty ()
 Set/Get the handle properties when unselected and selected. More...
 
void BuildRepresentation () override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
void StartWidgetInteraction (double eventPos[2]) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
void WidgetInteraction (double eventPos[2]) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class behave as a vtkProp. More...
 
void DeepCopy (vtkProp *prop) override
 Methods to make this class behave as a vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Methods to make this class behave as a vtkProp. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Methods to make this class behave as a vtkProp. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Methods to make this class behave as a vtkProp. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Methods to make this class behave as a vtkProp. More...
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
virtual void SetLabelVisibility (vtkTypeBool)
 A label may be associated with the seed. More...
 
virtual vtkTypeBool GetLabelVisibility ()
 A label may be associated with the seed. More...
 
virtual void LabelVisibilityOn ()
 A label may be associated with the seed. More...
 
virtual void LabelVisibilityOff ()
 A label may be associated with the seed. More...
 
virtual void SetLabelText (const char *label)
 A label may be associated with the seed. More...
 
virtual char * GetLabelText ()
 A label may be associated with the seed. More...
 
virtual void SetLabelTextScale (double scale[3])
 Scale text (font size along each dimension). More...
 
void SetLabelTextScale (double x, double y, double z)
 Scale text (font size along each dimension). More...
 
virtual double * GetLabelTextScale ()
 Scale text (font size along each dimension). More...
 
virtual vtkFollowerGetLabelTextActor ()
 Get the label text actor. More...
 
virtual void SetHandleVisibility (vtkTypeBool)
 Toggle the visibility of the handle on and off. More...
 
virtual vtkTypeBool GetHandleVisibility ()
 Toggle the visibility of the handle on and off. More...
 
virtual void HandleVisibilityOn ()
 Toggle the visibility of the handle on and off. More...
 
virtual void HandleVisibilityOff ()
 Toggle the visibility of the handle on and off. More...
 
virtual void SetSmoothMotion (vtkTypeBool)
 Turn on/off smooth motion of the handle. More...
 
virtual vtkTypeBool GetSmoothMotion ()
 Turn on/off smooth motion of the handle. More...
 
virtual void SmoothMotionOn ()
 Turn on/off smooth motion of the handle. More...
 
virtual void SmoothMotionOff ()
 Turn on/off smooth motion of the handle. More...
 
vtkAbstractPolygonalHandleRepresentation3DNewInstance () const
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkHandleRepresentation
virtual int CheckConstraint (vtkRenderer *renderer, double pos[2])
 Method has to be overridden in the subclasses which has constraints on placing the handle (Ex. More...
 
vtkMTimeType GetMTime () override
 Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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). More...
 
virtual vtkTypeBool GetActiveRepresentation ()
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). More...
 
virtual void ActiveRepresentationOn ()
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). More...
 
virtual void ActiveRepresentationOff ()
 Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). More...
 
virtual void SetInteractionState (int)
 The interaction state may be set from a widget (e.g., HandleWidget) or other object. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
void SetRenderer (vtkRenderer *ren) override
 Methods to make this class properly act like a vtkWidgetRepresentation. More...
 
virtual void SetPointPlacer (vtkPointPlacer *)
 Set/Get the point placer. More...
 
virtual vtkPointPlacerGetPointPlacer ()
 Set/Get the point placer. More...
 
virtual void GetTranslationVector (const double *p1, const double *p2, double *v) const
 Gets the translation vector. More...
 
virtual void Translate (const double *v)
 Translates world position by vector v projected on the constraint axis if any. More...
 
virtual int GetTranslationAxis ()
 Gets/Sets the constraint axis for translations. More...
 
virtual void SetTranslationAxis (int)
 Gets/Sets the constraint axis for translations. More...
 
void SetXTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetYTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetZTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetCustomTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetTranslationAxisOff ()
 Toggles constraint translation axis on/off. More...
 
virtual double * GetCustomTranslationAxis ()
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom. More...
 
virtual void GetCustomTranslationAxis (double &, double &, double &)
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom. More...
 
virtual void GetCustomTranslationAxis (double[3])
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom. More...
 
virtual void SetCustomTranslationAxis (double, double, double)
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom. More...
 
virtual void SetCustomTranslationAxis (double[3])
 Get/Set the translation axis used when vtkHandleRepresentation::TranslationAxis is set to Axis::Custom. More...
 
bool IsTranslationConstrained ()
 Returns true if ConstrainedAxis. More...
 
vtkHandleRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PlaceWidget (double vtkNotUsed(bounds)[6])
 The following is a suggested API for widget representations. More...
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
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 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 vtkRendererGetRenderer ()
 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...
 
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...
 
- 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 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...
 
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...
 
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...
 
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. 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)
 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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...
 
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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkPolygonalHandleRepresentation3DNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkAbstractPolygonalHandleRepresentation3D
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkAbstractPolygonalHandleRepresentation3DSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkHandleRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkHandleRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
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...
 
- 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 (vtkTypeBool 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 vtkTypeBool 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 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

 vtkPolygonalHandleRepresentation3D ()
 
 ~vtkPolygonalHandleRepresentation3D () override=default
 
- Protected Member Functions inherited from vtkAbstractPolygonalHandleRepresentation3D
 vtkAbstractPolygonalHandleRepresentation3D ()
 
 ~vtkAbstractPolygonalHandleRepresentation3D () override
 
void Translate (const double *p1, const double *p2) override
 Translates world position by vector p1p2 projected on the constraint axis if any. More...
 
virtual void Scale (const double *p1, const double *p2, const double eventPos[2])
 
virtual void MoveFocus (const double *p1, const double *p2)
 
void CreateDefaultProperties ()
 
void MoveFocusRequest (const double *p1, const double *p2, const double eventPos[2], double requestedDisplayPos[3])
 
int DetermineConstraintAxis (int constraint, double *x, double *startPickPos)
 
virtual void UpdateHandle ()
 Update the actor position. More...
 
virtual void UpdateLabel ()
 Opportunity to update the label position and text during each render. More...
 
- Protected Member Functions inherited from vtkHandleRepresentation
 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. 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Offset [3]
 
- Protected Attributes inherited from vtkAbstractPolygonalHandleRepresentation3D
vtkActorActor
 
vtkPolyDataMapperMapper
 
vtkTransformPolyDataFilterHandleTransformFilter
 
vtkMatrixToLinearTransformHandleTransform
 
vtkMatrix4x4HandleTransformMatrix
 
vtkCellPickerHandlePicker
 
double LastPickPosition [3]
 
double LastEventPosition [2]
 
int ConstraintAxis
 
vtkPropertyProperty
 
vtkPropertySelectedProperty
 
int WaitingForMotion
 
int WaitCount
 
vtkTypeBool HandleVisibility
 
vtkTypeBool LabelVisibility
 
vtkFollowerLabelTextActor
 
vtkPolyDataMapperLabelTextMapper
 
vtkVectorTextLabelTextInput
 
bool LabelAnnotationTextScaleInitialized
 
vtkTypeBool SmoothMotion
 
- Protected Attributes inherited from vtkHandleRepresentation
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 vtkAbstractPolygonalHandleRepresentation3D Superclass
 Standard methods for instances of this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkPolygonalHandleRepresentation3DSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of this class. More...
 
vtkPolygonalHandleRepresentation3DNewInstance () 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 vtkAbstractPolygonalHandleRepresentation3D
typedef vtkHandleRepresentation Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkHandleRepresentation
enum  InteractionStateType {
  Outside = 0 , Nearby , Selecting , Translating ,
  Scaling
}
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for instances of this class. More...
 
- 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. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

represent a user defined handle geometry in 3D space

This class serves as the geometrical representation of a vtkHandleWidget. The handle can be represented by an arbitrary polygonal data (vtkPolyData), set via SetHandle(vtkPolyData *). The actual position of the handle will be initially assumed to be (0,0,0). You can specify an offset from this position if desired.

See also
vtkPointHandleRepresentation3D vtkHandleRepresentation vtkHandleWidget
Tests:
vtkPolygonalHandleRepresentation3D (Tests)

Definition at line 26 of file vtkPolygonalHandleRepresentation3D.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 39 of file vtkPolygonalHandleRepresentation3D.h.

Constructor & Destructor Documentation

◆ vtkPolygonalHandleRepresentation3D()

vtkPolygonalHandleRepresentation3D::vtkPolygonalHandleRepresentation3D ( )
protected

◆ ~vtkPolygonalHandleRepresentation3D()

vtkPolygonalHandleRepresentation3D::~vtkPolygonalHandleRepresentation3D ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkPolygonalHandleRepresentation3D* vtkPolygonalHandleRepresentation3D::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

Standard methods for instances of this class.

◆ IsA()

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

Standard methods for instances of this class.

Reimplemented from vtkAbstractPolygonalHandleRepresentation3D.

Reimplemented in vtkFixedSizeHandleRepresentation3D.

◆ SafeDownCast()

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

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPolygonalHandleRepresentation3D::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkAbstractPolygonalHandleRepresentation3D.

Reimplemented in vtkFixedSizeHandleRepresentation3D.

◆ NewInstance()

vtkPolygonalHandleRepresentation3D* vtkPolygonalHandleRepresentation3D::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

Standard methods for instances of this class.

Reimplemented from vtkAbstractPolygonalHandleRepresentation3D.

◆ SetWorldPosition()

void vtkPolygonalHandleRepresentation3D::SetWorldPosition ( double  p[3])
overridevirtual

Set the position of the point in world and display coordinates.

Reimplemented from vtkAbstractPolygonalHandleRepresentation3D.

◆ SetOffset() [1/2]

virtual void vtkPolygonalHandleRepresentation3D::SetOffset ( double  ,
double  ,
double   
)
virtual

Set/get the offset of the handle position with respect to the handle center, assumed to be the origin.

◆ SetOffset() [2/2]

virtual void vtkPolygonalHandleRepresentation3D::SetOffset ( double  [3])
virtual

Set/get the offset of the handle position with respect to the handle center, assumed to be the origin.

◆ GetOffset() [1/3]

virtual double* vtkPolygonalHandleRepresentation3D::GetOffset ( )
virtual

Set/get the offset of the handle position with respect to the handle center, assumed to be the origin.

◆ GetOffset() [2/3]

virtual void vtkPolygonalHandleRepresentation3D::GetOffset ( double &  ,
double &  ,
double &   
)
virtual

Set/get the offset of the handle position with respect to the handle center, assumed to be the origin.

◆ GetOffset() [3/3]

virtual void vtkPolygonalHandleRepresentation3D::GetOffset ( double  [3])
virtual

Set/get the offset of the handle position with respect to the handle center, assumed to be the origin.

Member Data Documentation

◆ Offset

double vtkPolygonalHandleRepresentation3D::Offset[3]
protected

Definition at line 61 of file vtkPolygonalHandleRepresentation3D.h.


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