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

2D widget for manipulating a marker prop More...

#include <vtkOrientationMarkerWidget.h>

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

Public Types

typedef vtkInteractorObserver Superclass
 
- Public Types inherited from vtkInteractorObserver
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. More...
 
vtkOrientationMarkerWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetEnabled (int) override
 Enable/disable the widget. More...
 
void ExecuteCameraUpdateEvent (vtkObject *o, unsigned long event, void *calldata)
 Callback to keep the camera for the orientation marker up to date with the camera in the parent renderer. More...
 
virtual void SetOrientationMarker (vtkProp *prop)
 Set/get the orientation marker to be displayed in this widget. More...
 
virtual vtkPropGetOrientationMarker ()
 Set/get the orientation marker to be displayed in this widget. More...
 
void SetInteractive (vtkTypeBool interact)
 Set/get whether to allow this widget to be interactively moved/scaled. More...
 
virtual vtkTypeBool GetInteractive ()
 Set/get whether to allow this widget to be interactively moved/scaled. More...
 
virtual void InteractiveOn ()
 Set/get whether to allow this widget to be interactively moved/scaled. More...
 
virtual void InteractiveOff ()
 Set/get whether to allow this widget to be interactively moved/scaled. More...
 
void SetOutlineColor (double r, double g, double b)
 Set/get the color of the outline of this widget. More...
 
double * GetOutlineColor ()
 Set/get the color of the outline of this widget. More...
 
virtual void SetViewport (double, double, double, double)
 Set/get the viewport to position/size this widget. More...
 
virtual void SetViewport (double[4])
 Set/get the viewport to position/size this widget. More...
 
virtual double * GetViewport ()
 Set/get the viewport to position/size this widget. More...
 
virtual void GetViewport (double &, double &, double &, double &)
 Set/get the viewport to position/size this widget. More...
 
virtual void GetViewport (double[4])
 Set/get the viewport to position/size this widget. More...
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...
 
virtual int GetTolerance ()
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...
 
virtual void SetZoom (double)
 The zoom factor to modify the size of the marker within the widget. More...
 
virtual double GetZoom ()
 The zoom factor to modify the size of the marker within the widget. More...
 
void Modified () override
 Need to reimplement this->Modified() because of the vtkSetVector4Macro/vtkGetVector4Macro use. More...
 
void EndInteraction () override
 Ends any in progress interaction and resets border visibility. More...
 
void SetShouldConstrainSize (vtkTypeBool shouldConstrainSize)
 Set/get whether the widget should constrain the size to be within the min and max limits. More...
 
virtual vtkTypeBool GetShouldConstrainSize ()
 Set/get whether the widget should constrain the size to be within the min and max limits. More...
 
bool SetSizeConstraintDimensionSizes (int minDimensionSize, int maxDimensionSize)
 Sets the minimum and maximum dimension (width and height) size limits for the widget. More...
 
virtual int GetMinDimensionSize ()
 Returns the minimum dimension (width and height) size limit in pixels for the widget. More...
 
virtual int GetMaxDimensionSize ()
 Returns the maximum dimension (width and height) size limit in pixels for the widget. 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 void SetPriority (float)
 Set/Get the priority at which events are processed. 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 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. 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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkOrientationMarkerWidgetNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOrientationMarkerWidgetSafeDownCast (vtkObjectBase *o)
 
