Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends
vtkMRMLVolumeRenderingDisplayableManager Class Reference

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

Inheritance diagram for vtkMRMLVolumeRenderingDisplayableManager:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLVolumeRenderingDisplayableManager:
Collaboration graph
[legend]

Public Types

typedef vtkMRMLAbstractThreeDViewDisplayableManager Superclass
 
- Public Types inherited from vtkMRMLAbstractThreeDViewDisplayableManager
typedef vtkMRMLAbstractDisplayableManager Superclass
 
- Public Types inherited from vtkMRMLAbstractDisplayableManager
typedef vtkMRMLAbstractLogic Superclass
 
- Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject Superclass
 
typedef void(vtkMRMLAbstractLogic::* TaskFunctionPointer) (void *clientdata)
 

Public Member Functions

virtual const char * GetClassName ()
 
const char * GetPickedNodeID () override
 Get the MRML ID of the picked node, returns empty string if no pick. More...
 
vtkVolume * GetVolumeActor (vtkMRMLVolumeNode *volumeNode)
 
vtkVolumeMapper * GetVolumeMapper (vtkMRMLVolumeNode *volumeNode)
 Utility functions mainly used for testing. More...
 
virtual int IsA (const char *type)
 
void OnMRMLSceneEndBatchProcess () override
 
void OnMRMLSceneEndClose () override
 
void OnMRMLSceneEndImport () override
 
void OnMRMLSceneEndRestore () override
 
void OnMRMLSceneNodeAdded (vtkMRMLNode *node) override
 
void OnMRMLSceneNodeRemoved (vtkMRMLNode *node) override
 
void OnMRMLSceneStartClose () override
 
int Pick3D (double ras[3]) override
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void UnobserveMRMLScene () override
 
void UpdateFromMRML () override
 Update actors based on volumes in the scene. More...
 
- Public Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
vtkMRMLViewNodeGetMRMLViewNode ()
 Get MRML ViewNode. More...
 
virtual int Pick3D (double vtkNotUsed(ras)[3])
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
virtual bool CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2)
 
virtual std::string GetDataProbeInfoStringForPosition (double vtkNotUsed(xyz)[3])
 
virtual bool GetGrabFocus ()
 Displayable manager can indicate that it would like to get all events (even when mouse pointer is outside the window). More...
 
vtkMRMLInteractionNodeGetInteractionNode ()
 Convenient method to get the current InteractionNode. More...
 
virtual bool GetInteractive ()
 Displayable manager can indicate that the window is in interactive mode (faster updates). More...
 
vtkRenderWindowInteractor * GetInteractor ()
 Convenient method to get the WindowInteractor associated with the Renderer. More...
 
virtual vtkMRMLLightBoxRendererManagerProxyGetLightBoxRendererManagerProxy ()
 
virtual int GetMouseCursor ()
 Displayable manager returns ID of the mouse cursor shape that should be displayed. More...
 
vtkRenderer * GetRenderer ()
 Get the default renderer for this displayable manager. More...
 
vtkRenderer * GetRenderer (int idx)
 
vtkMRMLSelectionNodeGetSelectionNode ()
 Convenient method to get the current SelectionNode. More...
 
bool IsCreated ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual bool ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData)
 
virtual void SetHasFocus (bool hasFocus)
 Set if the widget gets/loses focus (interaction events are processed by this displayable manager). More...
 
virtual void SetLightBoxRendererManagerProxy (vtkMRMLLightBoxRendererManagerProxy *)
 
void SetMouseCursor (int cursor)
 
- Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogicGetMRMLApplicationLogic () const
 Get access to overall application state. More...
 
vtkMRMLSceneGetMRMLScene () const
 Return a reference to the current MRML scene. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
 
void SetMRMLScene (vtkMRMLScene *newScene)
 Set and observe the MRMLScene. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLVolumeRenderingDisplayableManagerNew ()
 
static vtkMRMLVolumeRenderingDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractThreeDViewDisplayableManagerNew ()
 
static vtkMRMLAbstractThreeDViewDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractDisplayableManagerNew ()
 
static vtkMRMLAbstractDisplayableManagerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractLogicNew ()
 
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)
 

Static Public Attributes

static int DefaultGPUMemorySize
 

Protected Member Functions

int ActiveInteractionModes () override
 
void Create () override
 Initialize the displayable manager. More...
 
void ObserveGraphicalResourcesCreatedEvent ()
 Observe graphical resources created event. More...
 
void OnInteractorStyleEvent (int eventID) override
 
void operator= (const vtkMRMLVolumeRenderingDisplayableManager &)
 
