StreamDataAnnotationFactory Class Reference

#include <ImFusion/Stream/StreamPlugin.h>

Factory for data annotation in the stream plugin. More...

Inheritance diagram for StreamDataAnnotationFactory:

Detailed Description

Factory for data annotation in the stream plugin.

Public Member Functions
InteractiveObject *	createDataAnnotation (const std::string &name, Data &data) const override
	Create data annotation.
std::vector< std::string >	compatibleDataAnnotations (Data &data) const override
	Return true when a data object supports having a data annotation.
std::string	dataDescription (const Data &data) const override
	Return a description string to be shown in the data model for a data type.
std::string	dataIconPath (const Data &data) const override
	Return a file path to an icon representing a data type, may point to a Qt resource.
std::vector< DataAttribute >	dataAttributes (const Data &data) const override
	Return a list of attributes to be shown in the DataWidget GUI for a data type.
Public Member Functions inherited from DataAnnotationFactory
virtual std::unique_ptr< Data >	cloneData (const Data *data) const
	Return a clone of a given Data instance.
Public Member Functions inherited from FactoryBase
	FactoryBase ()
	No license check is performed for the module instantiated with this constructor.
	FactoryBase (std::string module, bool checkLicense=true)
std::string	moduleName () const
	Returns the module name of the factory.

Additional Inherited Members
Protected Member Functions inherited from FactoryBase
virtual	~FactoryBase ()
	Virtual destructor.
std::string	getComponentPath (const std::string &componentName) const
	Returns the path to the component referred to by name.
bool	isLicensed (const std::string &name)
	Return true if the license allows the use of the component referred to by name.
Static Protected Member Functions inherited from FactoryBase
static std::string	getComponentPath (const std::string &moduleName, const std::string &componentName)
	Returns the path to the component referred to by name.
static bool	isLicensed (const std::string &moduleName, const std::string &name)
	Return true if the license allows the use of the component referred to by name.
Protected Attributes inherited from FactoryBase
std::string	m_factoryModule
bool	m_checkLicense

Member Function Documentation

createDataAnnotation()

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

overridevirtual

Create data annotation.

Parameters

data	input data

Returns

pointer to generated annotation if successful, zero otherwise

Implements DataAnnotationFactory.

compatibleDataAnnotations()

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

overridevirtual

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

Implements DataAnnotationFactory.

dataDescription()

std::string dataDescription ( const Data & data ) const

overridevirtual

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

Return an empty string for unsupported types.

Reimplemented from DataAnnotationFactory.

dataIconPath()

std::string dataIconPath ( const Data & data ) const

overridevirtual

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 from DataAnnotationFactory.

dataAttributes()

std::vector< DataAttribute > dataAttributes ( const Data & data ) const

overridevirtual

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

Reimplemented from DataAnnotationFactory.

---

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

• ImFusion/Stream/StreamPlugin.h