OpenWalnut  1.5.0dev
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
WMWebglSupport Class Reference

Someone should add some documentation here. More...

#include <WMWebglSupport.h>

+ Inheritance diagram for WMWebglSupport:
+ Collaboration diagram for WMWebglSupport:

Public Member Functions

 WMWebglSupport ()
 constructor More...
 
virtual ~WMWebglSupport ()
 destructor More...
 
virtual const std::string getName () const
 Gives back the name of this module. More...
 
virtual const std::string getDescription () const
 Gives back a description of this module. More...
 
virtual std::shared_ptr< WModulefactory () const
 Due to the prototype design pattern used to build modules, this method returns a new instance of this method. More...
 
virtual const char ** getXPMIcon () const
 Get the icon for this module in XPM format. More...
 
- Public Member Functions inherited from WModule
 WModule ()
 Constructs a new WModule instance. More...
 
virtual ~WModule ()
 Destructor. More...
 
const InputConnectorListgetInputConnectors () const
 Gives back input connectors. More...
 
std::shared_ptr< WModuleInputConnectorgetInputConnector (std::string name)
 Finds the named connector for the module. More...
 
std::shared_ptr< WModuleInputConnectorfindInputConnector (std::string name)
 Finds the named connector for the module. More...
 
const OutputConnectorListgetOutputConnectors () const
 Gives back output connectors. More...
 
std::shared_ptr< WModuleOutputConnectorgetOutputConnector (std::string name)
 Finds the named connector for the module. More...
 
std::shared_ptr< WModuleOutputConnectorfindOutputConnector (std::string name)
 Finds the named connector for the module. More...
 
std::shared_ptr< WModuleConnectorgetConnector (std::string name)
 Finds the named connector for the module. More...
 
std::shared_ptr< WModuleConnectorfindConnector (std::string name)
 Finds the named connector for the module. More...
 
std::shared_ptr< WPropertiesgetProperties () const
 Return a pointer to the properties object of the module. More...
 
std::shared_ptr< WPropertiesgetInformationProperties () const
 Return a pointer to the information properties object of the module. More...
 
const WBoolFlagisInitialized () const
 Determines whether the module instance is properly initialized. More...
 
const WBoolFlagisUseable () const
 Checks whether the module instance is ready to be used. More...
 
const WBoolFlagisAssociated () const
 Checks whether this module is associated with an container. More...
 
const WBoolFlagisReady () const
 Checks whether this module is ready. More...
 
const WBoolFlagisReadyOrCrashed () const
 This is the logical or of isReady and isCrashed. More...
 
const WBoolFlagisRunning () const
 Returns a flag denoting whether the thread currently is running or nor. More...
 
void waitRestored ()
 This method waits for the module to be restored completely. More...
 
bool isRestoreNeeded () const
 Check whether this module is in restore mode. More...
 
void setRestoreNeeded (bool restore=true)
 Change the restore mode. More...
 
void reportRestoreComplete ()
 Called by loaders to tell the module that loading has been completed. More...
 
std::shared_ptr< WModuleContainergetAssociatedContainer () const
 The container this module is associated with. More...
 
virtual boost::signals2::connection subscribeSignal (MODULE_SIGNAL signal, t_ModuleGenericSignalHandlerType notifier)
 Connects a specified notify function with a signal this module instance is offering. More...
 
virtual boost::signals2::connection subscribeSignal (MODULE_SIGNAL signal, t_ModuleErrorSignalHandlerType notifier)
 Connects a specified notify function with a signal this module instance is offering. More...
 
virtual std::shared_ptr< WProgressCombinergetRootProgressCombiner ()
 Gets the modules base progress. More...
 
virtual MODULE_TYPE getType () const
 Gets the type of the module. More...
 
void disconnect ()
 Completely disconnects all connected connectors of this module. More...
 
WCombinerTypes::WDisconnectList getPossibleDisconnections ()
 Gives a list of all WDisconnectCombiners possible. More...
 
boost::filesystem::path getLocalPath () const
 Returns the local path of the module. More...
 
