Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::BaseGLModule Class Reference
Inheritance diagram for inviwo::BaseGLModule:

Public Member Functions

 BaseGLModule (InviwoApplication *app)
virtual std::unique_ptr< VersionConvertergetConverter (int version) const override
virtual int getVersion () const override
Public Member Functions inherited from inviwo::InviwoModule
auto cameras () const
auto capabilities () const
auto dataReaders () const
auto dataWriters () const
auto dialogs () const
auto drawers () 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
virtual std::string getDescription () const
const std::vector< DialogFactoryObject * > getDialogs () const
const std::vector< MeshDrawer * > getDrawers () const
const std::string & getIdentifier () const
 Get module identifier, i.e the module folder name.
const std::vector< InportFactoryObject * > getInports () const
InviwoApplicationgetInviwoApplication () const
const std::vector< MetaData * > getMetaData () const
const std::vector< OutportFactoryObject * > getOutports () const
virtual const std::filesystem::path & getPath () const
std::filesystem::path getPath (ModulePath type) 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< BaseRepresentationConverterFactory * > getRepresentationConverterFactories () const
const std::vector< BaseRepresentationConverter * > getRepresentationConverters () const
const std::vector< BaseRepresentationFactory * > getRepresentationFactories () const
const std::vector< BaseRepresentationFactoryObject * > getRepresentationFactoryObjects () const
const std::vector< Settings * > & getSettings () const
auto inports () const
 InviwoModule (const InviwoModule &)=delete
 InviwoModule (InviwoApplication *app, std::string_view identifier)
 InviwoModule (InviwoModule &&)=delete
auto metadata () const
InviwoModuleoperator= (const InviwoModule &)=delete
InviwoModuleoperator= (InviwoModule &&)=delete
auto outports () const
auto portInspectors () const
auto processors () const
auto processorWidgets () const
auto properties () const
auto propertyConverters () const
auto propertyWidgets () const
template<typename T>
void registerCamera (std::string_view classIdentifier)
void registerCamera (std::unique_ptr< CameraFactoryObject > camera)
void registerCapabilities (std::unique_ptr< Capabilities > info)
void registerCompositeProcessor (const std::filesystem::path &file)
void registerDataReader (std::unique_ptr< DataReader > reader)
void registerDataVisualizer (std::unique_ptr< DataVisualizer > visualizer)
void registerDataWriter (std::unique_ptr< DataWriter > writer)
template<typename T>
void registerDefaultsForDataType ()
template<typename T>
void registerDialog (std::string_view classIdentifier)
void registerDialog (std::unique_ptr< DialogFactoryObject > dialog)
void registerDrawer (std::unique_ptr< MeshDrawer > drawer)
void registerInport (std::unique_ptr< InportFactoryObject > inport)
void registerMetaData (std::unique_ptr< MetaData > meta)
void registerOutport (std::unique_ptr< OutportFactoryObject > outport)
template<typename T>
void registerPort ()
void registerPortInspector (std::string_view portClassIdentifier, const std::filesystem::path &inspectorPath)
template<typename T>
void registerProcessor ()
void registerProcessor (std::unique_ptr< ProcessorFactoryObject > pfo)
template<typename T, typename P>
void registerProcessorWidget ()
void registerProcessorWidget (std::unique_ptr< ProcessorWidgetFactoryObject > widget)
template<typename T>
void registerProperty ()
void registerProperty (std::unique_ptr< PropertyFactoryObject > property)
void registerPropertyConverter (std::unique_ptr< PropertyConverter > propertyConverter)
template<typename T, typename P>
void registerPropertyWidget (PropertySemantics semantics)
template<typename T, typename P>
void registerPropertyWidget (std::string_view semantics)
void registerPropertyWidget (std::unique_ptr< PropertyWidgetFactoryObject > propertyWidget)
template<typename BaseRepr>
void registerRepresentationConverter (std::unique_ptr< RepresentationConverter< BaseRepr > > converter)
void registerRepresentationConverterFactory (std::unique_ptr< BaseRepresentationConverterFactory > converterFactory)
void registerRepresentationFactory (std::unique_ptr< BaseRepresentationFactory > representationFactory)
template<typename BaseRepr>
void registerRepresentationFactoryObject (std::unique_ptr< RepresentationFactoryObject< BaseRepr > > representation)
void registerSettings (Settings *settings)
void registerSettings (std::unique_ptr< Settings > settings)
auto representationConverterFactories () const
auto representationConverters () const
auto representationFactories () const
auto representationFactoryObjects () const

Additional Inherited Members

Protected Attributes inherited from inviwo::InviwoModule
InviwoApplicationapp_

Member Function Documentation

◆ getConverter()

virtual 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()

virtual 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 file:
  • modules/basegl/include/modules/basegl/baseglmodule.h