VTK  9.3.20240612
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCoordinateFrameWidget Class Reference

3D widget for manipulating a display sized coordinate frame widget More...

#include <vtkCoordinateFrameWidget.h>

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

Public Member Functions

void SetRepresentation (vtkCoordinateFrameRepresentation *rep)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
 
void SetEnabled (int enabling) override
 Methods for activating this widget.
 
vtkCoordinateFrameRepresentationGetCoordinateFrameRepresentation ()
 Return the representation as a vtkCoordinateFrameRepresentation.
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set.
 
- Public Member Functions inherited from vtkAbstractWidget
void SetEnabled (int) override
 Methods for activating this widget.
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator.
 
virtual void CreateDefaultRepresentation ()=0
 Create the default widget representation if one is not set.
 
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
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetEnabled (int)
 Methods for turning the interactor observer on and off, and determining its state.
 
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 void SetDefaultRenderer (vtkRenderer *)
 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 std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
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 vtkCoordinateFrameWidgetNew ()
 Instantiate the object.
 
- Static Public Member Functions inherited from vtkAbstractWidget
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 Types

enum  WidgetStateType { Start = 0 , Active }
 

Protected Member Functions

 vtkCoordinateFrameWidget ()
 
 ~vtkCoordinateFrameWidget () override
 
int UpdateCursorShape (int interactionState)
 Update the cursor shape based on the interaction state.
 
- 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
virtual vtkObjectBaseNewInstanceInternal () const
 
 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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void PickOriginAction (vtkAbstractWidget *)
 
static void PickNormalAction (vtkAbstractWidget *)
 
static void PickDirectionPointAction (vtkAbstractWidget *w)
 
static void TranslateAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
static void TranslationAxisLock (vtkAbstractWidget *)
 
static void TranslationAxisUnLock (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.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkCoordinateFrameWidgetInteractionCallback
 
typedef vtkAbstractWidget Superclass
 Standard vtkObject methods.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard vtkObject methods.
 
static vtkCoordinateFrameWidgetSafeDownCast (vtkObjectBase *o)
 Standard vtkObject methods.
 
virtual vtkTypeBool IsA (const char *type)
 Standard vtkObject methods.
 
vtkCoordinateFrameWidgetNewInstance () const
 Standard vtkObject methods.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard vtkObject methods.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard vtkObject methods.
 
vtkCoordinateFrameWidgetInteractionCallbackInteractionCallback
 Handle the interaction callback that may come from the representation.
 
void InvokeInteractionCallback ()
 Handle the interaction callback that may come from the representation.
 

Additional Inherited Members

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

Detailed Description

3D widget for manipulating a display sized coordinate frame widget

This 3D widget defines a display sized coordinate frame that can be interactively placed in a scene. The widget is assumed to consist of three parts: 1) an origin, 2) 3 axis normals which are rooted at the origin and 3 axis lockers. (The representation paired with this widget determines the actual geometry of the widget.)