boost::filesystem::path getLibPath () const
 Returns the absolute path to the library containing this module. More...
 
std::string getPackageName () const
 Returns the name of the package the module belongs to, The package name basically is the name of the library containing this and maybe other modules. More...
 
bool isDeprecated () const
 Checks whether the module was marked as deprecated. More...
 
std::string getDeprecationMessage () const
 Queries the deprecation message of a module if specified. More...
 
virtual WModuleMetaInformation::ConstSPtr getMetaInformation () const
 The meta information of this module. More...
 
const std::string & getUUID () const
 Get the UUID of the module instance. More...
 
WPropString getRuntimeName () const
 Returns the name the user has given this module. More...
 
const WRequirementcheckRequirements () const
 This method checks whether all the requirements of the module are complied. More...
 
virtual boost::signals2::connection subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier)
 Connects a specified notify function with a signal this thread instance is offering. More...
 
- Public Member Functions inherited from WThreadedRunner
 WThreadedRunner ()
 Default constructor. More...
 
virtual ~WThreadedRunner ()
 Destructor. More...
 
virtual void run ()
 Run thread. More...
 
void run (THREADFUNCTION f)
 Run thread. More...
 
void wait (bool requestFinish=false)
 Wait for the thread to be finished. More...
 
virtual void requestStop ()
 This method's purpose is to request a stop without waiting for it. More...
 
virtual boost::signals2::connection subscribeSignal (THREAD_SIGNAL signal, t_ThreadErrorSignalHandlerType notifier)
 Connects a specified notify function with a signal this thread instance is offering. More...
 
const WBoolFlagisCrashed () const
 Checks whether this thread has been crashed. More...
 
const std::string & getCrashMessage () const
 Get the message of the exception finally causing the crash. More...
 
void setThreadName (std::string name)
 Set the name of the thread. More...
 
std::string getThreadName () const
 Returns the current thread name. More...
 
- Public Member Functions inherited from WPrototyped
 WPrototyped ()
 Default constructor. More...
 
virtual ~WPrototyped ()
 Destructor. More...
 
template<typename T >
bool isA ()
 Checks whether the actual prototype has the specified runtime type. More...
 

Protected Member Functions

virtual void moduleMain ()
 Entry point after loading the module. More...
 
virtual void connectors ()
 Initialize the connectors this module is using. More...
 
virtual void properties ()
 Initialize the properties for this module. More...
 
virtual void requirements ()
 Initialize requirements for this module. More...
 
- Protected Member Functions inherited from WModule
void threadMain ()
 Thread entry point. More...
 
virtual void onThreadException (const WException &e)
 This method is called if an exception was caught, which came from the custom thread code. More...
 
void setAssociatedContainer (std::shared_ptr< WModuleContainer > container)
 Sets the container this module is associated with. More...
 
virtual std::string deprecated () const
 This function allows module programmers to mark their modules deprecated in a user-friendly way. More...
 
void initialize ()
 Manages initialization. More...
 
virtual void cleanup ()
 Called whenever the module should shutdown. More...
 
void addConnector (std::shared_ptr< WModuleInputConnector > con)
 Adds the specified connector to the list of inputs. More...
 
void addConnector (std::shared_ptr< WModuleOutputConnector > con)
 Adds the specified connector to the list of outputs. More...
 
void removeConnectors ()
 Removes all connectors properly. More...
 
virtual void activate ()
 Callback for m_active. More...
 
virtual const t_GenericSignalHandlerType getSignalHandler (MODULE_CONNECTOR_SIGNAL signal)
 Gives the signal handler function responsible for a given signal. More...
 
virtual void notifyConnectionEstablished (std::shared_ptr< WModuleConnector > here, std::shared_ptr< WModuleConnector > there)
 Gets called whenever a connector gets connected to the specified input. More...
 
virtual void notifyConnectionClosed (std::shared_ptr< WModuleConnector > here, std::shared_ptr< WModuleConnector > there)
 Gets called whenever a connection between a remote and local connector gets closed. More...
 
