vtkMRMLDisplayableManagerFactory Class Reference

Factory where displayable manager classes are registered. More...

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

Inheritance diagram for vtkMRMLDisplayableManagerFactory:

Collaboration diagram for vtkMRMLDisplayableManagerFactory:

Public Types
enum	{ DisplayableManagerFactoryRegisteredEvent = 30100 , DisplayableManagerFactoryUnRegisteredEvent = 30101 }
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
vtkMRMLApplicationLogic *	GetMRMLApplicationLogic () const
int	GetRegisteredDisplayableManagerCount ()
	Return number of registered displayable managers.
std::string	GetRegisteredDisplayableManagerName (int n)
	Return name of the nth registered displayable manager.
vtkMRMLDisplayableManagerGroup *	InstantiateDisplayableManagers (vtkRenderer *newRenderer)
virtual int	IsA (const char *type)
bool	IsDisplayableManagerRegistered (const char *vtkClassName)
void	PrintSelf (ostream &os, vtkIndent indent) override
bool	RegisterDisplayableManager (const char *vtkClassOrScriptName)
void	SetMRMLApplicationLogic (vtkMRMLApplicationLogic *applicationLogic)
bool	UnRegisterDisplayableManager (const char *vtkClassOrScriptName)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLDisplayableManagerFactory *	New ()
static vtkMRMLDisplayableManagerFactory *	SafeDownCast (vtkObject *o)

Protected Types
typedef vtkMRMLDisplayableManagerFactory	Self

Protected Member Functions
	vtkMRMLDisplayableManagerFactory ()
	~vtkMRMLDisplayableManagerFactory () override

Protected Attributes
vtkInternal *	Internal

Detailed Description

Factory where displayable manager classes are registered.

A displayable manager class is responsible to represent a MRMLDisplayable node in a renderer.

Definition at line 37 of file vtkMRMLDisplayableManagerFactory.h.

Member Typedef Documentation

Self

typedef vtkMRMLDisplayableManagerFactory vtkMRMLDisplayableManagerFactory::Self

protected

Definition at line 96 of file vtkMRMLDisplayableManagerFactory.h.

Superclass

typedef vtkObject vtkMRMLDisplayableManagerFactory::Superclass

Definition at line 41 of file vtkMRMLDisplayableManagerFactory.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
DisplayableManagerFactoryRegisteredEvent
DisplayableManagerFactoryUnRegisteredEvent

Definition at line 44 of file vtkMRMLDisplayableManagerFactory.h.

Constructor & Destructor Documentation

vtkMRMLDisplayableManagerFactory()

vtkMRMLDisplayableManagerFactory::vtkMRMLDisplayableManagerFactory ( )

protected

~vtkMRMLDisplayableManagerFactory()

vtkMRMLDisplayableManagerFactory::~vtkMRMLDisplayableManagerFactory ( )

overrideprotected

Member Function Documentation

GetClassName()

virtual const char * vtkMRMLDisplayableManagerFactory::GetClassName ( )

virtual

Reimplemented in vtkMRMLSliceViewDisplayableManagerFactory, and vtkMRMLThreeDViewDisplayableManagerFactory.

GetMRMLApplicationLogic()

vtkMRMLApplicationLogic * vtkMRMLDisplayableManagerFactory::GetMRMLApplicationLogic

(

)

const

GetRegisteredDisplayableManagerCount()

int vtkMRMLDisplayableManagerFactory::GetRegisteredDisplayableManagerCount

(

)

Return number of registered displayable managers.

GetRegisteredDisplayableManagerName()

std::string vtkMRMLDisplayableManagerFactory::GetRegisteredDisplayableManagerName

(

int

n

)

Return name of the nth registered displayable manager.

InstantiateDisplayableManagers()

vtkMRMLDisplayableManagerGroup * vtkMRMLDisplayableManagerFactory::InstantiateDisplayableManagers

(

vtkRenderer *

newRenderer

)

Instantiate registered DisplayableManagers It returns a vtkMRMLDisplayableManagerGroup representing a list of DisplayableManager Internally, the factory keep track of all the Group and will invoke the ModifiedEvent of each group.

IsA()

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

virtual

Reimplemented in vtkMRMLSliceViewDisplayableManagerFactory, and vtkMRMLThreeDViewDisplayableManagerFactory.

IsDisplayableManagerRegistered()

bool vtkMRMLDisplayableManagerFactory::IsDisplayableManagerRegistered

(

const char *

vtkClassName

)

Return True if Displayable Manager identified by vtkClassName is already registered.

IsTypeOf()

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

static

New()

static vtkMRMLDisplayableManagerFactory * vtkMRMLDisplayableManagerFactory::New ( )

static

PrintSelf()

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

override

RegisterDisplayableManager()

bool vtkMRMLDisplayableManagerFactory::RegisterDisplayableManager

(

const char *

vtkClassOrScriptName

)

Register Displayable Manager identified by vtkClassOrScriptName Returns True if displayable manager was successfully registered vtkClassOrScriptName should be either: a VTK class registered using the CMake macro VTK_MAKE_INSTANTIATOR3 a python script having the extension .py Internally for each registered python script, a scripted displayable manager will be instantiated.

SafeDownCast()

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

static

SetMRMLApplicationLogic()

void vtkMRMLDisplayableManagerFactory::SetMRMLApplicationLogic

(

vtkMRMLApplicationLogic *

applicationLogic

)

Set the application logic. It will be passed to displayable managers and groups to be created. The factory only keeps a weak reference to the application logic: the caller must keep it alive while it is used by the factory. This allows deleting the application logic before the factory (factories may be singletons that are only deleted at process exit).

UnRegisterDisplayableManager()

bool vtkMRMLDisplayableManagerFactory::UnRegisterDisplayableManager

(

const char *

vtkClassOrScriptName

)

UnRegister Displayable Manager identified by vtkClassOrScriptName. Returns True if displayable manager was successfully unregistered vtkClassOrScriptName should be either a VTK class registered using the CMake macro VTK_MAKE_INSTANTIATOR3 or a python script name.

Member Data Documentation

Internal

vtkInternal* vtkMRMLDisplayableManagerFactory::Internal

protected

Definition at line 94 of file vtkMRMLDisplayableManagerFactory.h.

---

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

• Libs/MRML/DisplayableManager/vtkMRMLDisplayableManagerFactory.h