Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::CoreObjectFactory Class Reference

The central factory for creating mappers and setting default properties for MITK core data types. More...

#include <mitkCoreObjectFactory.h>

Inheritance diagram for mitk::CoreObjectFactory:
Collaboration diagram for mitk::CoreObjectFactory:

Public Member Functions

 mitkClassMacro (CoreObjectFactory, CoreObjectFactoryBase)
 
Mapper::Pointer CreateMapper (mitk::DataNode *node, MapperSlotId slotId) override
 Create a mapper for the given data node and mapper slot. More...
 
void SetDefaultProperties (mitk::DataNode *node) override
 Set default properties on the given data node. More...
 
virtual void MapEvent (const mitk::Event *event, const int eventID)
 Map a legacy event to an internal event ID. More...
 
virtual void RegisterExtraFactory (CoreObjectFactoryBase *factory)
 Register an additional module-specific object factory. More...
 
virtual void UnRegisterExtraFactory (CoreObjectFactoryBase *factory)
 Unregister a previously registered extra factory. More...
 
 ~CoreObjectFactory () override
 Destructor. More...
 
- Public Member Functions inherited from mitk::CoreObjectFactoryBase
 mitkClassMacroItkParent (CoreObjectFactoryBase, itk::Object)
 
virtual const char * GetITKSourceVersion () const
 Get the ITK source version string. More...
 
virtual const char * GetDescription () const
 Get a human-readable description of this factory. More...
 

Static Public Member Functions

static Pointer New ()
 
static Pointer GetInstance ()
 Return the singleton instance of the CoreObjectFactory. More...
 

Protected Types

typedef std::set< mitk::CoreObjectFactoryBase::Pointer > ExtraFactoriesContainer
 

Protected Member Functions

 CoreObjectFactory ()
 Constructor. More...
 

Protected Attributes

ExtraFactoriesContainer m_ExtraFactories
 

Detailed Description

The central factory for creating mappers and setting default properties for MITK core data types.

Implements the CoreObjectFactoryBase interface. Additional module-specific factories can be registered via RegisterExtraFactory() to extend the set of supported mappers and default properties.

See also
CoreObjectFactoryBase

Definition at line 33 of file mitkCoreObjectFactory.h.

Member Typedef Documentation

◆ ExtraFactoriesContainer

typedef std::set<mitk::CoreObjectFactoryBase::Pointer> mitk::CoreObjectFactory::ExtraFactoriesContainer
protected

Definition at line 89 of file mitkCoreObjectFactory.h.

Constructor & Destructor Documentation

◆ ~CoreObjectFactory()

mitk::CoreObjectFactory::~CoreObjectFactory ( )
override

Destructor.

◆ CoreObjectFactory()

mitk::CoreObjectFactory::CoreObjectFactory ( )
protected

Constructor.

Member Function Documentation

◆ CreateMapper()

Mapper::Pointer mitk::CoreObjectFactory::CreateMapper ( mitk::DataNode *  node,
MapperSlotId  slotId 
)
overridevirtual

Create a mapper for the given data node and mapper slot.

Parameters
nodeThe data node requiring a mapper.
slotIdThe mapper slot (2D or 3D).
Returns
A new mapper instance, or nullptr if no mapper is available.

Implements mitk::CoreObjectFactoryBase.

◆ GetInstance()

static Pointer mitk::CoreObjectFactory::GetInstance ( )
static

Return the singleton instance of the CoreObjectFactory.

Returns
The singleton pointer.

◆ MapEvent()

virtual void mitk::CoreObjectFactory::MapEvent ( const mitk::Event *  event,
const int  eventID 
)
virtual

Map a legacy event to an internal event ID.

Parameters
eventThe event to map.
eventIDThe internal event identifier.

◆ mitkClassMacro()

mitk::CoreObjectFactory::mitkClassMacro ( CoreObjectFactory  ,
CoreObjectFactoryBase   
)

◆ New()

static Pointer mitk::CoreObjectFactory::New ( )
static

◆ RegisterExtraFactory()

virtual void mitk::CoreObjectFactory::RegisterExtraFactory ( CoreObjectFactoryBase *  factory)
virtual

Register an additional module-specific object factory.

The extra factory's mappers and default properties become available through this CoreObjectFactory.

Parameters
factoryThe factory to register.

◆ SetDefaultProperties()

void mitk::CoreObjectFactory::SetDefaultProperties ( mitk::DataNode *  node)
overridevirtual

Set default properties on the given data node.

Parameters
nodeThe data node to configure with default rendering properties.

Implements mitk::CoreObjectFactoryBase.

◆ UnRegisterExtraFactory()

virtual void mitk::CoreObjectFactory::UnRegisterExtraFactory ( CoreObjectFactoryBase *  factory)
virtual

Unregister a previously registered extra factory.

Parameters
factoryThe factory to remove.

Member Data Documentation

◆ m_ExtraFactories

ExtraFactoriesContainer mitk::CoreObjectFactory::m_ExtraFactories
protected

Definition at line 91 of file mitkCoreObjectFactory.h.


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