virtual void notifyDataChange (std::shared_ptr< WModuleConnector > input, std::shared_ptr< WModuleConnector > output)
 Gets called when the data on one input connector changed. More...
 
void ready ()
 Call this whenever your module is ready and can react on property changes. More...
 
wlog::WStreamedLogger infoLog () const
 Logger instance for comfortable info logging. More...
 
wlog::WStreamedLogger debugLog () const
 Logger instance for comfortable debug logging. More...
 
wlog::WStreamedLogger warnLog () const
 Logger instance for comfortable warning- logs. More...
 
wlog::WStreamedLogger errorLog () const
 Logger instance for comfortable error logging. More...
 
void setLocalPath (boost::filesystem::path path)
 Sets the local module path. More...
 
void setLibPath (boost::filesystem::path path)
 Set the path to the library which contains this module. More...
 
void setPackageName (std::string name)
 Set the package name. More...
 
- Protected Member Functions inherited from WThreadedRunner
virtual void notifyStop ()
 Gets called when the thread should be stopped. More...
 
void yield () const
 Give remaining execution timeslice to another thread. More...
 
void sleep (const int32_t t) const
 Sets thread asleep. More...
 
void msleep (const int32_t t) const
 Sets thread asleep. More...
 
void waitForStop ()
 Let the thread sleep until a stop request was given. More...
 
void handleDeadlyException (const WException &e, std::string sender="WThreadedRunner")
 Handle the specified exception which was not caught in the thread, which basically means the thread has crashed. More...
 

Private Member Functions

void colorTriMeshGray ()
 colors a connected triangle mesh with the connected gray scale texture More...
 
void colorTriMeshRGB ()
 colors a connected triangle mesh with the connected rgb texture More...
 
void saveSlicesGray ()
 saves a connected gray scale 3D texture as set of 2D textures More...
 
void saveSlicesRGB ()
 saves a connected rgb 3D texture as set of 2D textures More...
 

Private Attributes

std::shared_ptr< WModuleInputData< WDataSetScalar > > m_datasetInputScalar
 Input connector required by this module. More...
 
std::shared_ptr< WModuleInputData< WDataSetVector > > m_datasetInputVector
 Input connector required by this module. More...
 
std::shared_ptr< WModuleInputData< WTriangleMesh > > m_meshInput
 Input connector for a mesh. More...
 
std::shared_ptr< WModuleOutputData< WTriangleMesh > > m_meshOutput
 Input connector required by this module. More...
 
std::shared_ptr< WTriangleMeshm_triMesh
 A pointer to the currently processed tri mesh. More...
 
std::shared_ptr< WDataSetScalarm_datasetScalar
 A pointer to the currently processed dataset. More...
 
std::shared_ptr< WDataSetVectorm_datasetVector
 A pointer to the currently processed dataset. More...
 
std::shared_ptr< WConditionm_propCondition
 A condition used to notify about changes in several properties. More...
 
WPropTrigger m_propTriggerSaveGray
 This property triggers the actual writing,. More...
 
WPropTrigger m_propTriggerSaveRGB
 This property triggers the actual writing,. More...
 
WPropFilename m_fileName
 The mesh will be written to this file. More...
 
WPropFilename m_meshFile
 The mesh will be written to this file. More...
 
WPropTrigger m_propTriggerUpdateOutputGray
 This property triggers the actual writing,. More...
 
WPropTrigger m_propTriggerUpdateOutputRGB
 This property triggers the actual writing,. More...
 
std::shared_ptr< WItemSelectionm_fileTypeSelectionsList
 A list of file type selection types. More...
 
WPropSelection m_fileTypeSelection
 Selection property for file types. More...
 

Additional Inherited Members

- Public Types inherited from WModule
typedef std::vector< std::shared_ptr< WModuleInputConnector > > InputConnectorList
 The type for the list of input connectors. More...
 
typedef std::vector< std::shared_ptr< WModuleOutputConnector > > OutputConnectorList
 The type for the list of output connectors. More...
 
