Vuo  0.4.2
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Variables

Description

Name, version, and behavior information to be defined by node classes.

Variables

const char * moduleName
 Default display name.
 
const char * moduleDescription
 A succinct summary of this node class's purpose.
 
const char * moduleKeywords []
 A list of synonyms for this node class's name.
 
const char * moduleDependencies []
 A list of libraries or other modules this module depends upon.
 
const unsigned int moduleVersion
 Version, represented as an integer.
 
const bool nodeProvides
 If true, this node class provides data to the graph from somewhere external to the graph (e.g., input device, file, network).
 
const bool nodeConsumes
 If true, this node class consumes data from the graph, sending it somewhere external to the graph (e.g., output device, file, network).
 

Variable Documentation

const char* moduleDependencies[]

A list of libraries or other modules this module depends upon.

Example:
const char * moduleDependencies[] = { "c", "json-c", "icuuc", "icudata" };
See Also
Using Libraries
const char* moduleDescription

A succinct summary of this node class's purpose.

Use sentence capitalization, when appropriate. No more than one sentence.

Example:
const char * moduleDescription = "Outputs the quotient and remainder of `a` / `b`";
const char* moduleKeywords[]

A list of synonyms for this node class's name.

This list is used when searching for node classes in the Vuo Editor's Node Library.

Example:
const char * moduleKeywords[] = { "quotient", "remainder" };
const char* moduleName

Default display name.

Use title case. Typically this should be the same as the last or second-to-last term in the node class string, except that this gets capitalized and the node class string doesn't.

Can be overridden by the user.

Example:
const char * moduleName = "Divide";
const unsigned int moduleVersion

Version, represented as an integer.

Multiply the major version by 100, then add the minor version.

Example:
const unsigned int moduleVersion = 100; // 1.00: first public release
Example:
const unsigned int moduleVersion = 101; // 1.01: minor new functionality or bugfix
Example:
const unsigned int moduleVersion = 200; // 2.00: significant new functionality or significant change in input/output ports