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

create a moving, magnifying renderer that can inspect the contents of an encapsulating renderer. More...

#include <vtkMagnifierWidget.h>

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

Public Member Functions

void SetRepresentation (vtkMagnifierRepresentation *r)
 Specify an instance of vtkMagnifierRepresentation used to represent this widget in the scene. More...
 
vtkMagnifierRepresentationGetMagnifierRepresentation ()
 Return the representation as a vtkBorderRepresentation. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
void SetEnabled (int enabling) override
 Override superclasses' SetEnabled() method because the this widget must activate the representation. More...
 
virtual void SetKeyPressIncreaseValue (char)
 By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification. More...
 
virtual char GetKeyPressIncreaseValue ()
 By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification. More...
 
virtual void SetKeyPressDecreaseValue (char)
 By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification. More...
 
virtual char GetKeyPressDecreaseValue ()
 By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification. More...
 
- Public Member Functions inherited from vtkAbstractWidget
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 (vtkTypeBool)
 Methods to change whether the widget responds to interaction. More...
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Turn on or off the management of the cursor. More...
 
virtual vtkTypeBool 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 managed)
 Enable/Disable the use of a manager to process the picking. More...
 
virtual bool GetPickingManaged ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool 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=nullptr)
 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 ()
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkMagnifierWidgetNew ()
 Method to instantiate class. More...
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool 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 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. 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Types

enum  _WidgetState { Invisible = 0, Visible }
 

Protected Member Functions

 vtkMagnifierWidget ()
 
 ~vtkMagnifierWidget () 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...
 
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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void MoveAction (vtkAbstractWidget *)
 
static void CharAction (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...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

char KeyPressIncreaseValue
 
char KeyPressDecreaseValue
 
int WidgetState
 
- 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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkAbstractWidget Superclass
 Standard methods for class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for class. More...
 
static vtkMagnifierWidgetSafeDownCast (vtkObjectBase *o)
 Standard methods for class. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for class. More...
 
vtkMagnifierWidgetNewInstance () const
 Standard methods for class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for class. 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

create a moving, magnifying renderer that can inspect the contents of an encapsulating renderer.

This class provides a small, interactive, overlayed viewport (i.e., renderer) that follows the mouse while inside another, larger renderer. Inside this viewport effects like magnification (via zoom or adjustment of the view angle), or other rendering effects are possible.

To use this widget, pair it with a representation (which provides options like a border and so on). In the representation, indicate what renderer with which the magnifier is associated. Optionally, a list of actors can be provided to the magnifier so that it only renders the actors specified (this is useful for removing objects like widgets from the scene, or creating separate pipelines for creating special effects).

By default, the magnifier responds to the keypress "m" to toggle between showing/hiding the magnifier. Internally, it also follows mouse move events to track the magnifier with the mouse motion. Finally, using the "-" or "+" keys can be used to decrease/increase the magnification factor by observing the "vtkCommand::WidgetValueChangedEvent".

See also
vtkMagnifierRepresentation
Events:
vtkCommand::WidgetValueChangedEvent
Tests:
vtkMagnifierWidget (Tests)

Definition at line 56 of file vtkMagnifierWidget.h.

Member Typedef Documentation

◆ Superclass

Standard methods for class.

Definition at line 68 of file vtkMagnifierWidget.h.

Member Enumeration Documentation

◆ _WidgetState

Enumerator
Invisible 
Visible 

Definition at line 127 of file vtkMagnifierWidget.h.

Constructor & Destructor Documentation

◆ vtkMagnifierWidget()

vtkMagnifierWidget::vtkMagnifierWidget ( )
protected

◆ ~vtkMagnifierWidget()

vtkMagnifierWidget::~vtkMagnifierWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkMagnifierWidget* vtkMagnifierWidget::New ( )
static

Method to instantiate class.

◆ IsTypeOf()

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

Standard methods for class.

◆ IsA()

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

Standard methods for class.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

Standard methods for class.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkMagnifierWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for class.

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkMagnifierWidget* vtkMagnifierWidget::NewInstance ( ) const

Standard methods for class.

◆ PrintSelf()

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

Standard methods for class.

Reimplemented from vtkAbstractWidget.

◆ SetRepresentation()

void vtkMagnifierWidget::SetRepresentation ( vtkMagnifierRepresentation r)
inline

Specify an instance of vtkMagnifierRepresentation 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 77 of file vtkMagnifierWidget.h.

◆ GetMagnifierRepresentation()

vtkMagnifierRepresentation* vtkMagnifierWidget::GetMagnifierRepresentation ( )
inline

Return the representation as a vtkBorderRepresentation.

Definition at line 85 of file vtkMagnifierWidget.h.

◆ CreateDefaultRepresentation()

void vtkMagnifierWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SetEnabled()

void vtkMagnifierWidget::SetEnabled ( int  enabling)
overridevirtual

Override superclasses' SetEnabled() method because the this widget must activate the representation.

Reimplemented from vtkAbstractWidget.

◆ SetKeyPressIncreaseValue()

virtual void vtkMagnifierWidget::SetKeyPressIncreaseValue ( char  )
virtual

By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification.

These can be changed to other key press values. Note that in either case, these keypresses cause the widget to emit the "vtkCommand::WidgetValueChangedEvent".

◆ GetKeyPressIncreaseValue()

virtual char vtkMagnifierWidget::GetKeyPressIncreaseValue ( )
virtual

By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification.

These can be changed to other key press values. Note that in either case, these keypresses cause the widget to emit the "vtkCommand::WidgetValueChangedEvent".

◆ SetKeyPressDecreaseValue()

virtual void vtkMagnifierWidget::SetKeyPressDecreaseValue ( char  )
virtual

By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification.

These can be changed to other key press values. Note that in either case, these keypresses cause the widget to emit the "vtkCommand::WidgetValueChangedEvent".

◆ GetKeyPressDecreaseValue()

virtual char vtkMagnifierWidget::GetKeyPressDecreaseValue ( )
virtual

By default, the keypress "+" increases magnification, and the keypress "-" decreases magnification.

These can be changed to other key press values. Note that in either case, these keypresses cause the widget to emit the "vtkCommand::WidgetValueChangedEvent".

◆ MoveAction()

static void vtkMagnifierWidget::MoveAction ( vtkAbstractWidget )
staticprotected

◆ CharAction()

static void vtkMagnifierWidget::CharAction ( vtkAbstractWidget )
staticprotected

Member Data Documentation

◆ KeyPressIncreaseValue

char vtkMagnifierWidget::KeyPressIncreaseValue
protected

Definition at line 119 of file vtkMagnifierWidget.h.

◆ KeyPressDecreaseValue

char vtkMagnifierWidget::KeyPressDecreaseValue
protected

Definition at line 120 of file vtkMagnifierWidget.h.

◆ WidgetState

int vtkMagnifierWidget::WidgetState
protected

Definition at line 126 of file vtkMagnifierWidget.h.


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