typedef std::shared_ptr< WModuleSPtr
 Shared pointer to a WModule. More...
 
typedef std::shared_ptr< const WModuleConstSPtr
 Shared pointer to a const WModule. More...
 
- Public Types inherited from WThreadedRunner
typedef std::shared_ptr< WThreadedRunnerSPtr
 Abbreviation to a shared_ptr to this type. More...
 
typedef std::shared_ptr< const WThreadedRunnerConstSPtr
 Abbreviation to a const shared_ptr to this type. More...
 
typedef boost::function< void(void) > THREADFUNCTION
 Type used for simple thread functions. More...
 
- Static Public Member Functions inherited from WModule
static SPtr findByUUID (std::string uuid)
 Find a module instance by UUID. More...
 
- Static Public Member Functions inherited from WThreadedRunner
static void setThisThreadName (std::string name)
 Static function to set the name of the calling thread. More...
 
- Protected Types inherited from WModule
typedef std::vector< WRequirement * > Requirements
 The type of the requirement list. More...
 
- Protected Attributes inherited from WModule
std::shared_ptr< WPropertiesm_properties
 The property object for the module. More...
 
std::shared_ptr< WPropertiesm_infoProperties
 The property object for the module containing only module whose purpose is "PV_PURPOSE_INFORMNATION". More...
 
std::shared_ptr< WProgressCombinerm_progress
 Progress indicator used as parent for all progress' of this module. More...
 
WBoolFlag m_initialized
 True if everything is initialized and ready to be used. More...
 
WBoolFlag m_isAssociated
 True if container got associated with this flag. More...
 
WBoolFlag m_isUsable
 True if associated && initialized. More...
 
WBoolFlag m_isReady
 True if ready() was called. More...
 
WBoolFlag m_isReadyOrCrashed
 It is true whenever m_isReady or WThreadedRunner::m_isCrashed is true. More...
 
WBoolFlag m_isRunning
 True if the module currently is running. More...
 
WBoolFlag m_isLoadFinished
 Flag to denote whether the module container and the project loader have finished their work. More...
 
bool m_restoreMode
 Flag denoting the current restore mode. More...
 
std::shared_ptr< WProgressm_readyProgress
 Progress indicator for the "ready" state. More...
 
WConditionSet m_moduleState
 The internal state of the module. More...
 
std::shared_ptr< WModuleContainerm_container
 The container this module belongs to. More...
 
InputConnectorList m_inputConnectors
 Set of input connectors associated with this module. More...
 
OutputConnectorList m_outputConnectors
 Set of output connectors associated with this module. More...
 
WPropBool m_active
 True whenever the module should be active. More...
 
WPropString m_runtimeName
 This property holds a user specified name for the current module instance. More...
 
boost::filesystem::path m_localPath
 The path where the module binary resides in. More...
 
boost::filesystem::path m_libPath
 The absolute path to the library containing this module. More...
 
std::string m_packageName
 The name of the lib/the package containing this module. More...
 
Requirements m_requirements
 The list of requirements. More...
 
- Protected Attributes inherited from WThreadedRunner
boost::thread m_thread
 Thread instance. More...
 
WBoolFlag m_shutdownFlag
 Condition getting fired whenever the thread should quit. More...
 
WBoolFlag m_isCrashed
 True whenever an exception is thrown during threadMain. More...
 
std::string m_crashMessage
 The crash message. More...
 

Detailed Description

Someone should add some documentation here.

Probably the best person would be the module's creator, i.e. "ralph".

This is only an empty template for a new module. For an example module containing many interesting concepts and extensive documentation have a look at "src/modules/template"

Definition at line 51 of file WMWebglSupport.h.

Constructor & Destructor Documentation

◆ WMWebglSupport()

WMWebglSupport::WMWebglSupport ( )

constructor

Definition at line 41 of file WMWebglSupport.cpp.

Referenced by factory().

+ Here is the caller graph for this function:

◆ ~WMWebglSupport()

