maxon::ASSETMETADATA Namespace Reference

Namespaces

 COLORCATEGORY
 

Typedefs

using AssetCommandQueryStateDelegate = Delegate< Result< COMMAND_ASSET_STATE >()>
 
using AssetCommandExecuteDelegate = Delegate< Result< void >(Bool withOptions)>
 
using VersionRange = Tuple< Float, Float >
 
using AssetUsageType = Tuple< UniversalDateTime, Int >
 

Functions

 MAXON_ATTRIBUTE (AssetCommandQueryStateDelegate, AssetCommandQueryState, "net.maxon.asset.command.querystate")
 
 MAXON_ATTRIBUTE (AssetCommandExecuteDelegate, AssetCommandExecute, "net.maxon.asset.command.execute")
 
 MAXON_ATTRIBUTE (String, AssetCommandHelp, "net.maxon.asset.command.help")
 
 MAXON_ATTRIBUTE (String, AssetCommandShortcuts, "net.maxon.asset.command.shortcuts")
 
 MAXON_ATTRIBUTE (Int, AssetCommandLegacyId, "net.maxon.asset.command.legacyid")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_Command, "net.maxon.asset.commandsubtype.command")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_HotkeyCommand, "net.maxon.asset.commandsubtype.hotkey")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_ToolCommand, "net.maxon.asset.commandsubtype.tool")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_ObjectCommand, "net.maxon.asset.commandsubtype.object")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_TagCommand, "net.maxon.asset.commandsubtype.tag")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_ScriptCommand, "net.maxon.asset.commandsubtype.script")
 
 MAXON_ATTRIBUTE (Array< Id >, Keywords, "net.maxon.asset.keywords")
 
 MAXON_ATTRIBUTE (Array< Id >, UserKeywords, "net.maxon.asset.userkeywords")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.assetmetadata")
 
 MAXON_ATTRIBUTE (UniversalDateTime, ASSET_TIMESTAMP, "net.maxon.asset.timestamp")
 
 MAXON_ATTRIBUTE (UInt64, ASSET_SIZE, "net.maxon.asset.size")
 
 MAXON_ATTRIBUTE (String, ASSET_VERSIONTAG, "net.maxon.asset.versiontag")
 
 MAXON_ATTRIBUTE (Url, ASSET_PREVIEWIMAGEURL, "net.maxon.asset.previewimageurl")
 
 MAXON_ATTRIBUTE (Url, ASSET_PREVIEWANIMURL, "net.maxon.asset.previewanimurl")
 
 MAXON_ATTRIBUTE (Url, PROXYGEOMETRY, "net.maxon.assetmetadata.proxygeometry")
 
 MAXON_ATTRIBUTE (String, ASSET_SORT, "net.maxon.asset.sort")
 
 MAXON_ATTRIBUTE (Array< AssetDependencyStruct >, Dependencies, "net.maxon.asset.dependencies.2")
 
 MAXON_ATTRIBUTE (VersionRange, ValidVersionRange, "net.maxon.asset.validversion")
 
 MAXON_ATTRIBUTE (ASSETLICENSETYPE, ValidLicenseType, "net.maxon.asset.validlicensetype")
 
 MAXON_ATTRIBUTE (DataDictionary, MetaProperties, "net.maxon.asset.metaproperties")
 
 MAXON_ATTRIBUTE (AssetUsageType, Usage, "net.maxon.asset.usage")
 
 MAXON_ATTRIBUTE (Id, Category, "net.maxon.node.category")
 
 MAXON_ATTRIBUTE (Id, ColorCategory, "net.maxon.asset.colorcategory")
 
 MAXON_ATTRIBUTE (CString, DerivedMetaDataStamp, "net.maxon.asset.derivedmetadatastamp")
 
 MAXON_ATTRIBUTE (Id, NodeSpace, "net.maxon.node.nodespace")
 
 MAXON_ATTRIBUTE (Id, Plugin, "net.maxon.node.plugin")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_InternalModule, "net.maxon.asset.plugin.internalmodule")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_ExternalPlugin, "net.maxon.asset.plugin.externalplugin")
 
 MAXON_ATTRIBUTE (String, SmartSearch, "net.maxon.node.smartsearch")
 
 MAXON_ATTRIBUTE (Id, SubType, "net.maxon.asset.subtype")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_MediaImage, "net.maxon.asset.subtype.mediaimage")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_MediaMovie, "net.maxon.asset.subtype.mediamovie")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_Object, "net.maxon.asset.subtype.object")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_Material, "net.maxon.asset.subtype.material")
 
 MAXON_ATTRIBUTE (void, SubType_ENUM_Scene, "net.maxon.asset.subtype.scene")
 

