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

#include <vtkOrientationMarkerWidget.h>

Inheritance diagram for vtkOrientationMarkerWidget:

Collaboration diagram for vtkOrientationMarkerWidget:

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.

vtkOrientationMarkerWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetEnabled (int) override
	Enable/disable the widget.

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.

void	EndInteraction () override
	Ends any in progress interaction and resets border visibility.

void	SetShouldConstrainSize (const vtkTypeBool shouldConstrainSize)
	Set/get whether the widget should constrain the size to be within the min and max limits.

virtual vtkTypeBool	GetShouldConstrainSize ()

bool	SetSizeConstraintDimensionSizes (const int minDimensionSize, const int maxDimensionSize)
	Sets the minimum and maximum dimension (width and height) size limits for the widget.

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

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


virtual void	SetOrientationMarker (vtkProp *prop)
	Set/get the orientation marker to be displayed in this widget.

virtual vtkProp *	GetOrientationMarker ()
	Set/get the orientation marker to be displayed in this widget.


void	SetInteractive (vtkTypeBool interact)
	Set/get whether to allow this widget to be interactively moved/scaled.

virtual vtkTypeBool	GetInteractive ()
	Set/get whether to allow this widget to be interactively moved/scaled.

virtual void	InteractiveOn ()
	Set/get whether to allow this widget to be interactively moved/scaled.

virtual void	InteractiveOff ()
	Set/get whether to allow this widget to be interactively moved/scaled.


void	SetOutlineColor (double r, double g, double b)
	Set/get the color of the outline of this widget.

double *	GetOutlineColor ()
	Set/get the color of the outline of this widget.


virtual void	SetViewport (double, double, double, double)
	Set/get the viewport to position/size this widget.

virtual void	SetViewport (double[4])
	Set/get the viewport to position/size this widget.

virtual double *	GetViewport ()
	Set/get the viewport to position/size this widget.

virtual void	GetViewport (double &, double &, double &, double &)
	Set/get the viewport to position/size this widget.

virtual void	GetViewport (double[4])
	Set/get the viewport to position/size this widget.


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).

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).


virtual void	SetZoom (double)
	The zoom factor to modify the size of the marker within the widget.

virtual double	GetZoom ()
	The zoom factor to modify the size of the marker within the widget.

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

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.

vtkInteractorObserver *	NewInstance () 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 vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed.

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 vtkRenderer *	GetDefaultRenderer ()
	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 vtkRenderer *	GetCurrentRenderer ()
	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)

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.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

virtual 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.

Static Public Member Functions
static vtkOrientationMarkerWidget *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOrientationMarkerWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (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 vtkObject *	New ()
	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 (int 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 int	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 vtkObjectBase *	New ()
	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	WidgetState { Outside = 0 , Inside , Translating , AdjustingP1 , AdjustingP2 , AdjustingP3 , AdjustingP4 }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (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.

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 *)

	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.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkRenderer *	Renderer

vtkProp *	OrientationMarker

vtkPolyData *	Outline

vtkActor2D *	OutlineActor

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

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

vtkTypeBool	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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:

Assembly

CallBack

PBR_Skybox

PBR_Skybox_Anisotropy

AnatomicalOrientation

OrientationMarkerWidget

Tests:: vtkOrientationMarkerWidget (Tests)

Definition at line 196 of file vtkOrientationMarkerWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorObserver vtkOrientationMarkerWidget::Superclass

Definition at line 200 of file vtkOrientationMarkerWidget.h.

Member Enumeration Documentation

◆ WidgetState

enum vtkOrientationMarkerWidget::WidgetState

protected

Enumerator
Outside
Inside
Translating
AdjustingP1
AdjustingP2
AdjustingP3
AdjustingP4

Definition at line 361 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).