- 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 (vtkTypeBool 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 vtkTypeBool 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 {
  Outside = 0 , Inside , Translating , AdjustingP1 ,
  AdjustingP2 , AdjustingP3 , AdjustingP4
}
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOrientationMarkerWidget ()
 
 ~vtkOrientationMarkerWidget () override
 
virtual void OnLeftButtonDown ()
 
virtual void OnLeftButtonUp ()
 
virtual void OnMouseMove ()
 
virtual int ComputeStateBasedOnPosition (int X, int Y, int *pos1, int *pos2)
 
virtual void SetCursor (int state)
 
void MoveWidget (int X, int Y)
 
void ResizeTopLeft (int X, int Y)
 
void ResizeTopRight (int X, int Y)
 
void ResizeBottomLeft (int X, int Y)
 
void ResizeBottomRight (int X, int Y)
 
void SquareRenderer ()
 
void UpdateOutline ()
 
void UpdateViewport ()
 
void UpdateInternalViewport ()
 
void ResizeToFitSizeConstraints ()
 
- 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...
 
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 ProcessEvents (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

vtkRendererRenderer
 
vtkPropOrientationMarker
 
vtkPolyDataOutline
 
vtkActor2DOutlineActor
 
unsigned long StartEventObserverId
 
vtkOrientationMarkerWidgetObserver * Observer
 
vtkTypeBool Interactive
 
int Tolerance
 
int Moving
 
double Zoom = 1.0
 
double Viewport [4]
 
int StartPosition [2]
 
int State
 
vtkTypeBool ShouldConstrainSize = 0
 
int MinDimensionSize = 20
 
int MaxDimensionSize = 500
 
- 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

2D widget for manipulating a marker prop

This class provides support for interactively manipulating the position, size, and apparent orientation of a prop that represents an orientation marker. This class works by adding its internal renderer to an external "parent" renderer on a different layer. The input orientation marker is rendered as an overlay on the parent renderer and, thus, appears superposed over all props in the parent's scene. The camera view of the orientation the marker is made to match that of the parent's by means of an observer mechanism, giving the illusion that the orientation of the marker reflects that of the prop(s) in the parent's scene.

The widget listens to left mouse button and mouse movement events. It will change the cursor shape based on its location. If the cursor is over the overlay renderer, it will change the cursor shape to a SIZEALL shape or to a resize corner shape (e.g., SIZENW) if the cursor is near a corner. If the left mouse button is pressed and held down while moving, the overlay renderer, and hence, the orientation marker, is resized or moved. I the case of a resize operation, releasing the left mouse button causes the widget to enforce its renderer to be square. The diagonally opposite corner to the one moved is repositioned such that all edges of the renderer have the same length: the minimum.

To use this object, there are two key steps: 1) invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor, and 2) invoke SetOrientationMarker with an instance of vtkProp (see caveats below). Specifically, vtkAxesActor and vtkAnnotatedCubeActor are two classes designed to work with this class. A composite orientation marker can be generated by adding instances of vtkAxesActor and vtkAnnotatedCubeActor to a vtkPropAssembly, which can then be set as the input orientation marker. The widget can be also be set up in a non-interactive fashion by setting Ineractive to Off and sizing/placing the overlay renderer in its parent renderer by calling the widget's SetViewport method.

Thanks:
This class was based originally on Paraview's vtkPVAxesWidget.
Warning
The input orientation marker prop should calculate its bounds as though they are symmetric about it's origin. This must currently be done to correctly implement the camera synchronization between the ivar renderer and the renderer associated with the set interactor. Importantly, the InteractorStyle associated with the interactor must be of the type vtkInteractorStyle*Camera. Where desirable, the parent renderer should be set by the SetDefaultRenderer method. The parent renderer's number of layers is modified to 2 where required.
See also
vtkInteractorObserver vtkXYPlotWidget vtkScalarBarWidget vtkAxesActor vtkAnnotatedCubeActor
Events:
vtkCommand::DisableEvent vtkCommand::EnableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent
Online Examples:

Tests:
vtkOrientationMarkerWidget (Tests)

Definition at line 185 of file vtkOrientationMarkerWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 189 of file vtkOrientationMarkerWidget.h.

Member Enumeration Documentation

◆ WidgetState

Enumerator
Outside 
Inside 
Translating 
AdjustingP1 
AdjustingP2 
AdjustingP3 
AdjustingP4 

Definition at line 350 of file vtkOrientationMarkerWidget.h.

Constructor & Destructor Documentation

◆ vtkOrientationMarkerWidget()

vtkOrientationMarkerWidget::vtkOrientationMarkerWidget ( )
protected

◆ ~vtkOrientationMarkerWidget()

vtkOrientationMarkerWidget::~vtkOrientationMarkerWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOrientationMarkerWidget* vtkOrientationMarkerWidget::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOrientationMarkerWidget::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 vtkInteractorObserver.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOrientationMarkerWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkInteractorObserver.

◆ NewInstance()

vtkOrientationMarkerWidget* vtkOrientationMarkerWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkOrientationMarkerWidget::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 vtkObject.

◆ SetOrientationMarker()

virtual void vtkOrientationMarkerWidget::SetOrientationMarker ( vtkProp prop)
virtual

