This module is intended to be a simple template and example module. More...

#include <WMTemplate.h>

Inheritance diagram for WMTemplate:

Collaboration diagram for WMTemplate:

Classes
class	SafeUpdateCallback
	Node callback to change the color of the shapes inside the root node. More...

class	StringLength
	This shows how to write custom constraints for your modules. More...

class	TranslateCallback
	Node callback to change the position of the shapes in the coordinate system of the scene. More...

Public Member Functions
	WMTemplate ()
	Default constructor. More...

virtual	~WMTemplate ()
	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< WModule >	factory () 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 InputConnectorList &	getInputConnectors () const
	Gives back input connectors. More...

std::shared_ptr< WModuleInputConnector >	getInputConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleInputConnector >	findInputConnector (std::string name)
	Finds the named connector for the module. More...

const OutputConnectorList &	getOutputConnectors () const
	Gives back output connectors. More...

std::shared_ptr< WModuleOutputConnector >	getOutputConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleOutputConnector >	findOutputConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleConnector >	getConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WModuleConnector >	findConnector (std::string name)
	Finds the named connector for the module. More...

std::shared_ptr< WProperties >	getProperties () const
	Return a pointer to the properties object of the module. More...

std::shared_ptr< WProperties >	getInformationProperties () const
	Return a pointer to the information properties object of the module. More...

const WBoolFlag &	isInitialized () const
	Determines whether the module instance is properly initialized. More...

const WBoolFlag &	isUseable () const
	Checks whether the module instance is ready to be used. More...

const WBoolFlag &	isAssociated () const
	Checks whether this module is associated with an container. More...

const WBoolFlag &	isReady () const
	Checks whether this module is ready. More...

const WBoolFlag &	isReadyOrCrashed () const
	This is the logical or of isReady and isCrashed. More...

const WBoolFlag &	isRunning () 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< WModuleContainer >	getAssociatedContainer () 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< WProgressCombiner >	getRootProgressCombiner ()
	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 WRequirement *	checkRequirements () 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 WBoolFlag &	isCrashed () 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...

virtual void	activate ()
	Callback for m_active. 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 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...

Protected Attributes
osg::ref_ptr< WGEManagedGroupNode >	m_rootNode
	The root node used for this modules graphics. More...

osg::ref_ptr< osg::Geode >	m_geode
	The geometry rendered by this module. More...

Protected Attributes inherited from WModule
std::shared_ptr< WProperties >	m_properties
	The property object for the module. More...

std::shared_ptr< WProperties >	m_infoProperties
	The property object for the module containing only module whose purpose is "PV_PURPOSE_INFORMNATION". More...

std::shared_ptr< WProgressCombiner >	m_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< WProgress >	m_readyProgress
	Progress indicator for the "ready" state. More...

WConditionSet	m_moduleState
	The internal state of the module. More...

std::shared_ptr< WModuleContainer >	m_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...

Private Types
typedef WItemSelectionItemTyped< std::string >	MyItemType
	You should typedef the item type you use. More...

Private Member Functions
void	hideButtonPressed ()
	The callback triggering the hide flag of m_aColor for demonstration. More...

Private Attributes
std::shared_ptr< WModuleInputData< WDataSetSingle > >	m_input
	An input connector used to get datasets from other modules. More...

std::shared_ptr< WModuleOutputData< WDataSetSingle > >	m_output
	The output connector used to provide the calculated data to other modules. More...

std::shared_ptr< WCondition >	m_propCondition
	A condition used to notify about changes in several properties. More...

WPropGroup	m_group1
	To group properties, use WPropGroup. More...

WPropGroup	m_group1a
	To group properties, use WPropGroup. More...

WPropGroup	m_group2
	To group properties, use WPropGroup. More...

WPropBool	m_enableFeature
	En/Disables an feature. More...

WPropBool	m_group1Bool
	A nice feature trigger inside m_group1. More...

WPropInt	m_anInteger
	An integer value. More...

WPropInt	m_anIntegerClone
	An integer value. More...

WPropDouble	m_aDouble
	A double value. More...

WPropString	m_aString
	A string. More...

WPropFilename	m_aFile
	A filename. More...

WPropColor	m_aColor
	A color. More...

WPropInt	m_aHiddenInt
	A int property used to show hide/un-hide feature. More...

