VTK
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkSphereWidget2 Class Reference

3D widget for manipulating a point on a sphere More...

#include <vtkSphereWidget2.h>

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

Public Member Functions

void SetRepresentation (vtkSphereRepresentation *r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
virtual void SetTranslationEnabled (int)
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual int GetTranslationEnabled ()
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual void TranslationEnabledOn ()
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual void TranslationEnabledOff ()
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual void SetScalingEnabled (int)
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual int GetScalingEnabled ()
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual void ScalingEnabledOn ()
 Control the behavior of the widget (i.e., how it processes events). More...
 
virtual void ScalingEnabledOff ()
 Control the behavior of the widget (i.e., how it processes events). More...
 
- Public Member Functions inherited from vtkAbstractWidget
void SetEnabled (int) override
 Methods for activating this widget. More...
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator. More...
 
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
 
void SetParent (vtkAbstractWidget *parent)
 Specifying a parent to this widget is used when creating composite widgets. More...
 
virtual vtkAbstractWidgetGetParent ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
virtual void SetProcessEvents (int)
 Methods to change whether the widget responds to interaction. More...
 
virtual int GetProcessEvents ()
 Methods to change whether the widget responds to interaction. More...
 
virtual void ProcessEventsOn ()
 Methods to change whether the widget responds to interaction. More...
 
virtual void ProcessEventsOff ()
 Methods to change whether the widget responds to interaction. More...
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
virtual void SetManagesCursor (int)
 Turn on or off the management of the cursor. More...
 
virtual int GetManagesCursor ()
 Turn on or off the management of the cursor. More...
 
virtual void ManagesCursorOn ()
 Turn on or off the management of the cursor. More...
 
virtual void ManagesCursorOff ()
 Turn on or off the management of the cursor. More...
 
vtkAbstractWidgetNewInstance () const
 Standard macros implementing standard VTK methods. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void OnChar ()
 Sets up the keypress-i event. More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 This method is used to associate the widget with the render window interactor. More...
 
virtual float GetPriority ()
 Set/Get the priority at which events are processed. 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...
 
virtual void SetPickingManaged (bool)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetKeyPressActivation (int)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual int GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual char GetKeyPressActivationValue ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
void ReleaseFocus ()
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkSphereWidget2New ()
 Instantiate the object. More...
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 Standard macros implementing standard VTK methods. More...
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 Standard macros implementing standard VTK methods. More...
 
- Static Public Member Functions inherited from vtkInteractorObserver
static int IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
 
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 Convenience methods for outside classes. More...
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 Convenience methods for outside classes. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

enum  _WidgetState { Start =0, Active }
 

Protected Member Functions

 vtkSphereWidget2 ()
 
 ~vtkSphereWidget2 () override
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget () override
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
virtual void PickersModified ()
 Update the pickers registered in the Picking Manager when pickers are modified. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer 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 picker, and return the assembly path. More...
 
int RequestCursorShape (int requestedShape)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction. More...
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 Helper method for subclasses. More...
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void TranslateAction (vtkAbstractWidget *)
 
static void ScaleAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 
- Static Protected Member Functions inherited from vtkInteractorObserver
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 Handles the char widget activation event. More...
 

Protected Attributes

int WidgetState
 
int TranslationEnabled
 
int ScalingEnabled
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
int KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkAbstractWidget Superclass
 Standard class methods for type information and printing. More...
 
static int IsTypeOf (const char *type)
 Standard class methods for type information and printing. More...
 
static vtkSphereWidget2SafeDownCast (vtkObjectBase *o)
 Standard class methods for type information and printing. More...
 
virtual int IsA (const char *type)
 Standard class methods for type information and printing. More...
 
vtkSphereWidget2NewInstance () const
 Standard class methods for type information and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard class methods for type information and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard class methods for type information and printing. More...
 

Additional Inherited Members

- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 Standard macros implementing standard VTK methods. More...
 
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass
 

Detailed Description

3D widget for manipulating a point on a sphere

This 3D widget interacts with a vtkSphereRepresentation class (i.e., it handles the events that drive its corresponding representation). It can be used to position a point on a sphere (for example, to place a light or camera), or to position a sphere in a scene, including translating and scaling the sphere.

A nice feature of vtkSphereWidget2, like any 3D widget, is that it will work in combination with the current interactor style (or any other interactor observer). That is, if vtkSphereWidget2 does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkSphereWidget2 will terminate the processing of the event that it handles.

To use this widget, you generally pair it with a vtkSphereRepresentation (or a subclass). Variuos options are available in the representation for controlling how the widget appears, and how the widget functions.

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
If the handle or sphere are selected:
  LeftButtonPressEvent - select the handle or sphere
  LeftButtonReleaseEvent - release the handle ot sphere
  MouseMoveEvent - move the handle or translate the sphere
In all the cases, independent of what is picked, the widget responds to the
following VTK events:
  MiddleButtonPressEvent - translate the representation
  MiddleButtonReleaseEvent - stop translating the representation
  RightButtonPressEvent - scale the widget's representation
  RightButtonReleaseEvent - stop scaling the representation
  MouseMoveEvent - scale (if right button) or move (if middle button) the widget
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkSphereWidget2's widget events:
  vtkWidgetEvent::Select -- some part of the widget has been selected
  vtkWidgetEvent::EndSelect -- the selection process has completed
  vtkWidgetEvent::Scale -- some part of the widget has been selected
  vtkWidgetEvent::EndScale -- the selection process has completed
  vtkWidgetEvent::Translate -- some part of the widget has been selected
  vtkWidgetEvent::EndTranslate -- the selection process has completed
  vtkWidgetEvent::Move -- a request for motion has been invoked
Event Bindings:
In turn, when these widget events are processed, the vtkSphereWidget2 invokes the following VTK events on itself (which observers can listen for):
  vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
  vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
  vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
Event Bindings:
This class, and the affiliated vtkSphereRepresentation, are second generation VTK widgets. An earlier version of this functionality was defined in the class vtkSphereWidget.
See also
vtkSphereRepresentation vtkSphereWidget
Tests:
vtkSphereWidget2 (Tests)

Definition at line 100 of file vtkSphereWidget2.h.

Member Typedef Documentation

Standard class methods for type information and printing.

Definition at line 112 of file vtkSphereWidget2.h.

Member Enumeration Documentation

Enumerator
Start 
Active 

Definition at line 149 of file vtkSphereWidget2.h.

Constructor & Destructor Documentation

vtkSphereWidget2::vtkSphereWidget2 ( )
protected
vtkSphereWidget2::~vtkSphereWidget2 ( )
overrideprotected

Member Function Documentation

static vtkSphereWidget2* vtkSphereWidget2::New ( )
static

Instantiate the object.

static int vtkSphereWidget2::IsTypeOf ( const char *  type)
static

Standard class methods for type information and printing.

virtual int vtkSphereWidget2::IsA ( const char *  type)
virtual

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

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

Standard class methods for type information and printing.

virtual vtkObjectBase* vtkSphereWidget2::NewInstanceInternal ( ) const
protectedvirtual

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

vtkSphereWidget2* vtkSphereWidget2::NewInstance ( ) const

Standard class methods for type information and printing.

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

Standard class methods for type information and printing.

Reimplemented from vtkAbstractWidget.

void vtkSphereWidget2::SetRepresentation ( vtkSphereRepresentation r)
inline

Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.

Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.

Definition at line 121 of file vtkSphereWidget2.h.

virtual void vtkSphereWidget2::SetTranslationEnabled ( int  )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual int vtkSphereWidget2::GetTranslationEnabled ( )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::TranslationEnabledOn ( )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::TranslationEnabledOff ( )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::SetScalingEnabled ( int  )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual int vtkSphereWidget2::GetScalingEnabled ( )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::ScalingEnabledOn ( )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

virtual void vtkSphereWidget2::ScalingEnabledOff ( )
virtual

Control the behavior of the widget (i.e., how it processes events).

Translation, and scaling can all be enabled and disabled.

void vtkSphereWidget2::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

By default, this is an instance of the vtkSphereRepresentation class.

Implements vtkAbstractWidget.

static void vtkSphereWidget2::SelectAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::EndSelectAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::TranslateAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::ScaleAction ( vtkAbstractWidget )
staticprotected
static void vtkSphereWidget2::MoveAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

int vtkSphereWidget2::WidgetState
protected

Definition at line 148 of file vtkSphereWidget2.h.

int vtkSphereWidget2::TranslationEnabled
protected

Definition at line 159 of file vtkSphereWidget2.h.

int vtkSphereWidget2::ScalingEnabled
protected

Definition at line 160 of file vtkSphereWidget2.h.


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