vtkMRMLVolumeRenderingWindowLevelWidget Class Reference

Adjust volume rendering transfer functions with mouse interactions. More...

#include <Modules/Loadable/VolumeRendering/MRMLDM/vtkMRMLVolumeRenderingWindowLevelWidget.h>

Inheritance diagram for vtkMRMLVolumeRenderingWindowLevelWidget:

Collaboration diagram for vtkMRMLVolumeRenderingWindowLevelWidget:

Public Types
enum	{ WidgetEventClickAndDragStart = WidgetEventUser , WidgetEventClickAndDragEnd }
	Widget events. More...
enum	{ WidgetStateWindowLevelAdjust = WidgetStateUser , WidgetStateOpacityAdjust }
	Widget states. More...
typedef vtkMRMLAbstractWidget	Superclass
Public Types inherited from vtkMRMLAbstractWidget
enum	{   WidgetStateAny , WidgetStateIdle , WidgetStateOnWidget , WidgetStateTranslate ,   WidgetStateRotate , WidgetStateScale , WidgetStateUser }
	The state of the widget. More...
typedef vtkObject	Superclass
	Standard methods for a VTK class.
enum	WidgetEvents {   WidgetEventNone , WidgetEventMouseMove , WidgetEventTranslateStart , WidgetEventTranslateEnd ,   WidgetEventRotateStart , WidgetEventRotateEnd , WidgetEventScaleStart , WidgetEventScaleEnd ,   WidgetEventPick , WidgetEventJumpCursor , WidgetEventAction , WidgetEventCustomAction1 ,   WidgetEventCustomAction2 , WidgetEventCustomAction3 , WidgetEventCustomAction4 , WidgetEventCustomAction5 ,   WidgetEventCustomAction6 , WidgetEventSelect , WidgetEventUnselect , WidgetEventToggleSelect ,   WidgetEventMenu , WidgetEventReset , WidgetEventUser }
	Widget events. More...

Public Member Functions
bool	CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2) override
	Return true if the widget can process the interaction event.
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	Leave (vtkMRMLInteractionEventData *eventData) override
	Called when the widget loses input focus.
void	PrintSelf (ostream &os, vtkIndent indent) override
bool	ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override
	Process interaction event.
void	SetMRMLViewNode (vtkMRMLViewNode *viewNode)
	Create the default widget representation.
void	SetVolumeRenderingDisplayableManager (vtkMRMLVolumeRenderingDisplayableManager *manager)
	Set the volume rendering displayable manager.
Public Member Functions inherited from vtkMRMLAbstractWidget
virtual vtkWidgetEventTranslator *	GetEventTranslator (int widgetState)
virtual bool	GetGrabFocus ()
vtkMRMLInteractionNode *	GetInteractionNode ()
virtual bool	GetInteractive ()
virtual int	GetMouseCursor ()
vtkMRMLApplicationLogic *	GetMRMLApplicationLogic ()
virtual bool	GetNeedToRender ()
virtual int	GetNumberOfEventTranslators ()
vtkRenderer *	GetRenderer ()
virtual vtkMRMLAbstractWidgetRepresentation *	GetRepresentation ()
	Get the representation.
virtual int	GetWidgetState ()
	Convenient method to determine the state of the method.
virtual void	NeedToRenderOff ()
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetEventTranslation (int widgetState, unsigned long interactionEvent, int modifiers, unsigned long widgetEvent)
void	SetEventTranslation (unsigned long interactionEvent, int modifiers, unsigned long widgetEvent)
void	SetEventTranslationClickAndDrag (int widgetState, unsigned long startInteractionEvent, int modifiers, int widgetStateDragging, unsigned long widgetStartEvent, unsigned long widgetEndEvent)
void	SetKeyboardEventTranslation (int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)
void	SetKeyboardEventTranslation (int widgetState, int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)
virtual void	SetMRMLApplicationLogic (vtkMRMLApplicationLogic *applicationLogic)
void	SetRenderer (vtkRenderer *renderer)
virtual void	SetRepresentation (vtkMRMLAbstractWidgetRepresentation *r)
virtual void	SetWidgetState (int)
	Convenient method to change what state the widget is in.