WPropGroup	m_aHiddenGroup
	A group used to show that even hiding whole groups is possible. More...

WPropTrigger	m_aTrigger
	A trigger which can be used to trigger some kind of operation. More...

WPropSelection	m_aSingleSelection
	A property allowing the user to select ONE item of some list. More...

WPropSelection	m_aSingleSelectionUsingTypes
	A property allowing the user to select ONE item. More...

WPropSelection	m_aMultiSelection
	A property allowing the user to select multiple elements of a list. More...

WPropInt	m_aIntegerOutput
	A property simply providing a integer value to the outside world. More...

WPropDouble	m_aDoubleOutput
	A property simply providing a double value to the outside world. More...

WPropInt	m_aIntOutput
	A property simply providing a int value to the outside world. More...

WPropString	m_aStringOutput
	A property simply providing some text to the outside world. More...

WPropColor	m_aColorOutput
	A Property used to show some color to the user. More...

WPropPosition	m_aPosition
	A Property used to store some position. More...

WPropFilename	m_aFilenameOutput
	A Property used to show some filename to the user. More...

WPropTrigger	m_aTriggerOutput
	A Property used to show some trigger to the user. More...

WPropSelection	m_aSelectionOutput
	A Property used to show some selection to the user. More...

std::shared_ptr< WItemSelection >	m_possibleSelections
	A list of items that can be selected using m_aSingleSelection or m_aMultiSelection. More...

std::shared_ptr< WItemSelection >	m_possibleSelectionsUsingTypes
	A list of items that can be selected using m_aSingleSelectionUsingTypes property. More...

WPropTrigger	m_hideButton
	A Property used to show the callback mechanism avoiding the thread wake up on change. More...

WPropTrigger	m_exceptionTrigger
	This causes an exception to be thrown on press to demonstrate how the GUI handles crashing modules. More...

WPropInterval	m_anInterval
	A property allowing you to define whole intervals. More...

WGEShader::RefPtr	m_shader
	We want some nice shading effects, so we need a nice shader. 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< WModule >	SPtr
	Shared pointer to a WModule. More...

typedef std::shared_ptr< const WModule >	ConstSPtr
	Shared pointer to a const WModule. More...

Public Types inherited from WThreadedRunner
typedef std::shared_ptr< WThreadedRunner >	SPtr
	Abbreviation to a shared_ptr to this type. More...

typedef std::shared_ptr< const WThreadedRunner >	ConstSPtr
	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...

Detailed Description

This module is intended to be a simple template and example module.

It can be used for fast creation of new modules by copying and refactoring the files. It shows the basic usage of properties, update callbacks and how to wait for data.

Definition at line 52 of file WMTemplate.h.

Member Typedef Documentation

◆ MyItemType

typedef WItemSelectionItemTyped< std::string > WMTemplate::MyItemType

private

You should typedef the item type you use.

This shortens some code later. We encapsulate a string into an item.

Definition at line 283 of file WMTemplate.h.

Constructor & Destructor Documentation

◆ WMTemplate()

WMTemplate::WMTemplate ( )

Default constructor.

Definition at line 79 of file WMTemplate.cpp.

Referenced by factory().

Here is the caller graph for this function:

◆ ~WMTemplate()

WMTemplate::~WMTemplate ( )

virtual

Destructor.

Definition at line 88 of file WMTemplate.cpp.

Member Function Documentation

◆ activate()

void WMTemplate::activate ( )

protectedvirtual

Callback for m_active.

Overwrite this in your modules to handle m_active changes separately.

Reimplemented from WModule.

Definition at line 827 of file WMTemplate.cpp.

References WModule::activate(), WModule::debugLog(), and WModule::m_active.

Here is the call graph for this function:

◆ connectors()

void WMTemplate::connectors ( )

protectedvirtual

Initialize the connectors this module is using.

Reimplemented from WModule.

Definition at line 146 of file WMTemplate.cpp.

References WModule::connectors(), WModuleInputData< T >::createAndAdd(), m_input, and m_output.

Here is the call graph for this function:

◆ factory()

std::shared_ptr< WModule > WMTemplate::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 93 of file WMTemplate.cpp.

References WMTemplate().

Here is the call graph for this function:

◆ getDescription()

const std::string WMTemplate::getDescription ( ) const

