Information about a composition to tell people where it came from, what it does, and so on.
Definition at line 15 of file VuoCompositionMetadata.hh.
Public Member Functions | |
| VuoCompositionMetadata (void) | |
| Creates a metadata instance with a default name and the rest of the fields empty. More... | |
| VuoCompositionMetadata (const string &compositionAsString) | |
| Creates a metadata instance with fields populated from the composition's Doxygen header. More... | |
| string | toCompositionHeader (void) |
| Returns a composition Doxygen header containing the metadata. More... | |
| void | setName (string name) |
| Sets the composition's display name specified by the user. More... | |
| void | setDefaultName (const string &defaultName) |
| Sets a composition display name to fall back on if the user hasn't specified one. More... | |
| string | getName (void) |
| Returns the composition's display name specified by the user if any, otherwise the default name. More... | |
| string | getCustomizedName (void) |
| Returns the composition's display name specified by the user if any, otherwise an empty string. More... | |
| string | getDefaultName (void) |
| Returns the composition display name to fall back on if the user hasn't specified one. More... | |
| void | setAuthor (string author) |
| Sets the composition's author. More... | |
| string | getAuthor (void) |
| Returns the composition's author. More... | |
| void | setVersion (string version) |
| Sets the composition's version. More... | |
| string | getVersion (void) |
| Returns the composition's version. More... | |
| void | setCreatedInVuoVersion (string version) |
| Sets the Vuo version in which the composition was originally created. More... | |
| string | getCreatedInVuoVersion (void) |
| Returns the Vuo version in which the composition was originally created. More... | |
| void | setLastSavedInVuoVersion (string version) |
| Sets the Vuo version in which the composition was most recently saved. More... | |
| string | getLastSavedInVuoVersion (void) |
| Returns the Vuo version in which the composition was most recently saved. More... | |
| void | setDescription (string description) |
| Sets the composition's description (documentation). More... | |
| string | getDescription (void) |
| Returns the composition's description (documentation). More... | |
| void | setKeywords (const vector< string > &keywords) |
| Sets the composition's search keywords. More... | |
| vector< string > | getKeywords (void) |
| Returns the composition's search keywords. More... | |
| void | setCopyright (string copyright) |
| Sets the composition's copyright. More... | |
| string | getCopyright (void) |
| Returns the composition's copyright. More... | |
| void | setLicense (string license) |
| Sets the composition's license. More... | |
| string | getLicense (void) |
| Returns the composition's license. More... | |
| void | setIconURL (string url) |
| Sets the composition's icon URL. More... | |
| string | getIconURL (void) |
| Returns the composition's icon URL. More... | |
| void | setHomepageURL (string url) |
| Sets the composition's homepage URL. More... | |
| string | getHomepageURL (void) |
| Returns the composition's homepage URL. More... | |
| void | setDocumentationURL (string url) |
| Sets the composition's documentation URL. More... | |
| string | getDocumentationURL (void) |
| Returns the composition's documentation URL. More... | |
| void | setBundleIdentifier (string id) |
| Sets the composition's bundle identifier. More... | |
| string | getBundleIdentifier (void) |
| Returns the composition's bundle identifier. More... | |
| void | setFxPlugGroup (string group) |
| Sets the composition's FxPlug group. More... | |
| string | getFxPlugGroup (void) |
| Returns the composition's FxPlug group. More... | |
| void | setCategories (const vector< string > &categories) |
| Sets the shader's ISF categories. More... | |
| vector< string > | getCategories (void) |
| Returns the shader's ISF categories. More... | |
| VuoCompositionMetadata::VuoCompositionMetadata | ( | void | ) |
Creates a metadata instance with a default name and the rest of the fields empty.
Definition at line 16 of file VuoCompositionMetadata.cc.
| VuoCompositionMetadata::VuoCompositionMetadata | ( | const string & | compositionAsString | ) |
Creates a metadata instance with fields populated from the composition's Doxygen header.
Definition at line 24 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getAuthor | ( | void | ) |
Returns the composition's author.
Definition at line 419 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getBundleIdentifier | ( | void | ) |
Returns the composition's bundle identifier.
Definition at line 595 of file VuoCompositionMetadata.cc.
| vector< string > VuoCompositionMetadata::getCategories | ( | void | ) |
Returns the shader's ISF categories.
Definition at line 627 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getCopyright | ( | void | ) |
Returns the composition's copyright.
Definition at line 467 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getCreatedInVuoVersion | ( | void | ) |
Returns the Vuo version in which the composition was originally created.
Definition at line 515 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getCustomizedName | ( | void | ) |
Returns the composition's display name specified by the user if any, otherwise an empty string.
Definition at line 395 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getDefaultName | ( | void | ) |
Returns the composition display name to fall back on if the user hasn't specified one.
Definition at line 403 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getDescription | ( | void | ) |
Returns the composition's description (documentation).
Definition at line 435 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getDocumentationURL | ( | void | ) |
Returns the composition's documentation URL.
Definition at line 579 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getFxPlugGroup | ( | void | ) |
Returns the composition's FxPlug group.
Definition at line 611 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getHomepageURL | ( | void | ) |
Returns the composition's homepage URL.
Definition at line 563 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getIconURL | ( | void | ) |
Returns the composition's icon URL.
Definition at line 547 of file VuoCompositionMetadata.cc.
| vector< string > VuoCompositionMetadata::getKeywords | ( | void | ) |
Returns the composition's search keywords.
Definition at line 451 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getLastSavedInVuoVersion | ( | void | ) |
Returns the Vuo version in which the composition was most recently saved.
Definition at line 531 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getLicense | ( | void | ) |
Returns the composition's license.
Definition at line 483 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getName | ( | void | ) |
Returns the composition's display name specified by the user if any, otherwise the default name.
Definition at line 387 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::getVersion | ( | void | ) |
Returns the composition's version.
Definition at line 499 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setAuthor | ( | string | author | ) |
Sets the composition's author.
Definition at line 411 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setBundleIdentifier | ( | string | id | ) |
Sets the composition's bundle identifier.
Definition at line 587 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setCategories | ( | const vector< string > & | categories | ) |
Sets the shader's ISF categories.
Definition at line 619 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setCopyright | ( | string | copyright | ) |
Sets the composition's copyright.
Definition at line 459 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setCreatedInVuoVersion | ( | string | version | ) |
Sets the Vuo version in which the composition was originally created.
Definition at line 507 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setDefaultName | ( | const string & | defaultName | ) |
Sets a composition display name to fall back on if the user hasn't specified one.
Definition at line 379 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setDescription | ( | string | description | ) |
Sets the composition's description (documentation).
Definition at line 427 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setDocumentationURL | ( | string | url | ) |
Sets the composition's documentation URL.
Definition at line 571 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setFxPlugGroup | ( | string | group | ) |
Sets the composition's FxPlug group.
Definition at line 603 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setHomepageURL | ( | string | url | ) |
Sets the composition's homepage URL.
Definition at line 555 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setIconURL | ( | string | url | ) |
Sets the composition's icon URL.
Definition at line 539 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setKeywords | ( | const vector< string > & | keywords | ) |
Sets the composition's search keywords.
Definition at line 443 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setLastSavedInVuoVersion | ( | string | version | ) |
Sets the Vuo version in which the composition was most recently saved.
Definition at line 523 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setLicense | ( | string | license | ) |
Sets the composition's license.
Definition at line 475 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setName | ( | string | name | ) |
Sets the composition's display name specified by the user.
Definition at line 371 of file VuoCompositionMetadata.cc.
| void VuoCompositionMetadata::setVersion | ( | string | version | ) |
Sets the composition's version.
Definition at line 491 of file VuoCompositionMetadata.cc.
| string VuoCompositionMetadata::toCompositionHeader | ( | void | ) |
Returns a composition Doxygen header containing the metadata.
Definition at line 226 of file VuoCompositionMetadata.cc.
1.9.1