VTK  9.1.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSphereHandleRepresentation Class Reference

A spherical rendition of point in 3D space. More...

#include <vtkSphereHandleRepresentation.h>

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

Public Member Functions

void SetSphereRadius (double)
 
double GetSphereRadius ()
 
void SetHandleSize (double size) override
 Overload the superclasses SetHandleSize() method to update internal variables.
 
void Highlight (int highlight) override
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager.
 
void SetVisibility (vtkTypeBool visible) override
 Override to ensure that the internal actor's visibility is consistent with this representation's visibility.
 
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.
 
void SetWorldPosition (double p[3]) override
 Set the position of the point in world and display coordinates.
 
void SetDisplayPosition (double p[3]) override
 Set the position of the point in world and display coordinates.
 
virtual void SetTranslationMode (vtkTypeBool)
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).
 
virtual vtkTypeBool GetTranslationMode ()
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).
 
virtual void TranslationModeOn ()
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).
 
virtual void TranslationModeOff ()
 If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).
 
void SetProperty (vtkProperty *)
 Set/Get the handle properties when unselected and selected.
 
void SetSelectedProperty (vtkProperty *)
 Set/Get the handle properties when unselected and selected.
 
virtual vtkPropertyGetProperty ()
 Set/Get the handle properties when unselected and selected.
 
virtual vtkPropertyGetSelectedProperty ()
 Set/Get the handle properties when unselected and selected.
 
virtual void SetHotSpotSize (double)
 Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action.
 
virtual double GetHotSpotSize ()
 Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action.
 
double * GetBounds () override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
void BuildRepresentation () override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
void StartWidgetInteraction (double eventPos[2]) override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
void WidgetInteraction (double eventPos[2]) override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
void PlaceWidget (double bounds[6]) override
 Methods to make this class properly act like a vtkWidgetRepresentation.
 
void ShallowCopy (vtkProp *prop) override
 Methods to make this class behave as a vtkProp.
 
void DeepCopy (vtkProp *prop) override
 Methods to make this class behave as a vtkProp.
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp.
 
void ReleaseGraphicsResources (vtkWindow *) override
 Methods to make this class behave as a vtkProp.
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Methods to make this class behave as a vtkProp.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Methods to make this class behave as a vtkProp.
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Methods to make this class behave as a vtkProp.
 
- 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.
 
vtkMTimeType GetMTime () override
 Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation.
 
virtual void GetDisplayPosition (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 * 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 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 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 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 SetTranslationAxisOff ()
 Toggles constraint translation axis on/off.
 
bool IsTranslationConstrained ()
 Returns true if ContrainedAxis.
 
vtkHandleRepresentationNewInstance () const
 Standard methods for instances of this class.
 
- 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 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 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 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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
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.
 
virtual 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.
 

Static Public Member Functions

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

Protected Member Functions

 vtkSphereHandleRepresentation ()
 
 ~vtkSphereHandleRepresentation () override
 
void Translate (const double *p1, const double *p2) override
 Translates world position by vector p1p2 projected on the constraint axis if any.
 
void Scale (const double *p1, const double *p2, const double eventPos[2])
 
void MoveFocus (const double *p1, const double *p2)
 
void SizeBounds ()
 
void CreateDefaultProperties ()
 
- 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.
 
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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkActorActor
 
vtkPolyDataMapperMapper
 
vtkSphereSourceSphere
 
vtkCellPickerCursorPicker
 
double LastPickPosition [3]
 
double LastEventPosition [2]
 
int ConstraintAxis
 
vtkPropertyProperty
 
vtkPropertySelectedProperty
 
double HotSpotSize
 
int WaitingForMotion
 
int WaitCount
 
double CurrentHandleSize
 
vtkTypeBool TranslationMode
 
- Protected Attributes inherited from vtkHandleRepresentation
int Tolerance
 
vtkTypeBool ActiveRepresentation
 
vtkTypeBool Constrained
 
vtkCoordinateDisplayPosition
 
vtkCoordinateWorldPosition
 
vtkTimeStamp DisplayPositionTime
 
vtkTimeStamp WorldPositionTime
 
vtkPointPlacerPointPlacer
 
int TranslationAxis
 
- 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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkHandleRepresentation Superclass
 Standard methods for instances of this class.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class.
 
static vtkSphereHandleRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instances of this class.
 
vtkSphereHandleRepresentationNewInstance () 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

- Public Types inherited from vtkHandleRepresentation
enum  _InteractionState {
  Outside = 0 , Nearby , Selecting , Translating ,
  Scaling
}
 
typedef vtkWidgetRepresentation Superclass
 Standard methods for instances of this class.
 
- Public Types inherited from vtkWidgetRepresentation
enum  Axis { NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class.
 
- 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

A spherical rendition of point in 3D space.

This class is a concrete implementation of vtkHandleRepresentation. It renders handles as spherical blobs in 3D space.

See also
vtkHandleRepresentation vtkHandleWidget vtkSphereSource

Definition at line 40 of file vtkSphereHandleRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 52 of file vtkSphereHandleRepresentation.h.

Constructor & Destructor Documentation

◆ vtkSphereHandleRepresentation()

vtkSphereHandleRepresentation::vtkSphereHandleRepresentation ( )
protected

◆ ~vtkSphereHandleRepresentation()

vtkSphereHandleRepresentation::~vtkSphereHandleRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSphereHandleRepresentation * vtkSphereHandleRepresentation::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

Standard methods for instances of this class.

◆ IsA()

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

◆ SafeDownCast()

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

Standard methods for instances of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSphereHandleRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

◆ NewInstance()

vtkSphereHandleRepresentation * vtkSphereHandleRepresentation::NewInstance ( ) const

Standard methods for instances of this class.

◆ PrintSelf()

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

Standard methods for instances of this class.

Reimplemented from vtkHandleRepresentation.

◆ SetWorldPosition()

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

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

Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box. This method overloads the superclasses' SetWorldPosition() and SetDisplayPosition() in order to set the focal point of the cursor properly.

Reimplemented from vtkHandleRepresentation.

◆ SetDisplayPosition()

void vtkSphereHandleRepresentation::SetDisplayPosition ( double  p[3])
overridevirtual

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

Note that if the position is set outside of the bounding box, it will be clamped to the boundary of the bounding box. This method overloads the superclasses' SetWorldPosition() and SetDisplayPosition() in order to set the focal point of the cursor properly.

Reimplemented from vtkHandleRepresentation.

◆ SetTranslationMode()

virtual void vtkSphereHandleRepresentation::SetTranslationMode ( vtkTypeBool  )
virtual

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).

Otherwise, only the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button.)