void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData) override
 
 vtkMRMLVolumeRenderingDisplayableManager ()
 
 vtkMRMLVolumeRenderingDisplayableManager (const vtkMRMLVolumeRenderingDisplayableManager &)
 
 ~vtkMRMLVolumeRenderingDisplayableManager () override
 
- Protected Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
void OnMRMLDisplayableNodeModifiedEvent (vtkObject *caller) override
 
virtual void OnMRMLViewNodeModifiedEvent ()
 Could be overloaded in DisplayableManager subclass. More...
 
virtual void PassThroughInteractorStyleEvent (int eventid)
 
 vtkMRMLAbstractThreeDViewDisplayableManager ()
 
 ~vtkMRMLAbstractThreeDViewDisplayableManager () override
 
- Protected Member Functions inherited from vtkMRMLAbstractDisplayableManager
void AddInteractorObservableEvent (int eventid, float priority=0.0)
 
void AddInteractorStyleObservableEvent (int eventid, float priority=0.0)
 
virtual void AdditionalInitializeStep ()
 
void AddMRMLDisplayableManagerEvent (int eventId)
 Allow to specify additional events that the DisplayableNode will observe. More...
 
void CreateIfPossible ()
 
int GetInteractorAbortFlag ()
 
int GetInteractorStyleAbortFlag ()
 
vtkMRMLDisplayableManagerGroupGetMRMLDisplayableManagerGroup ()
 Get associated DisplayableManager group. More...
 
vtkMRMLNodeGetMRMLDisplayableNode ()
 Get MRML Displayable Node. More...
 
vtkCallbackCommand * GetWidgetsCallbackCommand ()
 Get vtkWidget callbackCommand. More...
 
vtkObserverManagerGetWidgetsObserverManager () const
 Get widget observerManager. More...
 
void InteractorAbortFlagOff ()
 
void InteractorAbortFlagOn ()
 
void InteractorStyleAbortFlagOff ()
 
void InteractorStyleAbortFlagOn ()
 
virtual void OnInteractorEvent (int eventid)
 
virtual void ProcessWidgetsEvents (vtkObject *caller, unsigned long event, void *callData)
 
void RemoveInteractorObservableEvent (int eventid)
 
void RemoveInteractorStyleObservableEvent (int eventid)
 
virtual void RemoveMRMLObservers ()
 Remove MRML observers. More...
 
void RequestRender ()
 
void SetAndObserveMRMLDisplayableNode (vtkMRMLNode *newMRMLDisplayableNode)
 
void SetInteractorAbortFlag (int f)
 Set the Abort flag on the Interactor event callback. More...
 
void SetInteractorStyleAbortFlag (int f)
 Set the Abort flag on the InteractorStyle event callback. More...
 
virtual void SetMRMLDisplayableManagerGroup (vtkMRMLDisplayableManagerGroup *group)
 
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 
virtual void SetRenderer (vtkRenderer *newRenderer)
 
void SetUpdateFromMRMLRequested (bool requested)
 
 vtkMRMLAbstractDisplayableManager ()
 
 ~vtkMRMLAbstractDisplayableManager () override
 
- Protected Member Functions inherited from vtkMRMLAbstractLogic
int EndModify (bool wasModifying)
 
virtual bool EnterMRMLLogicsCallback () const
 
virtual bool EnterMRMLNodesCallback () const
 
virtual bool EnterMRMLSceneCallback () const
 
bool GetDisableModifiedEvent () const
 
int GetInMRMLLogicsCallbackFlag () const
 
int GetInMRMLNodesCallbackFlag () const
 
int GetInMRMLSceneCallbackFlag () const
 
vtkCallbackCommand * GetMRMLLogicsCallbackCommand ()
 
vtkObserverManagerGetMRMLLogicsObserverManager () const
 
vtkCallbackCommand * GetMRMLNodesCallbackCommand ()
 
vtkObserverManagerGetMRMLNodesObserverManager () const
 
vtkCallbackCommand * GetMRMLSceneCallbackCommand ()
 
vtkObserverManagerGetMRMLSceneObserverManager () const
 
int GetPendingModifiedEventCount () const
 
int GetProcessingMRMLSceneEvent () const
 Return the event id currently processed or 0 if any. More...
 
int InvokePendingModifiedEvent ()
 
void Modified () override
 
virtual void ObserveMRMLScene ()
 
virtual void OnMRMLNodeModified (vtkMRMLNode *)
 
virtual void OnMRMLSceneNew ()
 
virtual void OnMRMLSceneStartBatchProcess ()
 
