VTK  9.6.20260315
vtkCameraOrientationWidget Class Reference

A widget to manipulate vtkCameraOrientationWidget. More...

#include <vtkCameraOrientationWidget.h>

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

Public Types

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

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Standard macros implementing standard VTK methods.
 
vtkCameraOrientationWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard macros implementing standard VTK methods.
 
void SetRepresentation (vtkCameraOrientationRepresentation *r)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
 
void CreateDefaultRepresentation () override
 Create a vtkCameraOrientationRepresentation.
 
void SquareResize ()
 Fits the widget's renderer to a square viewport.
 
void SetDefaultRenderer (vtkRenderer *renderer) override
 Override super class method for default renderer.
 
virtual void SetAnimate (bool)
 Enable jump-to-axis-view animation.
 
virtual bool GetAnimate ()
 Enable jump-to-axis-view animation.
 
virtual void AnimateOn ()
 Enable jump-to-axis-view animation.
 
virtual void AnimateOff ()
 Enable jump-to-axis-view animation.
 
virtual void SetAnimatorTotalFrames (int)
 Length of animation.
 
virtual int GetAnimatorTotalFrames ()
 Length of animation.
 
void SetParentRenderer (vtkRenderer *renderer)
 This widget shows and manipulates the orientation of the parent renderer's active camera.
 
vtkRendererGetParentRenderer ()
 This widget shows and manipulates the orientation of the parent renderer's active camera.
 
- Public Member Functions inherited from vtkAbstractWidget
void SetEnabled (int) override
 Methods for activating this widget.
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator.
 
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor.
 
void SetParent (vtkAbstractWidget *parent)
 Specifying a parent to this widget is used when creating composite widgets.
 
virtual vtkAbstractWidgetGetParent ()
 
void SetPriority (float) override
 Override the superclass method.
 
virtual void SetProcessEvents (vtkTypeBool)
 Methods to change whether the widget responds to interaction.
 
virtual vtkTypeBool GetProcessEvents ()
 Methods to change whether the widget responds to interaction.
 
virtual void ProcessEventsOn ()
 Methods to change whether the widget responds to interaction.
 
virtual void ProcessEventsOff ()
 Methods to change whether the widget responds to interaction.
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
 
virtual void SetManagesCursor (vtkTypeBool)
 Turn on or off the management of the cursor.
 
virtual vtkTypeBool GetManagesCursor ()
 Turn on or off the management of the cursor.
 
virtual void ManagesCursorOn ()
 Turn on or off the management of the cursor.
 
virtual void ManagesCursorOff ()
 Turn on or off the management of the cursor.
 
vtkAbstractWidgetNewInstance () const
 Standard macros implementing standard VTK methods.
 
- 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.
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void OnChar ()
 Sets up the keypress-i event.
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor.
 
virtual vtkRenderWindowInteractorGetInteractor ()
 This method is used to associate the widget with the render window interactor.
 
virtual float GetPriority ()
 Set/Get the priority at which events are processed.
 
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.
 
virtual 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 void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 
virtual vtkTypeBool GetKeyPressActivation ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 
virtual void KeyPressActivationOn ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 
virtual void KeyPressActivationOff ()
 Enable/Disable of the use of a keypress to turn on and off the interactor observer.
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
 
virtual char GetKeyPressActivationValue ()
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled).
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer.
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer.
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer.
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
 
void ReleaseFocus ()
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual 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 vtkCameraOrientationWidgetNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCameraOrientationWidgetSafeDownCast (vtkObjectBase *o)
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard macros implementing standard VTK methods.
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 Standard macros implementing standard VTK methods.
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool 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.
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 Convenience methods for outside classes.
 
- 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
 Standard macros implementing standard VTK methods.
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget () override
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int state)
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager.
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager.
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer 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 picker, and return the assembly path.
 
int RequestCursorShape (int requestedShape)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction.
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction.
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses.
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 Helper method for subclasses.
 
- 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 &)
 
enum class  WidgetStateType : int { Inactive , Hot , Active }
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera. More...
 