◆ GetTranslationMode()

virtual vtkTypeBool vtkSphereHandleRepresentation::GetTranslationMode ( )
virtual

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).

Otherwise, only the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button.)

◆ TranslationModeOn()

virtual void vtkSphereHandleRepresentation::TranslationModeOn ( )
virtual

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).

Otherwise, only the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button.)

◆ TranslationModeOff()

virtual void vtkSphereHandleRepresentation::TranslationModeOff ( )
virtual

If translation mode is on, as the widget is moved the bounding box, shadows, and cursor are all translated simultaneously as the point moves (i.e., the left and middle mouse buttons act the same).

Otherwise, only the cursor focal point moves, which is constrained by the bounds of the point representation. (Note that the bounds can be scaled up using the right mouse button.)

◆ SetSphereRadius()

void vtkSphereHandleRepresentation::SetSphereRadius ( double  )

◆ GetSphereRadius()

double vtkSphereHandleRepresentation::GetSphereRadius ( )

◆ SetProperty()

void vtkSphereHandleRepresentation::SetProperty ( vtkProperty )

Set/Get the handle properties when unselected and selected.

◆ SetSelectedProperty()

void vtkSphereHandleRepresentation::SetSelectedProperty ( vtkProperty )

Set/Get the handle properties when unselected and selected.

◆ GetProperty()

virtual vtkProperty * vtkSphereHandleRepresentation::GetProperty ( )
virtual

Set/Get the handle properties when unselected and selected.

◆ GetSelectedProperty()

virtual vtkProperty * vtkSphereHandleRepresentation::GetSelectedProperty ( )
virtual

Set/Get the handle properties when unselected and selected.

◆ SetHotSpotSize()

virtual void vtkSphereHandleRepresentation::SetHotSpotSize ( double  )
virtual

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action.

Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

◆ GetHotSpotSize()

virtual double vtkSphereHandleRepresentation::GetHotSpotSize ( )
virtual

Set the "hot spot" size; i.e., the region around the focus, in which the motion vector is used to control the constrained sliding action.

Note the size is specified as a fraction of the length of the diagonal of the point widget's bounding box.

◆ SetHandleSize()

void vtkSphereHandleRepresentation::SetHandleSize ( double  size)
overridevirtual

Overload the superclasses SetHandleSize() method to update internal variables.

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double * vtkSphereHandleRepresentation::GetBounds ( )
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkProp.

◆ BuildRepresentation()

void vtkSphereHandleRepresentation::BuildRepresentation ( )
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Implements vtkWidgetRepresentation.

◆ StartWidgetInteraction()

void vtkSphereHandleRepresentation::StartWidgetInteraction ( double  eventPos[2])
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

void vtkSphereHandleRepresentation::WidgetInteraction ( double  eventPos[2])
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

◆ ComputeInteractionState()

int vtkSphereHandleRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
overridevirtual

Methods to make this class properly act like a vtkWidgetRepresentation.

