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 | Protected Member Functions
vtkMRMLCameraDisplayableManager Class Reference

#include <Libs/MRML/DisplayableManager/vtkMRMLCameraDisplayableManager.h>

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

Public Types

enum  { ActiveCameraChangedEvent = 30000 }
 Events. More...
 
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

bool CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &closestDistance2) override
 
vtkMRMLCameraNodeGetCameraNode ()
 
vtkMRMLCameraWidgetGetCameraWidget ()
 
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override
 
void RemoveMRMLObservers () override
 Remove MRML observers. More...
 
void UpdateCameraNode ()
 
- Public Member Functions inherited from vtkMRMLAbstractThreeDViewDisplayableManager
vtkMRMLViewNodeGetMRMLViewNode ()
 Get MRML ViewNode. More...
 
virtual const char * GetPickedNodeID ()
 Get the MRML ID of the picked node, returns empty string if no pick. More...
 
virtual int Pick3D (double vtkNotUsed(ras)[3])
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAbstractDisplayableManager
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 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 vtkMRMLCameraDisplayableManagerNew ()
 
static vtkMRMLCameraDisplayableManagerSafeDownCast (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)
 

Protected Member Functions

void AdditionalInitializeStep () override
 
void Create () override
 
void OnMRMLNodeModified (vtkMRMLNode *node) override
 
void OnMRMLSceneEndClose () override
 
void OnMRMLSceneEndImport () override
 
void OnMRMLSceneEndRestore () override
 
void OnMRMLSceneNodeAdded (vtkMRMLNode *node) override
 
void OnMRMLSceneNodeRemoved (vtkMRMLNode *node) override
 
void OnMRMLSceneStartImport () override
 
void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData) override
 
void SetAndObserveCameraNode (vtkMRMLCameraNode *newCameraNode)
 
void SetCameraToInteractor ()
 
void SetCameraToRenderer ()
 
 vtkMRMLCameraDisplayableManager ()
 
 ~vtkMRMLCameraDisplayableManager () 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
virtual int ActiveInteractionModes ()
 
void AddInteractorObservableEvent (int eventid, float priority=0.0)
 
void AddInteractorStyleObservableEvent (int eventid, float priority=0.0)
 
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 OnInteractorStyleEvent (int eventid)
 
virtual void ProcessWidgetsEvents (vtkObject *caller, unsigned long event, void *callData)
 
void RemoveInteractorObservableEvent (int eventid)
 
void RemoveInteractorStyleObservableEvent (int eventid)
 
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)
 
virtual void UpdateFromMRML ()
 
 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 OnMRMLSceneEndBatchProcess ()
 
virtual void OnMRMLSceneNew ()
 
virtual void OnMRMLSceneStartBatchProcess ()
 
virtual void OnMRMLSceneStartClose ()
 
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 UnobserveMRMLScene ()
 
virtual void UpdateFromMRMLScene ()
 
 vtkMRMLAbstractLogic ()
 
 ~vtkMRMLAbstractLogic () override
 

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 33 of file vtkMRMLCameraDisplayableManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkMRMLCameraDisplayableManager.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Events.

Enumerator
ActiveCameraChangedEvent 

Definition at line 52 of file vtkMRMLCameraDisplayableManager.h.

Constructor & Destructor Documentation

◆ vtkMRMLCameraDisplayableManager()

vtkMRMLCameraDisplayableManager::vtkMRMLCameraDisplayableManager ( )
protected

◆ ~vtkMRMLCameraDisplayableManager()

vtkMRMLCameraDisplayableManager::~vtkMRMLCameraDisplayableManager ( )
overrideprotected

Member Function Documentation

◆ AdditionalInitializeStep()

void vtkMRMLCameraDisplayableManager::AdditionalInitializeStep ( )
overrideprotectedvirtual

Sub-class could overload that function and perform additional initialization steps

Note
Called by SetRenderer()
Initialization occurs before the MRMLDisplayableNode is set and observed
Warning
That function should NOT be used directly !
See also
SetRenderer

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ CanProcessInteractionEvent()