WidgetStateType WidgetState = WidgetStateType::Inactive
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
vtkWeakPointer< vtkRendererParentRenderer
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
vtkNew< vtkCameraInterpolatorCameraInterpolator
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
bool Animate = true
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
bool ShouldResetCamera = true
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
int AnimatorTotalFrames = 20
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
int AnimatorCurrentFrame = 0
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
int AnimationTimerId = -1
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
int ResizeObserverTag = -1
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
int ReorientObserverTag = -1
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
int AnimationTimerObserverTag = -1
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
virtual void SetShouldResetCamera (bool)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
virtual bool GetShouldResetCamera ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
virtual void ShouldResetCameraOn ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
virtual void ShouldResetCameraOff ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
 vtkCameraOrientationWidget ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
 ~vtkCameraOrientationWidget () override
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void ComputeWidgetState (int X, int Y, int modify=0)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void OrientParentCamera (double back[3], double up[3])
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void OrientWidgetRepresentation ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void InterpolateCamera (int t)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void StartAnimation ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void PlayAnimationSingleFrame (vtkObject *caller, unsigned long event, void *callData)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
void StopAnimation ()
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
static void SelectAction (vtkAbstractWidget *)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
static void EndSelectAction (vtkAbstractWidget *)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 
static void MoveAction (vtkAbstractWidget *)
 Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.
 

Additional Inherited Members

- 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.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
int LastDevice
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- 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

A widget to manipulate vtkCameraOrientationWidget.

This 3D widget creates and manages its own vtkCameraOrientationRepresentation. To use this widget, make sure you call SetParentRenderer() and enable the widget. The jump-to-axis-viewpoint feature is animated over 20 frames. See SetAnimatorTotalFrames() Turn off animation with AnimateOff()

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
LeftButtonPressEvent - select the appropriate handle
LeftButtonReleaseEvent - release the currently selected handle
If one of the six handles are selected:
  MouseMoveEvent - rotate (if left button) , else set hover representation for nearest handle.
These input events are not forwarded to any other observers. This widget eats up mouse events. (AbortFlagOn).
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator, which translates VTK events into the vtkCameraOrientationWidget's widget events:
  vtkWidgetEvent::Select -- some part of the widget has been selected
  vtkWidgetEvent::EndSelect -- the selection process has completed
  vtkWidgetEvent::Move -- a request for motion has been invoked
Event Bindings:
This class, and the affiliated vtkCameraOrientationRepresentation, are second generation VTK widgets.
See also
vtkCameraOrientationRepresentation
Examples:
vtkCameraOrientationWidget (Examples)
Online Examples:

Tests:
vtkCameraOrientationWidget (Tests)

Definition at line 171 of file vtkCameraOrientationWidget.h.

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ WidgetStateType

enum class vtkCameraOrientationWidget::WidgetStateType : int
strongprotected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Enumerator
Inactive 
Hot 
Active 

Definition at line 262 of file vtkCameraOrientationWidget.h.

Constructor & Destructor Documentation

◆ vtkCameraOrientationWidget()

vtkCameraOrientationWidget::vtkCameraOrientationWidget ( )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ ~vtkCameraOrientationWidget()

vtkCameraOrientationWidget::~vtkCameraOrientationWidget ( )
overrideprotected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Member Function Documentation

◆ New()

static vtkCameraOrientationWidget * vtkCameraOrientationWidget::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCameraOrientationWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkCameraOrientationWidget * vtkCameraOrientationWidget::NewInstance ( ) const

◆ PrintSelf()

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

Standard macros implementing standard VTK methods.

Reimplemented from vtkAbstractWidget.

◆ SetAnimate()

virtual void vtkCameraOrientationWidget::SetAnimate ( bool )
virtual

Enable jump-to-axis-view animation.

See AnimatorTotalFrames.

◆ GetAnimate()

virtual bool vtkCameraOrientationWidget::GetAnimate ( )
virtual

Enable jump-to-axis-view animation.

See AnimatorTotalFrames.

◆ AnimateOn()

virtual void vtkCameraOrientationWidget::AnimateOn ( )
virtual

Enable jump-to-axis-view animation.

See AnimatorTotalFrames.

◆ AnimateOff()

virtual void vtkCameraOrientationWidget::AnimateOff ( )
virtual

Enable jump-to-axis-view animation.

See AnimatorTotalFrames.

◆ SetAnimatorTotalFrames()

virtual void vtkCameraOrientationWidget::SetAnimatorTotalFrames ( int )
virtual

Length of animation.

(in frames)

◆ GetAnimatorTotalFrames()

virtual int vtkCameraOrientationWidget::GetAnimatorTotalFrames ( )
virtual

Length of animation.

(in frames)

◆ SetRepresentation()

void vtkCameraOrientationWidget::SetRepresentation ( vtkCameraOrientationRepresentation * r)

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 independently of the widget.

◆ CreateDefaultRepresentation()

void vtkCameraOrientationWidget::CreateDefaultRepresentation ( )
overridevirtual

◆ SquareResize()

void vtkCameraOrientationWidget::SquareResize ( )

