Slicer  4.8
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 Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes
vtkMRMLDisplayableManagerGroup Class Reference

DisplayableManagerGroup is a collection of DisplayableManager. More...

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

Inheritance diagram for vtkMRMLDisplayableManagerGroup:
Inheritance graph
Collaboration diagram for vtkMRMLDisplayableManagerGroup:
Collaboration graph

Public Types

typedef vtkObject Superclass

Public Member Functions

void AddDisplayableManager (vtkMRMLAbstractDisplayableManager *displayableManager)
 Add a DisplayableManager and initialize it if required. More...
virtual const char * GetClassName ()
vtkMRMLAbstractDisplayableManagerGetDisplayableManagerByClassName (const char *className)
 Return a DisplayableManager given its class name. More...
int GetDisplayableManagerCount ()
 Return the number of DisplayableManager already added to the group. More...
vtkRenderWindowInteractor * GetInteractor ()
 Convenient method to get the WindowInteractor associated with the Renderer. More...
virtual vtkMRMLLightBoxRendererManagerProxyGetLightBoxRendererManagerProxy ()
vtkMRMLNodeGetMRMLDisplayableNode ()
 Set / Get MRML Displayable Node. More...
vtkMRMLAbstractDisplayableManagerGetNthDisplayableManager (int n)
vtkRenderer * GetRenderer ()
 Get Renderer. More...
void Initialize (vtkMRMLDisplayableManagerFactory *factory, vtkRenderer *renderer)
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
void RequestRender ()
void SetAndObserveDisplayableManagerFactory (vtkMRMLDisplayableManagerFactory *factory)
 Set and observe DisplayableManager factory. More...
virtual void SetLightBoxRendererManagerProxy (vtkMRMLLightBoxRendererManagerProxy *)
void SetMRMLDisplayableNode (vtkMRMLNode *newMRMLDisplayableNode)
void SetRenderer (vtkRenderer *newRenderer)

Static Public Member Functions

static vtkMRMLAbstractDisplayableManagerInstantiateDisplayableManager (const char *displayableManagerName)
static bool IsADisplayableManager (const char *displayableManagerName)
static int IsTypeOf (const char *type)
static vtkMRMLDisplayableManagerGroupNew ()
static vtkMRMLDisplayableManagerGroupSafeDownCast (vtkObject *o)

Protected Types

typedef vtkMRMLDisplayableManagerGroup Self

Protected Member Functions

void onDisplayableManagerFactoryRegisteredEvent (const char *displayableManagerName)
void onDisplayableManagerFactoryUnRegisteredEvent (const char *displayableManagerName)
 vtkMRMLDisplayableManagerGroup ()
virtual ~vtkMRMLDisplayableManagerGroup ()

Static Protected Member Functions

static void DoCallback (vtkObject *vtk_obj, unsigned long event, void *client_data, void *call_data)

Protected Attributes

vtkInternal * Internal

Detailed Description

DisplayableManagerGroup is a collection of DisplayableManager.

It also provides method allowing to either call RenderRequest or SetAndObserveMRMLDisplayableNode on all member of the group. When the displayable managers in the group request the view to be refreshed, the group fires a vtkCommand::UpdateEvent event. This event can be observed and trigger a Render on the render window.

Definition at line 43 of file vtkMRMLDisplayableManagerGroup.h.

Member Typedef Documentation

◆ Self

Definition at line 125 of file vtkMRMLDisplayableManagerGroup.h.

◆ Superclass

Definition at line 48 of file vtkMRMLDisplayableManagerGroup.h.

Constructor & Destructor Documentation

◆ vtkMRMLDisplayableManagerGroup()

vtkMRMLDisplayableManagerGroup::vtkMRMLDisplayableManagerGroup ( )

◆ ~vtkMRMLDisplayableManagerGroup()

virtual vtkMRMLDisplayableManagerGroup::~vtkMRMLDisplayableManagerGroup ( )

Member Function Documentation

◆ AddDisplayableManager()

void vtkMRMLDisplayableManagerGroup::AddDisplayableManager ( vtkMRMLAbstractDisplayableManager displayableManager)

Add a DisplayableManager and initialize it if required.

◆ DoCallback()