Set/get the orientation marker to be displayed in this widget.

◆ GetOrientationMarker()

virtual vtkProp* vtkOrientationMarkerWidget::GetOrientationMarker ( )
virtual

Set/get the orientation marker to be displayed in this widget.

◆ SetEnabled()

void vtkOrientationMarkerWidget::SetEnabled ( int  )
overridevirtual

Enable/disable the widget.

Default is 0 (disabled).

Reimplemented from vtkInteractorObserver.

◆ ExecuteCameraUpdateEvent()

void vtkOrientationMarkerWidget::ExecuteCameraUpdateEvent ( vtkObject o,
unsigned long  event,
void *  calldata 
)

Callback to keep the camera for the orientation marker up to date with the camera in the parent renderer.

◆ SetInteractive()

void vtkOrientationMarkerWidget::SetInteractive ( vtkTypeBool  interact)

Set/get whether to allow this widget to be interactively moved/scaled.

Default is On.

◆ GetInteractive()

virtual vtkTypeBool vtkOrientationMarkerWidget::GetInteractive ( )
virtual

Set/get whether to allow this widget to be interactively moved/scaled.

Default is On.

◆ InteractiveOn()

virtual void vtkOrientationMarkerWidget::InteractiveOn ( )
virtual

Set/get whether to allow this widget to be interactively moved/scaled.

Default is On.

◆ InteractiveOff()

virtual void vtkOrientationMarkerWidget::InteractiveOff ( )
virtual

Set/get whether to allow this widget to be interactively moved/scaled.

Default is On.

◆ SetOutlineColor()

void vtkOrientationMarkerWidget::SetOutlineColor ( double  r,
double  g,
double  b 
)

Set/get the color of the outline of this widget.

The outline is visible when (in interactive mode) the cursor is over this widget. Default is white (1,1,1).

◆ GetOutlineColor()

double* vtkOrientationMarkerWidget::GetOutlineColor ( )

Set/get the color of the outline of this widget.

The outline is visible when (in interactive mode) the cursor is over this widget. Default is white (1,1,1).

◆ SetViewport() [1/2]

virtual void vtkOrientationMarkerWidget::SetViewport ( double  ,
double  ,
double  ,
double   
)
virtual

Set/get the viewport to position/size this widget.

Coordinates are expressed as (xmin,ymin,xmax,ymax), where each coordinate is 0 <= coordinate <= 1.0. Default is bottom left corner (0,0,0.2,0.2). Note that this viewport is scaled with respect to the viewport of the current renderer i.e. if the viewport of the current renderer is (0.5, 0.5, 0.75, 0.75) and Viewport is set to (0, 0, 1, 1), the orientation marker will be confined to a viewport of (0.5, 0.5, 0.75, 0.75) in the render window.

See also
SetCurrentRenderer()

◆ SetViewport() [2/2]

virtual void vtkOrientationMarkerWidget::SetViewport ( double  [4])
virtual

Set/get the viewport to position/size this widget.

Coordinates are expressed as (xmin,ymin,xmax,ymax), where each coordinate is 0 <= coordinate <= 1.0. Default is bottom left corner (0,0,0.2,0.2). Note that this viewport is scaled with respect to the viewport of the current renderer i.e. if the viewport of the current renderer is (0.5, 0.5, 0.75, 0.75) and Viewport is set to (0, 0, 1, 1), the orientation marker will be confined to a viewport of (0.5, 0.5, 0.75, 0.75) in the render window.

See also
SetCurrentRenderer()

◆ GetViewport() [1/3]

virtual double* vtkOrientationMarkerWidget::GetViewport ( )
virtual

Set/get the viewport to position/size this widget.

Coordinates are expressed as (xmin,ymin,xmax,ymax), where each coordinate is 0 <= coordinate <= 1.0. Default is bottom left corner (0,0,0.2,0.2). Note that this viewport is scaled with respect to the viewport of the current renderer i.e. if the viewport of the current renderer is (0.5, 0.5, 0.75, 0.75) and Viewport is set to (0, 0, 1, 1), the orientation marker will be confined to a viewport of (0.5, 0.5, 0.75, 0.75) in the render window.

See also
SetCurrentRenderer()

◆ GetViewport() [2/3]

virtual void vtkOrientationMarkerWidget::GetViewport ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