virtual unsigned long	TranslateInteractionEventToWidgetEvent (vtkMRMLInteractionEventData *eventData)
	Get widget event from translation event.
virtual void	UpdateFromMRML (vtkMRMLNode *caller, unsigned long event, void *callData=nullptr)
	Build the actors of the representation with the info stored in the MRML scene.

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLVolumeRenderingWindowLevelWidget *	New ()
static vtkMRMLVolumeRenderingWindowLevelWidget *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLAbstractWidget
static int	IsTypeOf (const char *type)
static vtkMRMLAbstractWidget *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	AdjustVolumeRenderingTransferFunctions (vtkMRMLVolumePropertyNode *volumePropertyNode, double deltaX, double deltaY, int modifiers=0)
	Adjust transfer functions for a specific volume property node.
void	ProcessAdjustTransferFunction (vtkMRMLInteractionEventData *eventData)
bool	ProcessAdjustTransferFunctionStart (vtkMRMLInteractionEventData *eventData)
bool	ProcessEndMouseDrag (vtkMRMLInteractionEventData *eventData)
bool	ProcessMouseMove (vtkMRMLInteractionEventData *eventData)
bool	ProcessReset (vtkMRMLInteractionEventData *eventData)
bool	ProcessStartMouseDrag (vtkMRMLInteractionEventData *eventData)
	vtkMRMLVolumeRenderingWindowLevelWidget ()
	~vtkMRMLVolumeRenderingWindowLevelWidget () override
Protected Member Functions inherited from vtkMRMLAbstractWidget
bool	CanProcessButtonClickEvent (vtkMRMLInteractionEventData *eventData, double &distance2)
	Generate a button click event and checks if it can be processed with CanProcessInteractionEvent.
const char *	GetAssociatedNodeID (vtkMRMLInteractionEventData *eventData)
virtual int	ProcessButtonClickEvent (vtkMRMLInteractionEventData *eventData)
unsigned long	TranslateInteractionEventToWidgetEvent (vtkWidgetEventTranslator *translator, vtkMRMLInteractionEventData *eventData)
	Helper function that attempts to translate an event with a specific translator only.
	vtkMRMLAbstractWidget ()
	~vtkMRMLAbstractWidget () override

Additional Inherited Members
Protected Attributes inherited from vtkMRMLAbstractWidget
vtkWeakPointer< vtkMRMLApplicationLogic >	ApplicationLogic
std::vector< vtkSmartPointer< vtkWidgetEventTranslator > >	EventTranslators
vtkWeakPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkMRMLAbstractWidgetRepresentation >	WidgetRep
int	WidgetState

Detailed Description

Adjust volume rendering transfer functions with mouse interactions.

The vtkMRMLVolumeRenderingWindowLevelWidget allows adjusting volume rendering transfer functions by dragging the mouse in 3D views. Horizontal drag shifts the transfer functions, vertical drag scales them.

Definition at line 46 of file vtkMRMLVolumeRenderingWindowLevelWidget.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLAbstractWidget vtkMRMLVolumeRenderingWindowLevelWidget::Superclass

Definition at line 50 of file vtkMRMLVolumeRenderingWindowLevelWidget.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Widget events.

Enumerator
WidgetEventClickAndDragStart
WidgetEventClickAndDragEnd

Definition at line 76 of file vtkMRMLVolumeRenderingWindowLevelWidget.h.

anonymous enum

anonymous enum

Widget states.

Enumerator
WidgetStateWindowLevelAdjust
WidgetStateOpacityAdjust

Definition at line 69 of file vtkMRMLVolumeRenderingWindowLevelWidget.h.

Constructor & Destructor Documentation

vtkMRMLVolumeRenderingWindowLevelWidget()

vtkMRMLVolumeRenderingWindowLevelWidget::vtkMRMLVolumeRenderingWindowLevelWidget ( )

protected