WMWebglSupport::~WMWebglSupport ( )
virtual

destructor

Definition at line 46 of file WMWebglSupport.cpp.

Member Function Documentation

◆ colorTriMeshGray()

void WMWebglSupport::colorTriMeshGray ( )
private

colors a connected triangle mesh with the connected gray scale texture

Definition at line 185 of file WMWebglSupport.cpp.

References m_datasetScalar, and m_triMesh.

Referenced by moduleMain().

+ Here is the caller graph for this function:

◆ colorTriMeshRGB()

void WMWebglSupport::colorTriMeshRGB ( )
private

colors a connected triangle mesh with the connected rgb texture

Definition at line 210 of file WMWebglSupport.cpp.

References WModule::debugLog(), m_datasetVector, and m_triMesh.

Referenced by moduleMain().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ connectors()

void WMWebglSupport::connectors ( )
protectedvirtual

Initialize the connectors this module is using.

Reimplemented from WModule.

Definition at line 74 of file WMWebglSupport.cpp.

References WModule::addConnector(), WModule::connectors(), m_datasetInputScalar, m_datasetInputVector, m_meshInput, and m_meshOutput.

+ Here is the call graph for this function:

◆ factory()

std::shared_ptr< WModule > WMWebglSupport::factory ( ) const
virtual

Due to the prototype design pattern used to build modules, this method returns a new instance of this method.

NOTE: it should never be initialized or modified in some other way. A simple new instance is required.

Returns
the prototype used to create every module in OpenWalnut.

Implements WModule.

Definition at line 51 of file WMWebglSupport.cpp.

References WMWebglSupport().

+ Here is the call graph for this function:

◆ getDescription()

const std::string WMWebglSupport::getDescription ( ) const
virtual

Gives back a description of this module.

Returns
description to module.

Implements WPrototyped.

Definition at line 66 of file WMWebglSupport.cpp.

◆ getName()

const std::string WMWebglSupport::getName ( ) const
virtual

Gives back the name of this module.

Returns
the module's name.

Implements WPrototyped.

Definition at line 61 of file WMWebglSupport.cpp.

◆ getXPMIcon()

const char ** WMWebglSupport::getXPMIcon ( ) const
virtual

Get the icon for this module in XPM format.

Returns
The icon.

Reimplemented from WModule.

Definition at line 57 of file WMWebglSupport.cpp.

◆ moduleMain()

void WMWebglSupport::moduleMain ( )
protectedvirtual

◆ properties()

void WMWebglSupport::properties ( )
protectedvirtual

Initialize the properties for this module.

Reimplemented from WModule.

Definition at line 103 of file WMWebglSupport.cpp.

References WPathHelper::getAppPath(), m_fileName, m_propCondition, WModule::m_properties, m_propTriggerSaveGray, m_propTriggerSaveRGB, m_propTriggerUpdateOutputGray, m_propTriggerUpdateOutputRGB, WModule::properties(), and WPVBaseTypes::PV_TRIGGER_READY.

+ Here is the call graph for this function:

◆ requirements()

void WMWebglSupport::requirements ( )
protectedvirtual

Initialize requirements for this module.

Reimplemented from WModule.

Definition at line 116 of file WMWebglSupport.cpp.

◆ saveSlicesGray()

void WMWebglSupport::saveSlicesGray ( )
private

saves a connected gray scale 3D texture as set of 2D textures

Definition at line 236 of file WMWebglSupport.cpp.

References WModule::debugLog(), m_datasetScalar, m_fileName, and string_utils::toString().

Referenced by moduleMain().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveSlicesRGB()

void WMWebglSupport::saveSlicesRGB ( )
private

saves a connected rgb 3D texture as set of 2D textures

Definition at line 326 of file WMWebglSupport.cpp.

References m_datasetVector, m_fileName, and string_utils::toString().

Referenced by moduleMain().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_datasetInputScalar

std::shared_ptr< WModuleInputData< WDataSetScalar > > WMWebglSupport::m_datasetInputScalar
private

