Vuo
0.8.0
|
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. | |
void | setModuleKey (string moduleKey) |
Sets this module's unique name. | |
string | getDefaultTitle (void) |
Returns the default title for instances of this module, as specified by the .vuonode/.bc implementation. | |
void | setDefaultTitle (string defaultTitle) |
Sets the default title for instances of this module. | |
string | getDescription (void) |
Returns the description given in the module's metadata, or if none is given, the description found in a separate file in the module's node set. | |
void | setDescription (string description) |
Sets the description of this module provided as documentation. | |
string | getVersion (void) |
Returns the module's version, in Semantic Versioning format. | |
void | setVersion (string version) |
Sets the module's version, in Semantic Versioning format. | |
vector< string > | getKeywords (void) |
Returns a list of the module's keywords. | |
void | setKeywords (vector< string > keywords) |
Sets the module's keywords. | |
VuoNodeSet * | getNodeSet (void) |
Returns the node set containing this module. | |
void | setNodeSet (VuoNodeSet *nodeSet) |
Sets the node set containing this module. | |
VuoModule::VuoModule | ( | string | moduleKey | ) |
Creates a module.
moduleKey | A unique name for this module. |
string VuoModule::getDefaultTitle | ( | void | ) |
Returns the default title for instances of this module, as specified by the .vuonode/.bc implementation.
Needn't be unique.
UTF-8.
string VuoModule::getDescription | ( | void | ) |
Returns the description given in the module's metadata, or if none is given, the description found in a separate file in the module's node set.
If this module doesn't have a description, returns an empty string.
vector< string > VuoModule::getKeywords | ( | void | ) |
Returns a list of the module's keywords.
string VuoModule::getModuleKey | ( | void | ) |
Returns this module's unique name.
VuoNodeSet * VuoModule::getNodeSet | ( | void | ) |
Returns the node set containing this module.
string VuoModule::getVersion | ( | void | ) |
Returns the module's version, in Semantic Versioning format.
void VuoModule::setDefaultTitle | ( | string | defaultTitle | ) |
Sets the default title 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::setModuleKey | ( | string | moduleKey | ) |
Sets this module's unique name.
void VuoModule::setNodeSet | ( | VuoNodeSet * | nodeSet | ) |
Sets the node set containing this module.
void VuoModule::setVersion | ( | string | version | ) |
Sets the module's version, in Semantic Versioning format.