ImFusion::DataAnnotationFactory Class Reference

#include <ImFusion/Base/DataAnnotationFactory.h>

Interface for data annotation factories. More...

Inheritance diagram for ImFusion::DataAnnotationFactory:

Detailed Description

Interface for data annotation factories.

Classes
struct	DataAttribute

Public Member Functions
virtual InteractiveObject *	createDataAnnotation (const std::string &name, Data &data) const =0
	Create data annotation.
virtual std::vector< std::string >	compatibleDataAnnotations (Data &data) const =0
	Return true when a data object supports having a data annotation.
virtual std::string	dataDescription (const Data &) const
	Return a description string to be shown in the data model for a data type.
virtual std::string	dataIconPath (const Data &) const
	Return a file path to an icon representing a data type, may point to a Qt resource.
virtual std::vector< DataAttribute >	dataAttributes (const Data &) const
	Return a list of attributes to be shown in the DataWidget GUI for a data type.
virtual std::unique_ptr< Data >	cloneData (const Data *) const
	Return a clone of a given Data instance.

Member Function Documentation

createDataAnnotation()

virtual InteractiveObject * ImFusion::DataAnnotationFactory::createDataAnnotation ( const std::string & name, Data & data ) const

pure virtual

Create data annotation.

Parameters

data	input data

Returns

pointer to generated annotation if successful, zero otherwise

Implemented in ImFusion::AnatomyPlugin::ASCDataAnnotationFactory, ImFusion::CT::CTDataAnnotationFactory, ImFusion::DefaultDataAnnotationFactory, ImFusion::DicomDataAnnotationFactory, ImFusion::GraphDataAnnotationFactory, ImFusion::SpineDataAnnotationFactory, ImFusion::StreamDataAnnotationFactory, and ImFusion::VisionDataAnnotationFactory.

compatibleDataAnnotations()

virtual std::vector< std::string > ImFusion::DataAnnotationFactory::compatibleDataAnnotations ( Data & data ) const

pure virtual

Return true when a data object supports having a data annotation.

Implemented in ImFusion::AnatomyPlugin::ASCDataAnnotationFactory, ImFusion::CT::CTDataAnnotationFactory, ImFusion::DefaultDataAnnotationFactory, ImFusion::DicomDataAnnotationFactory, ImFusion::GraphDataAnnotationFactory, ImFusion::SpineDataAnnotationFactory, ImFusion::StreamDataAnnotationFactory, and ImFusion::VisionDataAnnotationFactory.

dataDescription()

virtual std::string ImFusion::DataAnnotationFactory::dataDescription ( const Data & ) const

inlinevirtual

Return a description string to be shown in the data model for a data type.

Return an empty string for unsupported types.

Reimplemented in ImFusion::AnatomyPlugin::ASCDataAnnotationFactory, ImFusion::CT::CTDataAnnotationFactory, ImFusion::DefaultDataAnnotationFactory, ImFusion::GraphDataAnnotationFactory, ImFusion::SpineDataAnnotationFactory, ImFusion::StreamDataAnnotationFactory, and ImFusion::VisionDataAnnotationFactory.

dataIconPath()

virtual std::string ImFusion::DataAnnotationFactory::dataIconPath ( const Data & ) const

inlinevirtual

Return a file path to an icon representing a data type, may point to a Qt resource.

Return an empty string for unsupported types.

Reimplemented in ImFusion::AnatomyPlugin::ASCDataAnnotationFactory, ImFusion::CT::CTDataAnnotationFactory, ImFusion::DefaultDataAnnotationFactory, ImFusion::GraphDataAnnotationFactory, ImFusion::SpineDataAnnotationFactory, ImFusion::StreamDataAnnotationFactory, and ImFusion::VisionDataAnnotationFactory.

dataAttributes()

virtual std::vector< DataAttribute > ImFusion::DataAnnotationFactory::dataAttributes ( const Data & ) const

inlinevirtual

Return a list of attributes to be shown in the DataWidget GUI for a data type.

Reimplemented in ImFusion::CT::CTDataAnnotationFactory, ImFusion::DefaultDataAnnotationFactory, ImFusion::StreamDataAnnotationFactory, and ImFusion::VisionDataAnnotationFactory.

cloneData()

virtual std::unique_ptr< Data > ImFusion::DataAnnotationFactory::cloneData ( const Data * ) const

inlinevirtual

Return a clone of a given Data instance.

This allows plugins to expose cloning logics for custom data types to the base ImFusionLib.

Reimplemented in ImFusion::AnatomyPlugin::ASCDataAnnotationFactory, ImFusion::DefaultDataAnnotationFactory, ImFusion::GraphDataAnnotationFactory, ImFusion::SpineDataAnnotationFactory, and ImFusion::VisionDataAnnotationFactory.

---

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

• ImFusion/Base/DataAnnotationFactory.h