~vtkMRMLVolumeRenderingWindowLevelWidget()

vtkMRMLVolumeRenderingWindowLevelWidget::~vtkMRMLVolumeRenderingWindowLevelWidget ( )

overrideprotected

Member Function Documentation

AdjustVolumeRenderingTransferFunctions()

void vtkMRMLVolumeRenderingWindowLevelWidget::AdjustVolumeRenderingTransferFunctions ( vtkMRMLVolumePropertyNode * volumePropertyNode, double deltaX, double deltaY, int modifiers = 0 )

protected

Adjust transfer functions for a specific volume property node.

CanProcessInteractionEvent()

bool vtkMRMLVolumeRenderingWindowLevelWidget::CanProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData, double & distance2 )

overridevirtual

Return true if the widget can process the interaction event.

Reimplemented from vtkMRMLAbstractWidget.

GetClassName()

virtual const char * vtkMRMLVolumeRenderingWindowLevelWidget::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractWidget.

IsA()

virtual int vtkMRMLVolumeRenderingWindowLevelWidget::IsA ( const char * type )

virtual

Reimplemented from vtkMRMLAbstractWidget.

IsTypeOf()

static int vtkMRMLVolumeRenderingWindowLevelWidget::IsTypeOf ( const char * type )

static

Leave()

void vtkMRMLVolumeRenderingWindowLevelWidget::Leave ( vtkMRMLInteractionEventData * eventData )

overridevirtual

Called when the widget loses input focus.

Reimplemented from vtkMRMLAbstractWidget.

New()

static vtkMRMLVolumeRenderingWindowLevelWidget * vtkMRMLVolumeRenderingWindowLevelWidget::New ( )

static

PrintSelf()

void vtkMRMLVolumeRenderingWindowLevelWidget::PrintSelf ( ostream & os, vtkIndent indent )

override

ProcessAdjustTransferFunction()

void vtkMRMLVolumeRenderingWindowLevelWidget::ProcessAdjustTransferFunction ( vtkMRMLInteractionEventData * eventData )

protected

ProcessAdjustTransferFunctionStart()

bool vtkMRMLVolumeRenderingWindowLevelWidget::ProcessAdjustTransferFunctionStart ( vtkMRMLInteractionEventData * eventData )

protected

ProcessEndMouseDrag()

bool vtkMRMLVolumeRenderingWindowLevelWidget::ProcessEndMouseDrag ( vtkMRMLInteractionEventData * eventData )

protected

ProcessInteractionEvent()

bool vtkMRMLVolumeRenderingWindowLevelWidget::ProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData )

overridevirtual

Process interaction event.

Reimplemented from vtkMRMLAbstractWidget.

ProcessMouseMove()

bool vtkMRMLVolumeRenderingWindowLevelWidget::ProcessMouseMove ( vtkMRMLInteractionEventData * eventData )

protected

ProcessReset()

bool vtkMRMLVolumeRenderingWindowLevelWidget::ProcessReset ( vtkMRMLInteractionEventData * eventData )

protected

ProcessStartMouseDrag()

bool vtkMRMLVolumeRenderingWindowLevelWidget::ProcessStartMouseDrag ( vtkMRMLInteractionEventData * eventData )

protected

SafeDownCast()

static vtkMRMLVolumeRenderingWindowLevelWidget * vtkMRMLVolumeRenderingWindowLevelWidget::SafeDownCast ( vtkObject * o )

static

SetMRMLViewNode()

void vtkMRMLVolumeRenderingWindowLevelWidget::SetMRMLViewNode

(

vtkMRMLViewNode *

viewNode

)

Create the default widget representation.

SetVolumeRenderingDisplayableManager()

void vtkMRMLVolumeRenderingWindowLevelWidget::SetVolumeRenderingDisplayableManager

(

vtkMRMLVolumeRenderingDisplayableManager *

manager

)

Set the volume rendering displayable manager.

---

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

• Modules/Loadable/VolumeRendering/MRMLDM/vtkMRMLVolumeRenderingWindowLevelWidget.h