virtual

Gives back a description of this module.

Returns: description to module.

Implements WPrototyped.

Definition at line 140 of file WMTemplate.cpp.

◆ getName()

const std::string WMTemplate::getName ( ) const

virtual

Gives back the name of this module.

Returns: the module's name.

Implements WPrototyped.

Definition at line 134 of file WMTemplate.cpp.

◆ getXPMIcon()

const char ** WMTemplate::getXPMIcon ( ) const

virtual

Get the icon for this module in XPM format.

Returns: The icon.

Reimplemented from WModule.

Definition at line 125 of file WMTemplate.cpp.

◆ hideButtonPressed()

void WMTemplate::hideButtonPressed ( )

private

The callback triggering the hide flag of m_aColor for demonstration.

Definition at line 846 of file WMTemplate.cpp.

References m_aColor, m_aHiddenGroup, m_aHiddenInt, m_hideButton, WPVBaseTypes::PV_TRIGGER_READY, and WPVBaseTypes::PV_TRIGGER_TRIGGERED.

Referenced by properties().

Here is the caller graph for this function:

◆ moduleMain()

void WMTemplate::moduleMain ( )

protectedvirtual

Entry point after loading the module.

Runs in separate thread.

Implements WModule.

Definition at line 389 of file WMTemplate.cpp.

References WConditionSet::add(), WItemSelector::at(), WModule::debugLog(), WKernel::getGraphicsEngine(), WInterval< T >::getLower(), WModule::getMetaInformation(), WKernel::getRunningKernel(), WInterval< T >::getUpper(), WModule::infoLog(), WModule::m_active, m_aDouble, m_aFile, m_aIntegerOutput, m_aMultiSelection, m_anInteger, m_anIntegerClone, m_anInterval, m_aSingleSelection, m_aSingleSelectionUsingTypes, m_aString, m_aTrigger, m_aTriggerOutput, m_exceptionTrigger, m_geode, m_input, WModule::m_localPath, WModule::m_moduleState, m_output, m_possibleSelections, WModule::m_progress, m_propCondition, m_rootNode, m_shader, WThreadedRunner::m_shutdownFlag, WPVBaseTypes::PV_TRIGGER_READY, WPVBaseTypes::PV_TRIGGER_TRIGGERED, WModule::ready(), WConditionSet::setResetable(), WItemSelector::size(), WThreadedRunner::sleep(), WConditionSet::wait(), and WModule::waitRestored().

Here is the call graph for this function:

◆ properties()

void WMTemplate::properties ( )

protectedvirtual

Initialize the properties for this module.

Reimplemented from WModule.

Definition at line 177 of file WMTemplate.cpp.

References WPropertyHelper::PC_PATHEXISTS::addTo(), WPropertyHelper::PC_ISDIRECTORY::addTo(), WPropertyHelper::PC_SELECTONLYONE::addTo(), WPropertyHelper::PC_NOTEMPTY::addTo(), WItemSelectionItemTyped< T >::create(), WPathHelper::getAppPath(), hideButtonPressed(), m_aColor, m_aColorOutput, m_aDouble, m_aDoubleOutput, m_aFile, m_aFilenameOutput, m_aHiddenGroup, m_aHiddenInt, m_aIntegerOutput, m_aIntOutput, m_aMultiSelection, m_anInteger, m_anIntegerClone, m_anInterval, m_aPosition, m_aSelectionOutput, m_aSingleSelection, m_aSingleSelectionUsingTypes, m_aString, m_aStringOutput, m_aTrigger, m_aTriggerOutput, m_enableFeature, m_exceptionTrigger, m_group1, m_group1a, m_group1Bool, m_group2, m_hideButton, WModule::m_infoProperties, m_possibleSelections, m_possibleSelectionsUsingTypes, m_propCondition, WModule::m_properties, WModule::properties(), WPVBaseTypes::PV_TRIGGER_READY, and string_utils::toString().

Here is the call graph for this function:

◆ requirements()

void WMTemplate::requirements ( )

protectedvirtual

Initialize requirements for this module.

Reimplemented from WModule.

Definition at line 379 of file WMTemplate.cpp.

References WModule::m_requirements.

Member Data Documentation

◆ m_aColor

WPropColor WMTemplate::m_aColor

private

A color.