Fits the widget's renderer to a square viewport.

◆ SetDefaultRenderer()

void vtkCameraOrientationWidget::SetDefaultRenderer ( vtkRenderer * renderer)
overridevirtual

Override super class method for default renderer.

This widget adds the representation props into the default renderer.

Reimplemented from vtkInteractorObserver.

◆ SetParentRenderer()

void vtkCameraOrientationWidget::SetParentRenderer ( vtkRenderer * renderer)

This widget shows and manipulates the orientation of the parent renderer's active camera.

Note: The renderer must be part of a render window for the widget to appear.

◆ GetParentRenderer()

vtkRenderer * vtkCameraOrientationWidget::GetParentRenderer ( )

This widget shows and manipulates the orientation of the parent renderer's active camera.

Note: The renderer must be part of a render window for the widget to appear.

◆ SetShouldResetCamera()

virtual void vtkCameraOrientationWidget::SetShouldResetCamera ( bool )
virtual

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ GetShouldResetCamera()

virtual bool vtkCameraOrientationWidget::GetShouldResetCamera ( )
virtual

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ ShouldResetCameraOn()

virtual void vtkCameraOrientationWidget::ShouldResetCameraOn ( )
virtual

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ ShouldResetCameraOff()

virtual void vtkCameraOrientationWidget::ShouldResetCameraOff ( )
virtual

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ ComputeWidgetState()

void vtkCameraOrientationWidget::ComputeWidgetState ( int X,
int Y,
int modify = 0 )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ SelectAction()

static void vtkCameraOrientationWidget::SelectAction ( vtkAbstractWidget * )
staticprotected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ EndSelectAction()

static void vtkCameraOrientationWidget::EndSelectAction ( vtkAbstractWidget * )
staticprotected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ MoveAction()

static void vtkCameraOrientationWidget::MoveAction ( vtkAbstractWidget * )
staticprotected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ OrientParentCamera()

void vtkCameraOrientationWidget::OrientParentCamera ( double back[3],
double up[3] )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ OrientWidgetRepresentation()

void vtkCameraOrientationWidget::OrientWidgetRepresentation ( )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ InterpolateCamera()

void vtkCameraOrientationWidget::InterpolateCamera ( int t)
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ StartAnimation()

void vtkCameraOrientationWidget::StartAnimation ( )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ PlayAnimationSingleFrame()

void vtkCameraOrientationWidget::PlayAnimationSingleFrame ( vtkObject * caller,
unsigned long event,
void * callData )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

◆ StopAnimation()

void vtkCameraOrientationWidget::StopAnimation ( )
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Member Data Documentation

◆ WidgetState

WidgetStateType vtkCameraOrientationWidget::WidgetState = WidgetStateType::Inactive
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 268 of file vtkCameraOrientationWidget.h.

◆ ParentRenderer

vtkWeakPointer<vtkRenderer> vtkCameraOrientationWidget::ParentRenderer
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 270 of file vtkCameraOrientationWidget.h.

◆ CameraInterpolator

vtkNew<vtkCameraInterpolator> vtkCameraOrientationWidget::CameraInterpolator
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 273 of file vtkCameraOrientationWidget.h.

◆ Animate

bool vtkCameraOrientationWidget::Animate = true
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 275 of file vtkCameraOrientationWidget.h.

◆ ShouldResetCamera

bool vtkCameraOrientationWidget::ShouldResetCamera = true
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 276 of file vtkCameraOrientationWidget.h.

◆ AnimatorTotalFrames

int vtkCameraOrientationWidget::AnimatorTotalFrames = 20
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 277 of file vtkCameraOrientationWidget.h.

◆ AnimatorCurrentFrame

int vtkCameraOrientationWidget::AnimatorCurrentFrame = 0
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 278 of file vtkCameraOrientationWidget.h.

◆ AnimationTimerId

int vtkCameraOrientationWidget::AnimationTimerId = -1
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 279 of file vtkCameraOrientationWidget.h.

◆ ResizeObserverTag

int vtkCameraOrientationWidget::ResizeObserverTag = -1
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 281 of file vtkCameraOrientationWidget.h.

◆ ReorientObserverTag

int vtkCameraOrientationWidget::ReorientObserverTag = -1
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 282 of file vtkCameraOrientationWidget.h.

◆ AnimationTimerObserverTag

int vtkCameraOrientationWidget::AnimationTimerObserverTag = -1
protected

Enable/disable resetting the camera to the bounds of the scene after reorienting the camera.

Default is true.

Definition at line 283 of file vtkCameraOrientationWidget.h.


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