Input connector required by this module.

Definition at line 133 of file WMWebglSupport.h.

Referenced by connectors(), and moduleMain().

◆ m_datasetInputVector

std::shared_ptr< WModuleInputData< WDataSetVector > > WMWebglSupport::m_datasetInputVector
private

Input connector required by this module.

Definition at line 134 of file WMWebglSupport.h.

Referenced by connectors(), and moduleMain().

◆ m_datasetScalar

std::shared_ptr< WDataSetScalar > WMWebglSupport::m_datasetScalar
private

A pointer to the currently processed dataset.

Definition at line 140 of file WMWebglSupport.h.

Referenced by colorTriMeshGray(), moduleMain(), and saveSlicesGray().

◆ m_datasetVector

std::shared_ptr< WDataSetVector > WMWebglSupport::m_datasetVector
private

A pointer to the currently processed dataset.

Definition at line 141 of file WMWebglSupport.h.

Referenced by colorTriMeshRGB(), moduleMain(), and saveSlicesRGB().

◆ m_fileName

WPropFilename WMWebglSupport::m_fileName
private

The mesh will be written to this file.

Definition at line 147 of file WMWebglSupport.h.

Referenced by properties(), saveSlicesGray(), and saveSlicesRGB().

◆ m_fileTypeSelection

WPropSelection WMWebglSupport::m_fileTypeSelection
private

Selection property for file types.

Definition at line 161 of file WMWebglSupport.h.

◆ m_fileTypeSelectionsList

std::shared_ptr< WItemSelection > WMWebglSupport::m_fileTypeSelectionsList
private

A list of file type selection types.

Definition at line 156 of file WMWebglSupport.h.

◆ m_meshFile

WPropFilename WMWebglSupport::m_meshFile
private

The mesh will be written to this file.

Definition at line 148 of file WMWebglSupport.h.

◆ m_meshInput

std::shared_ptr< WModuleInputData< WTriangleMesh > > WMWebglSupport::m_meshInput
private

Input connector for a mesh.

Definition at line 136 of file WMWebglSupport.h.

Referenced by connectors(), and moduleMain().

◆ m_meshOutput

std::shared_ptr< WModuleOutputData< WTriangleMesh > > WMWebglSupport::m_meshOutput
private

Input connector required by this module.

Definition at line 137 of file WMWebglSupport.h.

Referenced by connectors(), and moduleMain().

◆ m_propCondition

std::shared_ptr< WCondition > WMWebglSupport::m_propCondition
private

A condition used to notify about changes in several properties.

Definition at line 143 of file WMWebglSupport.h.

Referenced by moduleMain(), and properties().

◆ m_propTriggerSaveGray

WPropTrigger WMWebglSupport::m_propTriggerSaveGray
private

This property triggers the actual writing,.

Definition at line 145 of file WMWebglSupport.h.

Referenced by moduleMain(), and properties().

◆ m_propTriggerSaveRGB

WPropTrigger WMWebglSupport::m_propTriggerSaveRGB
private

This property triggers the actual writing,.

Definition at line 146 of file WMWebglSupport.h.

Referenced by moduleMain(), and properties().

◆ m_propTriggerUpdateOutputGray

WPropTrigger WMWebglSupport::m_propTriggerUpdateOutputGray
private

This property triggers the actual writing,.

Definition at line 150 of file WMWebglSupport.h.

Referenced by moduleMain(), and properties().

◆ m_propTriggerUpdateOutputRGB

WPropTrigger WMWebglSupport::m_propTriggerUpdateOutputRGB
private

This property triggers the actual writing,.

Definition at line 151 of file WMWebglSupport.h.

Referenced by moduleMain(), and properties().

◆ m_triMesh

std::shared_ptr< WTriangleMesh > WMWebglSupport::m_triMesh
private

A pointer to the currently processed tri mesh.

Definition at line 139 of file WMWebglSupport.h.

Referenced by colorTriMeshGray(), colorTriMeshRGB(), and moduleMain().


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