Definition at line 196 of file WMTemplate.h.

Referenced by hideButtonPressed(), WMTemplate::SafeUpdateCallback::operator()(), and properties().

◆ m_aColorOutput

WPropColor WMTemplate::m_aColorOutput

private

A Property used to show some color to the user.

Definition at line 253 of file WMTemplate.h.

Referenced by properties().

◆ m_aDouble

WPropDouble WMTemplate::m_aDouble

private

A double value.

Definition at line 181 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aDoubleOutput

WPropDouble WMTemplate::m_aDoubleOutput

private

A property simply providing a double value to the outside world.

Definition at line 238 of file WMTemplate.h.

Referenced by properties().

◆ m_aFile

WPropFilename WMTemplate::m_aFile

private

A filename.

Definition at line 191 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aFilenameOutput

WPropFilename WMTemplate::m_aFilenameOutput

private

A Property used to show some filename to the user.

Definition at line 263 of file WMTemplate.h.

Referenced by properties().

◆ m_aHiddenGroup

WPropGroup WMTemplate::m_aHiddenGroup

private

A group used to show that even hiding whole groups is possible.

Definition at line 206 of file WMTemplate.h.

Referenced by hideButtonPressed(), and properties().

◆ m_aHiddenInt

WPropInt WMTemplate::m_aHiddenInt

private

A int property used to show hide/un-hide feature.

Definition at line 201 of file WMTemplate.h.

Referenced by hideButtonPressed(), and properties().

◆ m_aIntegerOutput

WPropInt WMTemplate::m_aIntegerOutput

private

A property simply providing a integer value to the outside world.

Definition at line 233 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aIntOutput

WPropInt WMTemplate::m_aIntOutput

private

A property simply providing a int value to the outside world.

Definition at line 243 of file WMTemplate.h.

Referenced by properties().

◆ m_aMultiSelection

WPropSelection WMTemplate::m_aMultiSelection

private

A property allowing the user to select multiple elements of a list.

Definition at line 226 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_anInteger

WPropInt WMTemplate::m_anInteger

private

An integer value.

Definition at line 171 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_anIntegerClone

WPropInt WMTemplate::m_anIntegerClone

private

An integer value.

It is synchronized with m_anInteger.

Definition at line 176 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_anInterval

WPropInterval WMTemplate::m_anInterval

private

A property allowing you to define whole intervals.

Definition at line 303 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aPosition

WPropPosition WMTemplate::m_aPosition

private

A Property used to store some position.

Definition at line 258 of file WMTemplate.h.

Referenced by properties().

◆ m_aSelectionOutput

WPropSelection WMTemplate::m_aSelectionOutput

private

A Property used to show some selection to the user.

Definition at line 273 of file WMTemplate.h.

Referenced by properties().

◆ m_aSingleSelection

WPropSelection WMTemplate::m_aSingleSelection

private

A property allowing the user to select ONE item of some list.

Definition at line 216 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aSingleSelectionUsingTypes

WPropSelection WMTemplate::m_aSingleSelectionUsingTypes

private

A property allowing the user to select ONE item.

This additionally demonstrates how to use your own types/classes in selections.

Definition at line 221 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aString

WPropString WMTemplate::m_aString

private

A string.

Definition at line 186 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aStringOutput

WPropString WMTemplate::m_aStringOutput

private

A property simply providing some text to the outside world.

Definition at line 248 of file WMTemplate.h.

Referenced by properties().

◆ m_aTrigger

WPropTrigger WMTemplate::m_aTrigger

private

A trigger which can be used to trigger some kind of operation.

Definition at line 211 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_aTriggerOutput

WPropTrigger WMTemplate::m_aTriggerOutput

private

A Property used to show some trigger to the user.

Definition at line 268 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_enableFeature

WPropBool WMTemplate::m_enableFeature

private

En/Disables an feature.

Definition at line 161 of file WMTemplate.h.

Referenced by properties().

◆ m_exceptionTrigger

WPropTrigger WMTemplate::m_exceptionTrigger

private

This causes an exception to be thrown on press to demonstrate how the GUI handles crashing modules.

Definition at line 298 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_geode

osg::ref_ptr< osg::Geode > WMTemplate::m_geode

protected

The geometry rendered by this module.

Definition at line 120 of file WMTemplate.h.