virtual void OnMRMLSceneStartImport ()
 
virtual void OnMRMLSceneStartRestore ()
 
virtual void ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void RegisterNodes ()
 
void SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=nullptr)
 
void SetDisableModifiedEvent (bool onOff)
 
void SetInMRMLLogicsCallbackFlag (int flag)
 
void SetInMRMLNodesCallbackFlag (int flag)
 
void SetInMRMLSceneCallbackFlag (int flag)
 
void SetProcessingMRMLSceneEvent (int event)
 
bool StartModify ()
 
virtual void UpdateFromMRMLScene ()
 
 vtkMRMLAbstractLogic ()
 
 ~vtkMRMLAbstractLogic () override
 

Protected Attributes

vtkInternalInternal
 
vtkSlicerVolumeRenderingLogicVolumeRenderingLogic
 

Friends

class vtkInternal
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkMRMLAbstractDisplayableManager
static void WidgetsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 WidgetsCallback is a static function to relay modified events from the vtk widgets. More...
 
- Static Protected Member Functions inherited from vtkMRMLAbstractLogic
static void MRMLLogicsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLLogicCallback is a static function to relay modified events from the logics. More...
 
static void MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLNodesCallback is a static function to relay modified events from the nodes. More...
 
static void MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

Definition at line 38 of file vtkMRMLVolumeRenderingDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkMRMLVolumeRenderingDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLVolumeRenderingDisplayableManager() [1/2]

vtkMRMLVolumeRenderingDisplayableManager::vtkMRMLVolumeRenderingDisplayableManager ( )
protected

◆ ~vtkMRMLVolumeRenderingDisplayableManager()

vtkMRMLVolumeRenderingDisplayableManager::~vtkMRMLVolumeRenderingDisplayableManager ( )
overrideprotected

◆ vtkMRMLVolumeRenderingDisplayableManager() [2/2]

vtkMRMLVolumeRenderingDisplayableManager::vtkMRMLVolumeRenderingDisplayableManager ( const vtkMRMLVolumeRenderingDisplayableManager )
protected

Member Function Documentation

◆ ActiveInteractionModes()

int vtkMRMLVolumeRenderingDisplayableManager::ActiveInteractionModes ( )
overrideprotectedvirtual

Subclass can overload this method to specify under which InteractionNode modes this Displayable Manager InteractorStyle events. By default events only arrive when in Place mode (good for annotations) but if you want a continuous read out of, for example, slice positions while the mouse moves set this to include Place and ViewTransform

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ Create()

void vtkMRMLVolumeRenderingDisplayableManager::Create ( )
overrideprotectedvirtual

Initialize the displayable manager.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetClassName()

virtual const char* vtkMRMLVolumeRenderingDisplayableManager::GetClassName ( )
virtual

◆ GetPickedNodeID()

const char* vtkMRMLVolumeRenderingDisplayableManager::GetPickedNodeID ( )
overridevirtual

Get the MRML ID of the picked node, returns empty string if no pick.

Reimplemented from vtkMRMLAbstractThreeDViewDisplayableManager.

◆ GetVolumeActor()

vtkVolume* vtkMRMLVolumeRenderingDisplayableManager::GetVolumeActor ( vtkMRMLVolumeNode volumeNode)

◆ GetVolumeMapper()

vtkVolumeMapper* vtkMRMLVolumeRenderingDisplayableManager::GetVolumeMapper ( vtkMRMLVolumeNode volumeNode)

Utility functions mainly used for testing.

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLVolumeRenderingDisplayableManager* vtkMRMLVolumeRenderingDisplayableManager::New ( )
static

◆ ObserveGraphicalResourcesCreatedEvent()

void vtkMRMLVolumeRenderingDisplayableManager::ObserveGraphicalResourcesCreatedEvent ( )
protected

Observe graphical resources created event.

◆ OnInteractorStyleEvent()

void vtkMRMLVolumeRenderingDisplayableManager::OnInteractorStyleEvent ( int  eventid)
overrideprotectedvirtual

Called after interactor style event specified using AddInteractorStyleObservableEvent are invoked.

Note
The following events are observed by default:
  • vtkCommand::LeftButtonPressEvent
  • vtkCommand::LeftButtonReleaseEvent
  • vtkCommand::RightButtonPressEvent
  • vtkCommand::RightButtonReleaseEvent
  • vtkCommand::MiddleButtonPressEvent
  • vtkCommand::MiddleButtonReleaseEvent
  • vtkCommand::MouseWheelBackwardEvent
  • vtkCommand::MouseWheelForwardEvent
  • vtkCommand::EnterEvent
  • vtkCommand::LeaveEvent