To use this widget, you generally pair it with a vtkCoordinateFrameRepresentation (or a subclass). Various options are available for controlling how the representation 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 mouse is over the one of the axis normals:
  LeftButtonPressEvent - select normal
  LeftButtonReleaseEvent - release normal
  MouseMoveEvent - orient the axis normal vectors (possibly constrained to
  one of the axis' planes)
If the mouse is over the origin point (handle):
  LeftButtonPressEvent - select handle
  LeftButtonReleaseEvent - release handle (if selected)
  MouseMoveEvent - move the origin point (possibly constrained to one of the axis' planes)
If the mouse is over one of the axis lockers:
  LeftButtonPressEvent - select axis locker
  LeftButtonReleaseEvent - unlock/lock and axis locker (and unlock all the other lockers)
If the keypress characters are used
  'Down/Left' Move plane down
  'Up/Right' Move plane up
  'P/p' Pick a new origin from the intersection with a mesh cell rendered by the renderer
  'Ctrl' + 'P/p' Snap to a new origin from the closest mesh point rendered by the renderer
  'N/n' Pick a new normal from the intersection with a mesh cell rendered by the renderer
  'Ctrl' + 'N/n' Snap to a new normal from the closest mesh point rendered by the renderer
  'D/d' Pick a new point to define the direction normal which will be the new normal
  'Ctrl' + 'D/d' Snap to a new point to define the direction normal which will be the new normal
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkCoordinateFrameWidget'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 widget motion has been invoked
  vtkWidgetEvent::PickPoint -- PickOriginAction
  vtkWidgetEvent::PickNormal -- PickNormalAction
  vtkWidgetEvent::PickDirectionPoint -- PickDirectionPointAction
Event Bindings:
In turn, when these widget events are processed, the vtkCoordinateFrameWidget 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 vtkCoordinateFrameRepresentation, are next generation VTK widgets.
See also
vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitCylinderWidget, vtkImplicitPlaneWidget2 vtkDisplaySizedImplicitPlaneWidget
Events:
vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
Tests:
vtkCoordinateFrameWidget (Tests)

Definition at line 94 of file vtkCoordinateFrameWidget.h.

Member Typedef Documentation

◆ Superclass

Standard vtkObject methods.

Definition at line 109 of file vtkCoordinateFrameWidget.h.

Member Enumeration Documentation

◆ WidgetStateType

Enumerator
Start 
Active 

Definition at line 144 of file vtkCoordinateFrameWidget.h.

Constructor & Destructor Documentation

◆ vtkCoordinateFrameWidget()

vtkCoordinateFrameWidget::vtkCoordinateFrameWidget ( )
protected

◆ ~vtkCoordinateFrameWidget()

vtkCoordinateFrameWidget::~vtkCoordinateFrameWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCoordinateFrameWidget * vtkCoordinateFrameWidget::New ( )
static

Instantiate the object.

◆ IsTypeOf()

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

Standard vtkObject methods.

◆ IsA()

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

Standard vtkObject methods.

Reimplemented from vtkAbstractWidget.

◆ SafeDownCast()

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

Standard vtkObject methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCoordinateFrameWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard vtkObject methods.

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkCoordinateFrameWidget * vtkCoordinateFrameWidget::NewInstance ( ) const

Standard vtkObject methods.

◆ PrintSelf()

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

Standard vtkObject methods.

Reimplemented from vtkAbstractWidget.

◆ SetRepresentation()

void vtkCoordinateFrameWidget::SetRepresentation ( vtkCoordinateFrameRepresentation rep)

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.

◆ SetEnabled()

void vtkCoordinateFrameWidget::SetEnabled ( int  )
overridevirtual

Methods for activating this widget.

Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.

Reimplemented from vtkAbstractWidget.

◆ GetCoordinateFrameRepresentation()

vtkCoordinateFrameRepresentation * vtkCoordinateFrameWidget::GetCoordinateFrameRepresentation ( )
inline

Return the representation as a vtkCoordinateFrameRepresentation.

Definition at line 128 of file vtkCoordinateFrameWidget.h.

◆ CreateDefaultRepresentation()

void vtkCoordinateFrameWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SelectAction()

static void vtkCoordinateFrameWidget::SelectAction ( vtkAbstractWidget )
staticprotected

◆ PickOriginAction()

static void vtkCoordinateFrameWidget::PickOriginAction ( vtkAbstractWidget )
staticprotected

◆ PickNormalAction()

static void vtkCoordinateFrameWidget::PickNormalAction ( vtkAbstractWidget )
staticprotected

◆ PickDirectionPointAction()

static void vtkCoordinateFrameWidget::PickDirectionPointAction ( vtkAbstractWidget w)
staticprotected

◆ TranslateAction()

static void vtkCoordinateFrameWidget::TranslateAction ( vtkAbstractWidget )
staticprotected

◆ EndSelectAction()

static void vtkCoordinateFrameWidget::EndSelectAction ( vtkAbstractWidget )
staticprotected

◆ MoveAction()

static void vtkCoordinateFrameWidget::MoveAction ( vtkAbstractWidget )
staticprotected

◆ TranslationAxisLock()

static void vtkCoordinateFrameWidget::TranslationAxisLock ( vtkAbstractWidget )
staticprotected

◆ TranslationAxisUnLock()

static void vtkCoordinateFrameWidget::TranslationAxisUnLock ( vtkAbstractWidget )
staticprotected

◆ UpdateCursorShape()

int vtkCoordinateFrameWidget::UpdateCursorShape ( int  interactionState)
protected

Update the cursor shape based on the interaction state.

Returns 1 if the cursor shape requested is different from the existing one.

◆ InvokeInteractionCallback()

void vtkCoordinateFrameWidget::InvokeInteractionCallback ( )
protected

Handle the interaction callback that may come from the representation.

Friends And Related Symbol Documentation

◆ vtkCoordinateFrameWidgetInteractionCallback

friend class vtkCoordinateFrameWidgetInteractionCallback
friend

Definition at line 97 of file vtkCoordinateFrameWidget.h.

Member Data Documentation

◆ WidgetState

int vtkCoordinateFrameWidget::WidgetState
protected

Definition at line 143 of file vtkCoordinateFrameWidget.h.

◆ InteractionCallback

vtkCoordinateFrameWidgetInteractionCallback* vtkCoordinateFrameWidget::InteractionCallback
protected

Handle the interaction callback that may come from the representation.

Definition at line 171 of file vtkCoordinateFrameWidget.h.


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