A modular component (i.e., node class or type) that is an add-on to the core Vuo framework.
Public Member Functions | |
VuoModule (string moduleKey) | |
Creates a module. | |
string | getModuleKey (void) |
Returns this module's unique name. | |
string | getDefaultDisplayName (void) |
Returns the default display name for instances of this module, as specified by the .bc implementation. | |
void | setDefaultDisplayName (string defaultDisplayName) |
Sets the default display name for instances of this module. | |
string | getDescription (void) |
Returns the description of this module provided as documentation. | |
void | setDescription (string description) |
Sets the description of this module provided as documentation. | |
unsigned int | getVersion (void) |
Returns the module's version, represented as an integer. | |
void | setVersion (unsigned int version) |
Sets the module's version, represented as an integer. | |
vector< string > | getKeywords (void) |
Returns a list of the module's keywords. | |
void | setKeywords (vector< string > keywords) |
Sets the module's keywords. | |
VuoModule::VuoModule | ( | string | moduleKey | ) |
Creates a module.
moduleKey | A unique name for this module. |
string VuoModule::getDefaultDisplayName | ( | void | ) |
Returns the default display name for instances of this module, as specified by the .bc implementation.
Needn't be unique.
UTF-8.
string VuoModule::getDescription | ( | void | ) |
Returns the description of this module provided as documentation.
vector< string > VuoModule::getKeywords | ( | void | ) |
Returns a list of the module's keywords.
unsigned int VuoModule::getVersion | ( | void | ) |
Returns the module's version, represented as an integer.
void VuoModule::setDefaultDisplayName | ( | string | defaultDisplayName | ) |
Sets the default display name for instances of this module.
Needn't be unique.
UTF-8.
void VuoModule::setDescription | ( | string | description | ) |
Sets the description of this module provided as documentation.
void VuoModule::setKeywords | ( | vector< string > | keywords | ) |
Sets the module's keywords.
void VuoModule::setVersion | ( | unsigned int | version | ) |
Sets the module's version, represented as an integer.