See also
AddInteractorStyleObservableEvent RemoveInteractorStyleObservableEvent

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ OnMRMLSceneEndBatchProcess()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneEndBatchProcess ( )
overridevirtual

If vtkMRMLScene::EndBatchProcessEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event Internally calls UpdateFromMRMLScene. Can be reimplemented to change the default behavior.

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartBatchProcess

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndClose()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneEndClose ( )
overridevirtual

If vtkMRMLScene::EndCloseEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartClose

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndImport()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneEndImport ( )
overridevirtual

If vtkMRMLScene::EndImportEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartImport, OnMRMLSceneNew

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndRestore()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneEndRestore ( )
overridevirtual

If vtkMRMLScene::EndRestoreEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneStartRestore

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneNodeAdded()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneNodeAdded ( vtkMRMLNode )
overridevirtual

If vtkMRMLScene::NodeAddedEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneNodeRemoved, vtkMRMLScene::NodeAboutToBeAdded

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneNodeRemoved()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneNodeRemoved ( vtkMRMLNode )
overridevirtual

If vtkMRMLScene::NodeRemovedEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneNodeAdded, vtkMRMLScene::NodeAboutToBeRemoved

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneStartClose()

void vtkMRMLVolumeRenderingDisplayableManager::OnMRMLSceneStartClose ( )
overridevirtual

If vtkMRMLScene::StartCloseEvent has been set to be observed in SetMRMLSceneInternal, it is called when the scene fires the event

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneEndClose

Reimplemented from vtkMRMLAbstractLogic.

◆ operator=()

void vtkMRMLVolumeRenderingDisplayableManager::operator= ( const vtkMRMLVolumeRenderingDisplayableManager )
protected

◆ Pick3D()

int vtkMRMLVolumeRenderingDisplayableManager::Pick3D ( double  ras[3])
override

Find display node managed by the displayable manager at a specified world RAS position.

Returns
Non-zero in case a node is found at the position, 0 otherwise

◆ PrintSelf()

void vtkMRMLVolumeRenderingDisplayableManager::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessMRMLNodesEvents()

void vtkMRMLVolumeRenderingDisplayableManager::ProcessMRMLNodesEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
overrideprotectedvirtual

Receives all the events fired by the nodes. To listen to a node, you can add an observer using GetMRMLNodesCallbackCommand() or use the utility macros vtk[SetAndObserve|Observe]MRMLNode[Event]Macro ProcessMRMLNodesEvents calls OnMRMLNodeModified when event is vtkCommand::ModifiedEvent.

See also
ProcessMRMLSceneEvents, ProcessMRMLLogicsEvents, OnMRMLNodeModified(), vtkSetAndObserveMRMLNodeMacro, vtkObserveMRMLNodeMacro, vtkSetAndObserveMRMLNodeEventMacro

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SafeDownCast()

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

◆ UnobserveMRMLScene()

void vtkMRMLVolumeRenderingDisplayableManager::UnobserveMRMLScene ( )
overridevirtual

Called anytime a scene is not set to the logic anymore (e.g. a new or no scene is set) Reimplement the method to delete all the scene specific information such as a node IDs, pointers...

See also
SetMRMLSceneInternal, ObserveMRMLScene, UpdateFromMRMLScene

Reimplemented from vtkMRMLAbstractLogic.

◆ UpdateFromMRML()

void vtkMRMLVolumeRenderingDisplayableManager::UpdateFromMRML ( )
overridevirtual

Update actors based on volumes in the scene.

Reimplemented from vtkMRMLAbstractDisplayableManager.

Friends And Related Function Documentation

◆ vtkInternal

friend class vtkInternal
friend

Definition at line 97 of file vtkMRMLVolumeRenderingDisplayableManager.h.

Member Data Documentation

◆ DefaultGPUMemorySize

int vtkMRMLVolumeRenderingDisplayableManager::DefaultGPUMemorySize
static

Definition at line 70 of file vtkMRMLVolumeRenderingDisplayableManager.h.

◆ Internal

vtkInternal* vtkMRMLVolumeRenderingDisplayableManager::Internal
protected

Definition at line 95 of file vtkMRMLVolumeRenderingDisplayableManager.h.

◆ VolumeRenderingLogic

vtkSlicerVolumeRenderingLogic* vtkMRMLVolumeRenderingDisplayableManager::VolumeRenderingLogic
protected

Definition at line 89 of file vtkMRMLVolumeRenderingDisplayableManager.h.


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