Variables

static const LiteralId ID_FAVOURITEKEYWORD
 

Typedef Documentation

◆ AssetCommandQueryStateDelegate

◆ AssetCommandExecuteDelegate

using AssetCommandExecuteDelegate = Delegate<Result<void>(Bool withOptions)>

◆ VersionRange

Defines the version (from, to) which the asset is valid.

◆ AssetUsageType

Function Documentation

◆ MAXON_ATTRIBUTE() [1/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( AssetCommandQueryStateDelegate  ,
AssetCommandQueryState  ,
"net.maxon.asset.command.querystate"   
)

◆ MAXON_ATTRIBUTE() [2/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( AssetCommandExecuteDelegate  ,
AssetCommandExecute  ,
"net.maxon.asset.command.execute"   
)

◆ MAXON_ATTRIBUTE() [3/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( String  ,
AssetCommandHelp  ,
"net.maxon.asset.command.help"   
)

◆ MAXON_ATTRIBUTE() [4/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( String  ,
AssetCommandShortcuts  ,
"net.maxon.asset.command.shortcuts"   
)

◆ MAXON_ATTRIBUTE() [5/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Int  ,
AssetCommandLegacyId  ,
"net.maxon.asset.command.legacyid"   
)

◆ MAXON_ATTRIBUTE() [6/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_Command  ,
"net.maxon.asset.commandsubtype.command"   
)

◆ MAXON_ATTRIBUTE() [7/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_HotkeyCommand  ,
"net.maxon.asset.commandsubtype.hotkey"   
)

◆ MAXON_ATTRIBUTE() [8/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_ToolCommand  ,
"net.maxon.asset.commandsubtype.tool"   
)

◆ MAXON_ATTRIBUTE() [9/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_ObjectCommand  ,
"net.maxon.asset.commandsubtype.object"   
)

◆ MAXON_ATTRIBUTE() [10/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_TagCommand  ,
"net.maxon.asset.commandsubtype.tag"   
)

◆ MAXON_ATTRIBUTE() [11/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_ScriptCommand  ,
"net.maxon.asset.commandsubtype.script"   
)

◆ MAXON_ATTRIBUTE() [12/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Array< Id ,
Keywords  ,
"net.maxon.asset.keywords"   
)

Array with ids of keywords assets, attached to the asset.

◆ MAXON_ATTRIBUTE() [13/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Array< Id ,
UserKeywords  ,
"net.maxon.asset.userkeywords"   
)

Array with ids of user keywords assets, attached to the asset.

◆ MAXON_RESOURCE_DATABASE_SCOPE()

maxon::ASSETMETADATA::MAXON_RESOURCE_DATABASE_SCOPE ( "net.maxon.assetmetadata"  )

◆ MAXON_ATTRIBUTE() [14/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( UniversalDateTime  ,
ASSET_TIMESTAMP  ,
"net.maxon.asset.timestamp"   
)

This read-only asset meta data attribute has the time stamp of the asset creation as value. It is automatically set by an asset repository when StoreAsset is called.

◆ MAXON_ATTRIBUTE() [15/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( UInt64  ,
ASSET_SIZE  ,
"net.maxon.asset.size"   
)

This read-only asset meta data attribute has the size of the asset. It is a optional property.

◆ MAXON_ATTRIBUTE() [16/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( String  ,
ASSET_VERSIONTAG  ,
"net.maxon.asset.versiontag"   
)

This asset meta data attribute can be set by the user to give a version tag for an asset. There is no special convention for the version tag, so it could be for example "1.0" or "Fixed bug 42".

◆ MAXON_ATTRIBUTE() [17/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Url  ,
ASSET_PREVIEWIMAGEURL  ,
"net.maxon.asset.previewimageurl"   
)

This asset meta data attribute can be set by the user to give a preview image.

◆ MAXON_ATTRIBUTE() [18/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Url  ,
ASSET_PREVIEWANIMURL  ,
"net.maxon.asset.previewanimurl"   
)

Optional asset meta data attribute can be set by the user to give a preview animation.

◆ MAXON_ATTRIBUTE() [19/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Url  ,
PROXYGEOMETRY  ,
"net.maxon.assetmetadata.proxygeometry"   
)

url to a 3D file format with the proxy geometry

◆ MAXON_ATTRIBUTE() [20/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( String  ,
ASSET_SORT  ,
"net.maxon.asset.sort"   
)

manual sorting of asset browser entries

◆ MAXON_ATTRIBUTE() [21/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Array< AssetDependencyStruct ,
Dependencies  ,
"net.maxon.asset.dependencies.2"   
)

Array with asset ids which other assets are required to use this asset.

◆ MAXON_ATTRIBUTE() [22/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( VersionRange  ,
ValidVersionRange  ,
"net.maxon.asset.validversion"   
)

◆ MAXON_ATTRIBUTE() [23/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( ASSETLICENSETYPE  ,
ValidLicenseType  ,
"net.maxon.asset.validlicensetype"   
)

Defines the version (from, to) which the asset is valid.

◆ MAXON_ATTRIBUTE() [24/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( DataDictionary  ,
MetaProperties  ,
"net.maxon.asset.metaproperties"   
)

This asset meta data attribute can be set by the user to give more details about the asset. The data is depending on the asset type and subtype. The DataDictionary can contain the Resolution of images/movies, bounding boxes of geometry.

◆ MAXON_ATTRIBUTE() [25/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( AssetUsageType  ,
Usage  ,
"net.maxon.asset.usage"   
)

this meta data counts the usage of the assets.

  1. UniversalDateTime - last usage
  2. Int - usage count

◆ MAXON_ATTRIBUTE() [26/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Id  ,
Category  ,
"net.maxon.node.category"   
)

◆ MAXON_ATTRIBUTE() [27/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Id  ,
ColorCategory  ,
"net.maxon.asset.colorcategory"   
)

◆ MAXON_ATTRIBUTE() [28/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( CString  ,
DerivedMetaDataStamp  ,
"net.maxon.asset.derivedmetadatastamp"   
)

The value of this meta data attribute is used by GetDerivedMetaData for invalidation of cached derived meta data. If an asset has a value for this meta data attribute, then GetDerivedMetaData uses the value as a stamp for its persistent cache. Whenever the value changes, the cached data is considered invalid and gets re-derived.

◆ MAXON_ATTRIBUTE() [29/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Id  ,
NodeSpace  ,
"net.maxon.node.nodespace"   
)

◆ MAXON_ATTRIBUTE() [30/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Id  ,
Plugin  ,
"net.maxon.node.plugin"   
)

◆ MAXON_ATTRIBUTE() [31/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_InternalModule  ,
"net.maxon.asset.plugin.internalmodule"   
)

◆ MAXON_ATTRIBUTE() [32/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_ExternalPlugin  ,
"net.maxon.asset.plugin.externalplugin"   
)

◆ MAXON_ATTRIBUTE() [33/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( String  ,
SmartSearch  ,
"net.maxon.node.smartsearch"   
)

◆ MAXON_ATTRIBUTE() [34/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( Id  ,
SubType  ,
"net.maxon.asset.subtype"   
)

This asset meta data attribute can be set by the user to give a version tag for an asset. There is no special convention for the version tag, so it could be for example "1.0" or "Fixed bug 42".

◆ MAXON_ATTRIBUTE() [35/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_MediaImage  ,
"net.maxon.asset.subtype.mediaimage"   
)

◆ MAXON_ATTRIBUTE() [36/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_MediaMovie  ,
"net.maxon.asset.subtype.mediamovie"   
)

◆ MAXON_ATTRIBUTE() [37/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_Object  ,
"net.maxon.asset.subtype.object"   
)

◆ MAXON_ATTRIBUTE() [38/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_Material  ,
"net.maxon.asset.subtype.material"   
)

◆ MAXON_ATTRIBUTE() [39/39]

maxon::ASSETMETADATA::MAXON_ATTRIBUTE ( void  ,
SubType_ENUM_Scene  ,
"net.maxon.asset.subtype.scene"   
)

Variable Documentation

◆ ID_FAVOURITEKEYWORD

const LiteralId ID_FAVOURITEKEYWORD
static

defines the id of the favorite keyword