Set/get the viewport to position/size this widget.

Coordinates are expressed as (xmin,ymin,xmax,ymax), where each coordinate is 0 <= coordinate <= 1.0. Default is bottom left corner (0,0,0.2,0.2). Note that this viewport is scaled with respect to the viewport of the current renderer i.e. if the viewport of the current renderer is (0.5, 0.5, 0.75, 0.75) and Viewport is set to (0, 0, 1, 1), the orientation marker will be confined to a viewport of (0.5, 0.5, 0.75, 0.75) in the render window.

See also
SetCurrentRenderer()

◆ GetViewport() [3/3]

virtual void vtkOrientationMarkerWidget::GetViewport ( double  [4])
virtual

Set/get the viewport to position/size this widget.

Coordinates are expressed as (xmin,ymin,xmax,ymax), where each coordinate is 0 <= coordinate <= 1.0. Default is bottom left corner (0,0,0.2,0.2). Note that this viewport is scaled with respect to the viewport of the current renderer i.e. if the viewport of the current renderer is (0.5, 0.5, 0.75, 0.75) and Viewport is set to (0, 0, 1, 1), the orientation marker will be confined to a viewport of (0.5, 0.5, 0.75, 0.75) in the render window.

See also
SetCurrentRenderer()

◆ SetTolerance()

virtual void vtkOrientationMarkerWidget::SetTolerance ( int  )
virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

◆ GetTolerance()

virtual int vtkOrientationMarkerWidget::GetTolerance ( )
virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

◆ SetZoom()

virtual void vtkOrientationMarkerWidget::SetZoom ( double  )
virtual

The zoom factor to modify the size of the marker within the widget.

Default is 1.0.

◆ GetZoom()

virtual double vtkOrientationMarkerWidget::GetZoom ( )
virtual

The zoom factor to modify the size of the marker within the widget.

Default is 1.0.

◆ Modified()

void vtkOrientationMarkerWidget::Modified ( )
overridevirtual

Need to reimplement this->Modified() because of the vtkSetVector4Macro/vtkGetVector4Macro use.

Reimplemented from vtkObject.

◆ EndInteraction()

void vtkOrientationMarkerWidget::EndInteraction ( )
overridevirtual

Ends any in progress interaction and resets border visibility.

Reimplemented from vtkInteractorObserver.

◆ SetShouldConstrainSize()

void vtkOrientationMarkerWidget::SetShouldConstrainSize ( vtkTypeBool  shouldConstrainSize)

Set/get whether the widget should constrain the size to be within the min and max limits.

Default is off (unconstrained).

◆ GetShouldConstrainSize()

virtual vtkTypeBool vtkOrientationMarkerWidget::GetShouldConstrainSize ( )
virtual

Set/get whether the widget should constrain the size to be within the min and max limits.

Default is off (unconstrained).

◆ SetSizeConstraintDimensionSizes()

bool vtkOrientationMarkerWidget::SetSizeConstraintDimensionSizes ( int  minDimensionSize,
int  maxDimensionSize 
)

Sets the minimum and maximum dimension (width and height) size limits for the widget.

Validates the sizes are within tolerances before setting; ignoring otherwise. Default is 20, 500. Returns whether the sizes are valid and correctly set (true), or invalid (false).

◆ GetMinDimensionSize()

virtual int vtkOrientationMarkerWidget::GetMinDimensionSize ( )
virtual

Returns the minimum dimension (width and height) size limit in pixels for the widget.

◆ GetMaxDimensionSize()

virtual int vtkOrientationMarkerWidget::GetMaxDimensionSize ( )
virtual

Returns the maximum dimension (width and height) size limit in pixels for the widget.

◆ ProcessEvents()

static void vtkOrientationMarkerWidget::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected

◆ OnLeftButtonDown()

virtual void vtkOrientationMarkerWidget::OnLeftButtonDown ( )
protectedvirtual

◆ OnLeftButtonUp()

virtual void vtkOrientationMarkerWidget::OnLeftButtonUp ( )
protectedvirtual

◆ OnMouseMove()

virtual void vtkOrientationMarkerWidget::OnMouseMove ( )
protectedvirtual

◆ ComputeStateBasedOnPosition()