Reimplemented from vtkWidgetRepresentation.

◆ PlaceWidget()

void vtkSphereHandleRepresentation::PlaceWidget ( double  bounds[6])
override

Methods to make this class properly act like a vtkWidgetRepresentation.

◆ ShallowCopy()

void vtkSphereHandleRepresentation::ShallowCopy ( vtkProp prop)
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

◆ DeepCopy()

void vtkSphereHandleRepresentation::DeepCopy ( vtkProp prop)
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkHandleRepresentation.

◆ GetActors()

void vtkSphereHandleRepresentation::GetActors ( vtkPropCollection )
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkSphereHandleRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkSphereHandleRepresentation::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

int vtkSphereHandleRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkSphereHandleRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkProp.

◆ Highlight()

void vtkSphereHandleRepresentation::Highlight ( int  highlight)
override

◆ RegisterPickers()

void vtkSphereHandleRepresentation::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

◆ SetVisibility()

void vtkSphereHandleRepresentation::SetVisibility ( vtkTypeBool  visible)
overridevirtual

Override to ensure that the internal actor's visibility is consistent with this representation's visibility.

Inconsistency between the two would cause issues in picking logic which relies on individual view prop visibility to determine whether the prop is pickable.

Reimplemented from vtkProp.

◆ Translate() [1/3]

void vtkSphereHandleRepresentation::Translate ( const double *  p1,
const double *  p2 
)
overrideprotectedvirtual

Translates world position by vector p1p2 projected on the constraint axis if any.

Reimplemented from vtkHandleRepresentation.

◆ Scale()

void vtkSphereHandleRepresentation::Scale ( const double *  p1,
const double *  p2,
const double  eventPos[2] 
)
protected

◆ MoveFocus()

void vtkSphereHandleRepresentation::MoveFocus ( const double *  p1,
const double *  p2 
)
protected

◆ SizeBounds()

void vtkSphereHandleRepresentation::SizeBounds ( )
protected

◆ CreateDefaultProperties()

void vtkSphereHandleRepresentation::CreateDefaultProperties ( )
protected

◆ Translate() [2/3]

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

Translates world position by vector p1p2 projected on the constraint axis if any.

Reimplemented from vtkHandleRepresentation.

◆ Translate() [3/3]

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

Translates world position by vector v projected on the constraint axis if any.

Reimplemented from vtkHandleRepresentation.

Member Data Documentation

◆ Actor

vtkActor* vtkSphereHandleRepresentation::Actor
protected

Definition at line 159 of file vtkSphereHandleRepresentation.h.

◆ Mapper

vtkPolyDataMapper* vtkSphereHandleRepresentation::Mapper
protected

Definition at line 160 of file vtkSphereHandleRepresentation.h.

◆ Sphere

vtkSphereSource* vtkSphereHandleRepresentation::Sphere
protected

Definition at line 161 of file vtkSphereHandleRepresentation.h.

◆ CursorPicker

vtkCellPicker* vtkSphereHandleRepresentation::CursorPicker
protected

Definition at line 165 of file vtkSphereHandleRepresentation.h.

◆ LastPickPosition

double vtkSphereHandleRepresentation::LastPickPosition[3]
protected

Definition at line 166 of file vtkSphereHandleRepresentation.h.

◆ LastEventPosition

double vtkSphereHandleRepresentation::LastEventPosition[2]
protected

Definition at line 167 of file vtkSphereHandleRepresentation.h.

◆ ConstraintAxis

int vtkSphereHandleRepresentation::ConstraintAxis
protected

Definition at line 170 of file vtkSphereHandleRepresentation.h.

◆ Property

vtkProperty* vtkSphereHandleRepresentation::Property
protected

Definition at line 178 of file vtkSphereHandleRepresentation.h.

◆ SelectedProperty

vtkProperty* vtkSphereHandleRepresentation::SelectedProperty
protected

Definition at line 179 of file vtkSphereHandleRepresentation.h.

◆ HotSpotSize

double vtkSphereHandleRepresentation::HotSpotSize
protected

Definition at line 183 of file vtkSphereHandleRepresentation.h.

◆ WaitingForMotion

int vtkSphereHandleRepresentation::WaitingForMotion
protected

Definition at line 184 of file vtkSphereHandleRepresentation.h.

◆ WaitCount

int vtkSphereHandleRepresentation::WaitCount
protected

Definition at line 185 of file vtkSphereHandleRepresentation.h.

◆ CurrentHandleSize

double vtkSphereHandleRepresentation::CurrentHandleSize
protected

Definition at line 188 of file vtkSphereHandleRepresentation.h.

◆ TranslationMode

vtkTypeBool vtkSphereHandleRepresentation::TranslationMode
protected

Definition at line 191 of file vtkSphereHandleRepresentation.h.


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