VTK  9.6.20260326
vtkTrackballMultiRotate Class Reference

This camera manipulator combines the vtkTrackballRotate and vtkTrackballRoll manipulators in one. More...

#include <vtkTrackballMultiRotate.h>

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

Public Types

typedef vtkCameraManipulator Superclass
 
- Public Types inherited from vtkCameraManipulator
enum class  MouseButtonType { Left = 1 , Middle = 2 , Right = 3 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkTrackballMultiRotateNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void StartInteraction () override
 Unimplemented methods from vtkCameraManipulator.
 
void EndInteraction () override
 Unimplemented methods from vtkCameraManipulator.
 
void OnKeyDown (vtkRenderWindowInteractor *rwi) override
 Unimplemented methods from vtkCameraManipulator.
 
void OnKeyUp (vtkRenderWindowInteractor *rwi) override
 Unimplemented methods from vtkCameraManipulator.
 
void OnMouseMove (int x, int y, vtkRenderer *ren, vtkRenderWindowInteractor *rwi) override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse.
 
void OnButtonDown (int x, int y, vtkRenderer *ren, vtkRenderWindowInteractor *rwi) override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse.
 
void OnButtonUp (int x, int y, vtkRenderer *ren, vtkRenderWindowInteractor *rwi) override
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse.
 
- Public Member Functions inherited from vtkCameraManipulator
vtkCameraManipulatorNewInstance () const
 
 vtkSetEnumMacro (MouseButton, MouseButtonType)
 These settings determine which button the manipulator responds to.
 
 vtkGetEnumMacro (MouseButton, MouseButtonType)
 These settings determine which button the manipulator responds to.
 
virtual void SetAlt (bool)
 Set to true if this manipulator should respond when the Alt modifier is used.
 
virtual bool GetAlt ()
 Set to true if this manipulator should respond when the Alt modifier is used.
 
virtual void AltOn ()
 Set to true if this manipulator should respond when the Alt modifier is used.
 
virtual void AltOff ()
 Set to true if this manipulator should respond when the Alt modifier is used.
 
virtual void SetControl (bool)
 Set to true if this manipulator should respond when the Ctrl modifier is used.
 
virtual bool GetControl ()
 Set to true if this manipulator should respond when the Ctrl modifier is used.
 
virtual void ControlOn ()
 Set to true if this manipulator should respond when the Ctrl modifier is used.
 
virtual void ControlOff ()
 Set to true if this manipulator should respond when the Ctrl modifier is used.
 
virtual void SetShift (bool)
 Set to true if this manipulator should respond when the Shift modifier is used.
 
virtual bool GetShift ()
 Set to true if this manipulator should respond when the Shift modifier is used.
 
virtual void ShiftOn ()
 Set to true if this manipulator should respond when the Shift modifier is used.
 
virtual void ShiftOff ()
 Set to true if this manipulator should respond when the Shift modifier is used.
 
virtual void SetCenterOfRotation (double, double, double)
 Set and get the center of rotation in world coordinates.
 
virtual void SetCenterOfRotation (double[3])
 Set and get the center of rotation in world coordinates.
 
virtual double * GetCenterOfRotation ()
 Set and get the center of rotation in world coordinates.
 
virtual void GetCenterOfRotation (double &, double &, double &)
 Set and get the center of rotation in world coordinates.
 
virtual void GetCenterOfRotation (double[3])
 Set and get the center of rotation in world coordinates.
 
virtual void SetMouseMotionFactor (double)
 Set and get the mouse motion factor.
 
virtual double GetMouseMotionFactor ()
 Set and get the mouse motion factor.
 
virtual void SetManipulatorName (const char *)
 Set and get the manipulator name.
 
virtual char * GetManipulatorName ()
 Set and get the manipulator name.
 
- 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 RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTrackballMultiRotateSafeDownCast (vtkObjectBase *o)
 
static vtkTrackballMultiRotateNew ()
 
- Static Public Member Functions inherited from vtkCameraManipulator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCameraManipulatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTrackballMultiRotate ()
 
 ~vtkTrackballMultiRotate () override
 
- Protected Member Functions inherited from vtkCameraManipulator
 vtkCameraManipulator ()
 
 ~vtkCameraManipulator () override
 
void ComputeCenterOfRotationInDisplayCoordinates (vtkRenderer *ren)
 Compute the center of rotation in display coordinates.
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkCameraManipulator
double CenterOfRotationInDisplayCoordinates [2] = { 0.0, 0.0 }
 
- 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
 

Detailed Description

This camera manipulator combines the vtkTrackballRotate and vtkTrackballRoll manipulators in one.

Think of there being an invisible sphere in the middle of the screen. If you grab that sphere and move the mouse, you will rotate that sphere. However, if you grab outside that sphere and move the mouse, you will roll the view.

Tests:
vtkTrackballMultiRotate (Tests)

Definition at line 32 of file vtkTrackballMultiRotate.h.

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkTrackballMultiRotate()

vtkTrackballMultiRotate::vtkTrackballMultiRotate ( )
protected

◆ ~vtkTrackballMultiRotate()

vtkTrackballMultiRotate::~vtkTrackballMultiRotate ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

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

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

Reimplemented from vtkCameraManipulator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTrackballMultiRotate::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCameraManipulator.

◆ NewInstance()

vtkTrackballMultiRotate * vtkTrackballMultiRotate::NewInstance ( ) const

◆ New()

static vtkTrackballMultiRotate * vtkTrackballMultiRotate::New ( )
static

◆ PrintSelf()

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

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

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

Reimplemented from vtkCameraManipulator.

◆ StartInteraction()

void vtkTrackballMultiRotate::StartInteraction ( )
inlineoverridevirtual

Unimplemented methods from vtkCameraManipulator.

Implements vtkCameraManipulator.

Definition at line 43 of file vtkTrackballMultiRotate.h.

◆ EndInteraction()

void vtkTrackballMultiRotate::EndInteraction ( )
inlineoverridevirtual

Unimplemented methods from vtkCameraManipulator.

Implements vtkCameraManipulator.

Definition at line 44 of file vtkTrackballMultiRotate.h.

◆ OnKeyDown()

void vtkTrackballMultiRotate::OnKeyDown ( vtkRenderWindowInteractor * rwi)
inlineoverridevirtual

Unimplemented methods from vtkCameraManipulator.

Implements vtkCameraManipulator.

Definition at line 45 of file vtkTrackballMultiRotate.h.

◆ OnKeyUp()

void vtkTrackballMultiRotate::OnKeyUp ( vtkRenderWindowInteractor * rwi)
inlineoverridevirtual

Unimplemented methods from vtkCameraManipulator.

Implements vtkCameraManipulator.

Definition at line 46 of file vtkTrackballMultiRotate.h.

◆ OnMouseMove()

void vtkTrackballMultiRotate::OnMouseMove ( int x,
int y,
vtkRenderer * ren,
vtkRenderWindowInteractor * rwi )
overridevirtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Implements vtkCameraManipulator.

◆ OnButtonDown()

void vtkTrackballMultiRotate::OnButtonDown ( int x,
int y,
vtkRenderer * ren,
vtkRenderWindowInteractor * rwi )
overridevirtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Implements vtkCameraManipulator.

◆ OnButtonUp()

void vtkTrackballMultiRotate::OnButtonUp ( int x,
int y,
vtkRenderer * ren,
vtkRenderWindowInteractor * rwi )
overridevirtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

Implements vtkCameraManipulator.


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