Referenced by moduleMain().

◆ m_group1

WPropGroup WMTemplate::m_group1

private

To group properties, use WPropGroup.

Definition at line 146 of file WMTemplate.h.

Referenced by properties().

◆ m_group1a

WPropGroup WMTemplate::m_group1a

private

To group properties, use WPropGroup.

Definition at line 151 of file WMTemplate.h.

Referenced by properties().

◆ m_group1Bool

WPropBool WMTemplate::m_group1Bool

private

A nice feature trigger inside m_group1.

Definition at line 166 of file WMTemplate.h.

Referenced by properties().

◆ m_group2

WPropGroup WMTemplate::m_group2

private

To group properties, use WPropGroup.

Definition at line 156 of file WMTemplate.h.

Referenced by properties().

◆ m_hideButton

WPropTrigger WMTemplate::m_hideButton

private

A Property used to show the callback mechanism avoiding the thread wake up on change.

Definition at line 293 of file WMTemplate.h.

Referenced by hideButtonPressed(), and properties().

◆ m_input

std::shared_ptr< WModuleInputData< WDataSetSingle > > WMTemplate::m_input

private

An input connector used to get datasets from other modules.

The connection management between connectors must not be handled by the module.

Definition at line 131 of file WMTemplate.h.

Referenced by connectors(), and moduleMain().

◆ m_output

std::shared_ptr< WModuleOutputData< WDataSetSingle > > WMTemplate::m_output

private

The output connector used to provide the calculated data to other modules.

Definition at line 136 of file WMTemplate.h.

Referenced by connectors(), and moduleMain().

◆ m_possibleSelections

std::shared_ptr< WItemSelection > WMTemplate::m_possibleSelections

private

A list of items that can be selected using m_aSingleSelection or m_aMultiSelection.

Definition at line 278 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_possibleSelectionsUsingTypes

std::shared_ptr< WItemSelection > WMTemplate::m_possibleSelectionsUsingTypes

private

A list of items that can be selected using m_aSingleSelectionUsingTypes property.

Definition at line 288 of file WMTemplate.h.

Referenced by properties().

◆ m_propCondition

std::shared_ptr< WCondition > WMTemplate::m_propCondition

private

A condition used to notify about changes in several properties.

Definition at line 141 of file WMTemplate.h.

Referenced by moduleMain(), and properties().

◆ m_rootNode

osg::ref_ptr< WGEManagedGroupNode > WMTemplate::m_rootNode

protected

The root node used for this modules graphics.

For OSG nodes, always use osg::ref_ptr to ensure proper resource management.

Definition at line 115 of file WMTemplate.h.

Referenced by moduleMain().

◆ m_shader

WGEShader::RefPtr WMTemplate::m_shader

private

We want some nice shading effects, so we need a nice shader.

Definition at line 313 of file WMTemplate.h.

Referenced by moduleMain().

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MyItemType

Constructor & Destructor Documentation

◆ WMTemplate()

◆ ~WMTemplate()

Member Function Documentation

◆ activate()

◆ connectors()

◆ factory()

◆ getDescription()

◆ getName()

◆ getXPMIcon()

◆ hideButtonPressed()

◆ moduleMain()

◆ properties()

◆ requirements()

Member Data Documentation

◆ m_aColor

◆ m_aColorOutput

◆ m_aDouble

◆ m_aDoubleOutput

◆ m_aFile

◆ m_aFilenameOutput

◆ m_aHiddenGroup

◆ m_aHiddenInt

◆ m_aIntegerOutput

◆ m_aIntOutput

◆ m_aMultiSelection

◆ m_anInteger

◆ m_anIntegerClone

◆ m_anInterval

◆ m_aPosition

◆ m_aSelectionOutput

◆ m_aSingleSelection

◆ m_aSingleSelectionUsingTypes

◆ m_aString

◆ m_aStringOutput

◆ m_aTrigger

◆ m_aTriggerOutput

◆ m_enableFeature

◆ m_exceptionTrigger

◆ m_geode

◆ m_group1

◆ m_group1a

◆ m_group1Bool

◆ m_group2

◆ m_hideButton

◆ m_input

◆ m_output

◆ m_possibleSelections

◆ m_possibleSelectionsUsingTypes

◆ m_propCondition

◆ m_rootNode

◆ m_shader