virtual int vtkOrientationMarkerWidget::ComputeStateBasedOnPosition ( int  X,
int  Y,
int *  pos1,
int *  pos2 
)
protectedvirtual

◆ SetCursor()

virtual void vtkOrientationMarkerWidget::SetCursor ( int  state)
protectedvirtual

◆ MoveWidget()

void vtkOrientationMarkerWidget::MoveWidget ( int  X,
int  Y 
)
protected

◆ ResizeTopLeft()

void vtkOrientationMarkerWidget::ResizeTopLeft ( int  X,
int  Y 
)
protected

◆ ResizeTopRight()

void vtkOrientationMarkerWidget::ResizeTopRight ( int  X,
int  Y 
)
protected

◆ ResizeBottomLeft()

void vtkOrientationMarkerWidget::ResizeBottomLeft ( int  X,
int  Y 
)
protected

◆ ResizeBottomRight()

void vtkOrientationMarkerWidget::ResizeBottomRight ( int  X,
int  Y 
)
protected

◆ SquareRenderer()

void vtkOrientationMarkerWidget::SquareRenderer ( )
protected

◆ UpdateOutline()

void vtkOrientationMarkerWidget::UpdateOutline ( )
protected

◆ UpdateViewport()

void vtkOrientationMarkerWidget::UpdateViewport ( )
protected

◆ UpdateInternalViewport()

void vtkOrientationMarkerWidget::UpdateInternalViewport ( )
protected

◆ ResizeToFitSizeConstraints()

void vtkOrientationMarkerWidget::ResizeToFitSizeConstraints ( )
protected

Member Data Documentation

◆ Renderer

vtkRenderer* vtkOrientationMarkerWidget::Renderer
protected

Definition at line 319 of file vtkOrientationMarkerWidget.h.

◆ OrientationMarker

vtkProp* vtkOrientationMarkerWidget::OrientationMarker
protected

Definition at line 320 of file vtkOrientationMarkerWidget.h.

◆ Outline

vtkPolyData* vtkOrientationMarkerWidget::Outline
protected

Definition at line 321 of file vtkOrientationMarkerWidget.h.

◆ OutlineActor

vtkActor2D* vtkOrientationMarkerWidget::OutlineActor
protected

Definition at line 322 of file vtkOrientationMarkerWidget.h.

◆ StartEventObserverId

unsigned long vtkOrientationMarkerWidget::StartEventObserverId
protected

Definition at line 324 of file vtkOrientationMarkerWidget.h.

◆ Observer

vtkOrientationMarkerWidgetObserver* vtkOrientationMarkerWidget::Observer
protected

Definition at line 335 of file vtkOrientationMarkerWidget.h.

◆ Interactive

vtkTypeBool vtkOrientationMarkerWidget::Interactive
protected

Definition at line 337 of file vtkOrientationMarkerWidget.h.

◆ Tolerance

int vtkOrientationMarkerWidget::Tolerance
protected

Definition at line 338 of file vtkOrientationMarkerWidget.h.

◆ Moving

int vtkOrientationMarkerWidget::Moving
protected

Definition at line 339 of file vtkOrientationMarkerWidget.h.

◆ Zoom

double vtkOrientationMarkerWidget::Zoom = 1.0
protected

Definition at line 340 of file vtkOrientationMarkerWidget.h.

◆ Viewport

double vtkOrientationMarkerWidget::Viewport[4]
protected

Definition at line 343 of file vtkOrientationMarkerWidget.h.

◆ StartPosition

int vtkOrientationMarkerWidget::StartPosition[2]
protected

Definition at line 346 of file vtkOrientationMarkerWidget.h.

◆ State

int vtkOrientationMarkerWidget::State
protected

Definition at line 349 of file vtkOrientationMarkerWidget.h.

◆ ShouldConstrainSize

vtkTypeBool vtkOrientationMarkerWidget::ShouldConstrainSize = 0
protected

Definition at line 362 of file vtkOrientationMarkerWidget.h.

◆ MinDimensionSize

int vtkOrientationMarkerWidget::MinDimensionSize = 20
protected

Definition at line 364 of file vtkOrientationMarkerWidget.h.

◆ MaxDimensionSize

int vtkOrientationMarkerWidget::MaxDimensionSize = 500
protected

Definition at line 366 of file vtkOrientationMarkerWidget.h.


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