static void vtkMRMLDisplayableManagerGroup::DoCallback ( vtkObject *  vtk_obj,
unsigned long  event,
void *  client_data,
void *  call_data 

◆ GetClassName()

virtual const char* vtkMRMLDisplayableManagerGroup::GetClassName ( )

◆ GetDisplayableManagerByClassName()

vtkMRMLAbstractDisplayableManager* vtkMRMLDisplayableManagerGroup::GetDisplayableManagerByClassName ( const char *  className)

Return a DisplayableManager given its class name.

◆ GetDisplayableManagerCount()

int vtkMRMLDisplayableManagerGroup::GetDisplayableManagerCount ( )

Return the number of DisplayableManager already added to the group.

◆ GetInteractor()

vtkRenderWindowInteractor* vtkMRMLDisplayableManagerGroup::GetInteractor ( )

Convenient method to get the WindowInteractor associated with the Renderer.

◆ GetLightBoxRendererManagerProxy()

virtual vtkMRMLLightBoxRendererManagerProxy* vtkMRMLDisplayableManagerGroup::GetLightBoxRendererManagerProxy ( )

Get the LightBoxRendererManagerProxy if one has been provided.

See also
SetLightBoxRendererManagerProxy(vtkMRMLLightBoxRendererManagerProxy *)

◆ GetMRMLDisplayableNode()

vtkMRMLNode* vtkMRMLDisplayableManagerGroup::GetMRMLDisplayableNode ( )

Set / Get MRML Displayable Node.

◆ GetNthDisplayableManager()

vtkMRMLAbstractDisplayableManager* vtkMRMLDisplayableManagerGroup::GetNthDisplayableManager ( int  n)

◆ GetRenderer()

vtkRenderer* vtkMRMLDisplayableManagerGroup::GetRenderer ( )

Get Renderer.

◆ Initialize()

void vtkMRMLDisplayableManagerGroup::Initialize ( vtkMRMLDisplayableManagerFactory factory,
vtkRenderer *  renderer 

Convenient method equivalent to call SetAndObserveDisplayableManagerFactory, SetRenderer, then instantiate and add all displayable managers registered within the factory.

See also
SetAndObserveDisplayableManagerFactory SetRenderer
AddDisplayableManager InstantiateDisplayableManager

◆ InstantiateDisplayableManager()

static vtkMRMLAbstractDisplayableManager* vtkMRMLDisplayableManagerGroup::InstantiateDisplayableManager ( const char *  displayableManagerName)

Returns a new instance of a displayable manager defined by its name: VTK class name or python file name. You are responsible of the returned pointer.

◆ IsA()

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

◆ IsADisplayableManager()

static bool vtkMRMLDisplayableManagerGroup::IsADisplayableManager ( const char *  displayableManagerName)

Returns true if the displayableManagerName corresponds to a valid displayable manager, false otherwise. To be valid, ad displayableManagerName must be the name of a VTK class that derives from vtkMRMLAbstractDisplayableManager or be a valid python script file name.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLDisplayableManagerGroup* vtkMRMLDisplayableManagerGroup::New ( )

◆ onDisplayableManagerFactoryRegisteredEvent()

void vtkMRMLDisplayableManagerGroup::onDisplayableManagerFactoryRegisteredEvent ( const char *  displayableManagerName)

Trigger upon a DisplayableManager is either registered or unregistered from the associated factory

◆ onDisplayableManagerFactoryUnRegisteredEvent()

void vtkMRMLDisplayableManagerGroup::onDisplayableManagerFactoryUnRegisteredEvent ( const char *  displayableManagerName)

◆ PrintSelf()

void vtkMRMLDisplayableManagerGroup::PrintSelf ( ostream &  os,
vtkIndent  indent 

◆ RequestRender()

void vtkMRMLDisplayableManagerGroup::RequestRender ( )

Invoke vtkCommand::UpdateEvent An observer can then listen for that event and "compress" the different Render requests to efficiently call RenderWindow->Render()

See also

◆ SafeDownCast()

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

◆ SetAndObserveDisplayableManagerFactory()

void vtkMRMLDisplayableManagerGroup::SetAndObserveDisplayableManagerFactory ( vtkMRMLDisplayableManagerFactory factory)

Set and observe DisplayableManager factory.

◆ SetLightBoxRendererManagerProxy()

virtual void vtkMRMLDisplayableManagerGroup::SetLightBoxRendererManagerProxy ( vtkMRMLLightBoxRendererManagerProxy )

Set the LightBoxRendererManagerProxy on the DisplayableManagerGroup. This caches the proxy and broadcasts the proxy to all DisplayableManagers in the group. This proxy provides a method GetRenderer(int) that returns the renderer for the ith lightbox pane. The DisplayableManagers use this method to map coordinates to the proper lightbox pane, e.g. in placing crosshairs or annotations in the proper renderer.

◆ SetMRMLDisplayableNode()

void vtkMRMLDisplayableManagerGroup::SetMRMLDisplayableNode ( vtkMRMLNode newMRMLDisplayableNode)

◆ SetRenderer()

void vtkMRMLDisplayableManagerGroup::SetRenderer ( vtkRenderer *  newRenderer)

Set Renderer and Interactor No-op if already initialized.

See also

Member Data Documentation

◆ Internal

vtkInternal* vtkMRMLDisplayableManagerGroup::Internal

Definition at line 133 of file vtkMRMLDisplayableManagerGroup.h.

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