Vuo  0.4.8
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
VuoModule Class Reference

Description

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 .vuonode/.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.
 
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.
 

Constructor & Destructor Documentation

VuoModule::VuoModule ( string  moduleKey)

Creates a module.

Parameters
moduleKeyA unique name for this module.

Member Function Documentation

string VuoModule::getDefaultDisplayName ( void  )

Returns the default display name for instances of this module, as specified by the .vuonode/.bc implementation.

Needn't be unique.

UTF-8.

Example:
Less Than
See Also
VuoModuleDetails
string VuoModule::getDescription ( void  )

Returns the description of this module provided as documentation.

See Also
VuoModuleDetails
vector< string > VuoModule::getKeywords ( void  )

Returns a list of the module's keywords.

See Also
VuoModuleDetails
string VuoModule::getVersion ( void  )

Returns the module's version, in Semantic Versioning format.

See Also
VuoModuleDetails
void VuoModule::setDefaultDisplayName ( string  defaultDisplayName)

Sets the default display name for instances of this module.

Needn't be unique.

UTF-8.

Example:
Less Than
See Also
VuoModuleDetails
void VuoModule::setDescription ( string  description)

Sets the description of this module provided as documentation.

See Also
VuoModuleDetails
void VuoModule::setKeywords ( vector< string >  keywords)

Sets the module's keywords.

See Also
VuoModuleDetails
void VuoModule::setVersion ( string  version)

Sets the module's version, in Semantic Versioning format.

See Also
VuoModuleDetails

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