Inviwo  0.9.10.1
Inviwo documentation
Classes | Public Member Functions | List of all members
inviwo::BaseGLModule Class Reference
+ Inheritance diagram for inviwo::BaseGLModule:

Public Member Functions

 BaseGLModule (InviwoApplication *app)
 
virtual int getVersion () const override
 
virtual std::unique_ptr< VersionConverter > getConverter (int version) const override
 
- Public Member Functions inherited from inviwo::InviwoModule
 InviwoModule (InviwoApplication *app, const std::string &identifier)
 
 InviwoModule (const InviwoModule &)=delete
 
InviwoModule & operator= (const InviwoModule &)=delete
 
std::string getIdentifier () const
 Get module identifier, i.e the module folder name.
 
virtual std::string getDescription () const
 
virtual std::string getPath () const
 
std::string getPath (ModulePath type) const
 
const std::vector< CameraFactoryObject * > getCameras () const
 
const std::vector< Capabilities * > getCapabilities () const
 
const std::vector< DataReader * > getDataReaders () const
 
const std::vector< DataWriter * > getDataWriters () const
 
const std::vector< DialogFactoryObject * > getDialogs () const
 
const std::vector< MeshDrawer * > getDrawers () const
 
const std::vector< MetaData * > getMetaData () const
 
const std::vector< InportFactoryObject * > getInports () const
 
const std::vector< OutportFactoryObject * > getOutports () const
 
const std::vector< PortInspectorFactoryObject * > getPortInspectors () const
 
const std::vector< ProcessorFactoryObject * > getProcessors () const
 
const std::vector< ProcessorWidgetFactoryObject * > getProcessorWidgets () const
 
const std::vector< PropertyFactoryObject * > getProperties () const
 
const std::vector< PropertyWidgetFactoryObject * > getPropertyWidgets () const
 
const std::vector< BaseRepresentationFactoryObject * > getRepresentationFactoryObjects () const
 
const std::vector< BaseRepresentationFactory * > getRepresentationFactories () const
 
const std::vector< BaseRepresentationConverter * > getRepresentationConverters () const
 
const std::vector< BaseRepresentationConverterFactory * > getRepresentationConverterFactories () const
 
const std::vector< Settings * > & getSettings () const
 
void registerCapabilities (std::unique_ptr< Capabilities > info)
 
void registerCamera (std::unique_ptr< CameraFactoryObject > camera)
 
template<typename T >
void registerCamera (const std::string &classIdentifier)
 
void registerDataReader (std::unique_ptr< DataReader > reader)
 
void registerDataWriter (std::unique_ptr< DataWriter > writer)
 
void registerDialog (std::unique_ptr< DialogFactoryObject > dialog)
 
template<typename T >
void registerDialog (std::string classIdentifier)
 
void registerDrawer (std::unique_ptr< MeshDrawer > drawer)
 
void registerMetaData (std::unique_ptr< MetaData > meta)
 
void registerProcessor (std::unique_ptr< ProcessorFactoryObject > pfo)
 
template<typename T >
void registerProcessor ()
 
void registerCompositeProcessor (const std::string &file)
 
void registerProcessorWidget (std::unique_ptr< ProcessorWidgetFactoryObject > widget)
 
template<typename T , typename P >
void registerProcessorWidget ()
 
void registerPortInspector (std::string portClassIdentifier, std::string inspectorPath)
 
void registerDataVisualizer (std::unique_ptr< DataVisualizer > visualizer)
 
void registerInport (std::unique_ptr< InportFactoryObject > inport)
 
void registerOutport (std::unique_ptr< OutportFactoryObject > outport)
 
template<typename T >
void registerPort ()
 
template<typename T >
void registerDefaultsForDataType ()
 
void registerProperty (std::unique_ptr< PropertyFactoryObject > property)
 
template<typename T >
void registerProperty ()
 
void registerPropertyWidget (std::unique_ptr< PropertyWidgetFactoryObject > propertyWidget)
 
template<typename T , typename P >
void registerPropertyWidget (PropertySemantics semantics)
 
template<typename T , typename P >
void registerPropertyWidget (std::string semantics)
 
void registerPropertyConverter (std::unique_ptr< PropertyConverter > propertyConverter)
 
template<typename BaseRepr >
void registerRepresentationFactoryObject (std::unique_ptr< RepresentationFactoryObject< BaseRepr >> representation)
 
void registerRepresentationFactory (std::unique_ptr< BaseRepresentationFactory > representationFactory)
 
template<typename BaseRepr >
void registerRepresentationConverter (std::unique_ptr< RepresentationConverter< BaseRepr >> converter)
 
void registerRepresentationConverterFactory (std::unique_ptr< BaseRepresentationConverterFactory > converterFactory)
 
void registerSettings (std::unique_ptr< Settings > settings)
 
void registerSettings (Settings *settings)
 
InviwoApplication * getInviwoApplication () const
 

Additional Inherited Members

- Protected Attributes inherited from inviwo::InviwoModule
InviwoApplication * app_
 

Member Function Documentation

◆ getConverter()

std::unique_ptr< VersionConverter > inviwo::BaseGLModule::getConverter ( int  oldModuleVersion) const
overridevirtual

Should return a converter that updates a processor network from the oldModuleVersion to the current module version returned by getVersion. You need to overload this together with getVersion to implement conversioning for the module. This is needed whenever you modify a processor in such a was as breaking the deserialization of a old network. For example by changing the identifier of a property. By the default it will return a nullptr. Since there is no need to convert to version 0. Look at BaseModule for an example of this in use.

Reimplemented from inviwo::InviwoModule.

◆ getVersion()

int inviwo::BaseGLModule::getVersion ( ) const
overridevirtual

Returns the module version. This is used for converting old processor networks in connection with the getConverter function. By default it will return 0. Overload this function to return a larger value when you need to update the module version.

Reimplemented from inviwo::InviwoModule.

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