bool vtkMRMLCameraDisplayableManager::CanProcessInteractionEvent ( vtkMRMLInteractionEventData eventData,
double &  distance2 
)
overridevirtual

Return true if the displayable manager can process the event. Distance2 is the squared distance in display coordinates from the closest interaction position. The displayable manager with the closest distance will get the chance to process the interaction event.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ Create()

void vtkMRMLCameraDisplayableManager::Create ( )
overrideprotectedvirtual

Called after a valid MRML DisplayableNode is set. By default it simulates a ModifiedEvent event on the displayable node so that ProcessMRMLNodesEvents(displayableNode, ModifiedEvent) is called.

Note
GetRenderer() and GetMRMLDisplayableNode() will return valid object

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ GetCameraNode()

vtkMRMLCameraNode* vtkMRMLCameraDisplayableManager::GetCameraNode ( )

◆ GetCameraWidget()

vtkMRMLCameraWidget* vtkMRMLCameraDisplayableManager::GetCameraWidget ( )

◆ GetClassName()

virtual const char* vtkMRMLCameraDisplayableManager::GetClassName ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLCameraDisplayableManager* vtkMRMLCameraDisplayableManager::New ( )
static

◆ OnMRMLNodeModified()

void vtkMRMLCameraDisplayableManager::OnMRMLNodeModified ( vtkMRMLNode )
overrideprotectedvirtual

Called after the corresponding MRML event is triggered.

See also
ProcessMRMLNodesEvents

Reimplemented from vtkMRMLAbstractLogic.

◆ OnMRMLSceneEndClose()

void vtkMRMLCameraDisplayableManager::OnMRMLSceneEndClose ( )
overrideprotectedvirtual

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 vtkMRMLCameraDisplayableManager::OnMRMLSceneEndImport ( )
overrideprotectedvirtual

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 vtkMRMLCameraDisplayableManager::OnMRMLSceneEndRestore ( )
overrideprotectedvirtual

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 vtkMRMLCameraDisplayableManager::OnMRMLSceneNodeAdded ( vtkMRMLNode )
overrideprotectedvirtual

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 vtkMRMLCameraDisplayableManager::OnMRMLSceneNodeRemoved ( vtkMRMLNode )
overrideprotectedvirtual

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.

◆ OnMRMLSceneStartImport()

void vtkMRMLCameraDisplayableManager::OnMRMLSceneStartImport ( )
overrideprotectedvirtual

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

See also
ProcessMRMLSceneEvents, SetMRMLSceneInternal
OnMRMLSceneEndImport, OnMRMLSceneNew

Reimplemented from vtkMRMLAbstractLogic.

◆ PrintSelf()

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

◆ ProcessInteractionEvent()

bool vtkMRMLCameraDisplayableManager::ProcessInteractionEvent ( vtkMRMLInteractionEventData eventData)
overridevirtual

Process an interaction event. Returns true if the event should be aborted (not processed any further by other event observers).

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ ProcessMRMLNodesEvents()

void vtkMRMLCameraDisplayableManager::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.

◆ RemoveMRMLObservers()

void vtkMRMLCameraDisplayableManager::RemoveMRMLObservers ( )
overridevirtual

Remove MRML observers.

Reimplemented from vtkMRMLAbstractDisplayableManager.

◆ SafeDownCast()

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

◆ SetAndObserveCameraNode()

void vtkMRMLCameraDisplayableManager::SetAndObserveCameraNode ( vtkMRMLCameraNode newCameraNode)
protected

◆ SetCameraToInteractor()

void vtkMRMLCameraDisplayableManager::SetCameraToInteractor ( )
protected

◆ SetCameraToRenderer()

void vtkMRMLCameraDisplayableManager::SetCameraToRenderer ( )
protected

◆ UpdateCameraNode()

void vtkMRMLCameraDisplayableManager::UpdateCameraNode ( )

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