ImFusion C++ SDK 4.5.0
ImFusion::VisionDataAnnotationFactory Class Reference

#include <ImFusion/Vision/VisionPlugin.h>

Factory providing data annotations, icons, attributes, and cloning for Vision data types. More...

Inheritance diagram for ImFusion::VisionDataAnnotationFactory:

Detailed Description

Factory providing data annotations, icons, attributes, and cloning for Vision data types.

Public Member Functions

InteractiveObjectcreateDataAnnotation (const std::string &name, Data &data) const override
 Create data annotation.
std::vector< std::stringcompatibleDataAnnotations (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< DataAttributedataAttributes (const Data &data) const override
 Return a list of attributes to be shown in the DataWidget GUI for a data type.
std::unique_ptr< DatacloneData (const Data *data) const override
 Return a clone of a given Data instance.

Member Function Documentation

◆ createDataAnnotation()

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

Create data annotation.

Parameters
datainput data
Returns
pointer to generated annotation if successful, zero otherwise

Implements ImFusion::DataAnnotationFactory.

◆ compatibleDataAnnotations()

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

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

Implements ImFusion::DataAnnotationFactory.

◆ dataDescription()

std::string ImFusion::VisionDataAnnotationFactory::dataDescription ( const 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 ImFusion::DataAnnotationFactory.

◆ dataIconPath()

std::string ImFusion::VisionDataAnnotationFactory::dataIconPath ( const 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 ImFusion::DataAnnotationFactory.

◆ dataAttributes()

std::vector< DataAttribute > ImFusion::VisionDataAnnotationFactory::dataAttributes ( const Data & ) const
overridevirtual

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

Reimplemented from ImFusion::DataAnnotationFactory.

◆ cloneData()

std::unique_ptr< Data > ImFusion::VisionDataAnnotationFactory::cloneData ( const Data * ) const
overridevirtual

Return a clone of a given Data instance.

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

Reimplemented from ImFusion::DataAnnotationFactory.


The documentation for this class was generated from the following file:
  • ImFusion/Vision/VisionPlugin.h
Search Tab / S to search, Esc to close