maxon.frameworks.asset¶

Note

Members documented here are defined in maxon.frameworks.asset module and are also exposed to the global maxon module. See the Maxon API section of the API Overview for more information about the special conventions of this API.

Description¶

Module for interacting with assets.

Interfaces¶

`AssetBaseInterface`(*args)	The base interface of `maxon.AssetBaseWithUpdateInterface` and `maxon.AssetDescriptionInterface`.
`AssetBaseWithUpdateInterface`(*args)	The base interface of `maxon.AssetInterface` and `maxon.AssetReferenceInterface`.
`AssetDataBasesInterface`(*args)	This interface provides helper functions to register asset repositories.
`AssetDescriptionInterface`(*args)	Represents all meta information about an asset, namely its identifier and version, the `maxon.AssetMetaData` and some further information.
`AssetIdentifierInterface`(*args)	The base interface of `maxon.AssetBaseInterface` and `maxon.AssetLinkInterface`.
`AssetInterface`(*args)	An Asset represents digital content which can be managed by an `maxon.AssetRepositoryRef` “asset repository”.
`AssetLinkInterface`(*args)	An AssetLink is a symbolic link to an asset identified by its id and version.
`AssetMetaDataInterface`(*args)	`maxon.AssetMetaData` allows to query the meta data of an asset.
`AssetReferenceInterface`(*args)	`maxon.AssetReference` is needed for the asset update mechanism and represents a specific updatable `maxon.AssetLink` within an asset, see `AssetInterface.GetReferencedAssets()`.
`AssetRepositoryInterface`(*args)	An AssetRepositoryInterface manages a set of assets: - Assets can be looked up using their identifier and version.
`AssetTypeInterface`(*args)	Creates and stores internally the reference of the C++ Data.
`AssetUtilitiesInterface`()	Helper Interface for Asset functions.
`BasePresetAssetInterface`(*args)	`maxon.BasePresetAssetInterface` allows to implement details for preset assets.
`BasePresetAssetTypeInterface`(*args)	Defines a new preset type and is the connector to BasePresetAssetInterface
`CategoryAssetInterface`(*args)	Implementation of category assets
`ColorCategoryAssetInterface`(*args)	Implementation of a color category asset.
`CompactableAssetRepositoryInterface`(*args)	Repository which allows to write an index.
`DatabaseAssetInterface`(*args)	Implementation of DatabaseAsset.
`DataDescriptionPresetStorageInterface`()	Helper class to handle loading and saving of presets.
`DerivedAssetRepositoryDataInterface`(*args)	Creates and stores internally the reference of the C++ Data.
`FileAssetInterface`(*args)	Creates and stores internally the reference of the C++ Data.
`KeywordAssetInterface`(*args)	Creates and stores internally the reference of the C++ Data.
`LazyLanguageDictionaryInterface`(*args)	Interface to manage lazy loading of `maxon.LanguageDictionary` for description strings.
`LazyLanguageStringDataDescriptionDefinitionInterface`(*args)	Interface to manage lazy loading of `maxon.LanguageStringDataDescriptionDefinition` for description strings.
`NodeSpaceAssetInterface`(*args)	Implementation of NodeSpaceAssets
`PluginAssetInterface`(*args)	Implements the PluginAsset type
`SmartSearchAssetInterface`(*args)	Implements the smartsearch asset type.
`SubTypeAssetInterface`(*args)	Implements the SubTypeAsset.
`UpdatableAssetInterface`(*args)	An `maxon.UpdatableAsset` is an `maxon.Asset` which supports the update of its updatable references to other assets to newer versions.
`UpdatableAssetRepositoryInterface`(*args)	Asset repository which allows to update assets.
`UrlAssetRepositoryInterface`(*args)	Creates and stores internally the reference of the C++ Data.

References¶

`Asset`(*args)	Represents a reference of a `maxon.AssetInterface`
`AssetBase`(*args)	Represents a reference of a `maxon.AssetBaseInterface`
`AssetBaseWithUpdate`(*args)	Represents a reference of a `maxon.AssetBaseWithUpdateInterface`
`AssetDescription`(*args)	Represents a reference of a `maxon.AssetDescriptionInterface`
`AssetIdentifier`(*args)	Represents a reference of a `maxon.AssetIdentifierInterface`
`AssetLink`(*args)	Represents a reference of a `maxon.AssetLinkInterface`
`AssetMetaData`(*args)	Represents a reference of a `maxon.AssetMetaDataInterface`
`AssetReference`(*args)	Represents a reference of a `maxon.AssetReferenceInterface`
`AssetRepositoryRef`(*args)	Represents a reference of a `maxon.AssetRepositoryInterface`
`AssetType`(*args)	Represents a reference of a `maxon.AssetTypeInterface`
`BasePresetAsset`(*args)	Represents a reference of a `maxon.BasePresetAssetInterface`
`BasePresetAssetType`(*args)	Represents a reference of a `maxon.BasePresetAssetTypeInterface`
`CategoryAsset`(*args)	Represents a reference of a `maxon.CategoryAssetInterface`
`ColorCategoryAsset`(*args)	Represents a reference of a `maxon.ColorCategoryAssetInterface`
`CompactableAssetRepositoryRef`(*args)	Represents a reference of a `maxon.CompactableAssetRepositoryInterface`
`DatabaseAsset`(*args)	Represents a reference of a `maxon.DatabaseAssetInterface`
`DerivedAssetRepositoryDataRef`(*args)	Represents a reference of a `maxon.DerivedAssetRepositoryDataInterface`
`FileAsset`(*args)	Represents a reference of a `maxon.FileAssetInterface`
`KeywordAsset`(*args)	Represents a reference of a `maxon.KeywordAssetInterface`
`LazyLanguageDictionary`(*args)	Represents a reference of a `maxon.LazyLanguageDictionaryInterface`
`LazyLanguageStringDataDescriptionDefinition`(*args)	Represents a reference of a `maxon.LazyLanguageStringDataDescriptionDefinitionInterface`
`NodeSpaceAsset`(*args)	Represents a reference of a `maxon.NodeSpaceAssetInterface`
`PluginAsset`(*args)	Represents a reference of a `maxon.PluginAssetInterface`
`SmartSearchAsset`(*args)	Represents a reference of a `maxon.SmartSearchAssetInterface`
`SubTypeAsset`(*args)	Represents a reference of a `maxon.SubTypeAssetInterface`
`UpdatableAsset`(*args)	Represents a reference of a `maxon.UpdatableAssetInterface`
`UpdatableAssetRepositoryRef`(*args)	Represents a reference of a `maxon.UpdatableAssetRepositoryInterface`
`UrlAssetRepositoryRef`(*args)	Represents a reference of a `maxon.UrlAssetRepositoryInterface`

Data Types¶

`AddAssetDepencendyStruct`(parentCategory[, …])	Initializes the appropriate C++ Data object and store it within the _data member.
`AssetDatabaseStruct`(otherOrDbUrl[, active, …])	Initializes the appropriate C++ Data object and store it within the _data member.
`AssetDependencyStruct`([other])	Helper class to pass several arguments into asset creation functions.
`DragAndDropDataAssetArray`([other])	Message data for DRAGTYPE_ASSET
`ResolveAssetDependenciesStruct`([C])	Initializes the appropriate C++ Data object and store it within the _data member.
`StoreAssetStruct`(parentCategory[, …])	Initializes the appropriate C++ Data object and store it within the _data member.

Functions¶

`GetAssetUrl`(asset)	Returns the url of a DndAsset.
`UpdateAssetUsage`(asset[, incCount, updateDate])	Mark the asset as used and increment the usage counter.
`IdToIdAndVersion`(id)	Convert a compacted id back to an id and version.
`IdAndVersionToId`(assetId)	Compacts an IdAndVersion into a id.
`IdToIdAndVersionWithRepository`(id, …)	Calls IdToIdAndVersion and adds the repository on top.
`IdAndVersionToIdWithRepository`(assetId, …)	Inverse of IdToIdAndVersionWithRepository.

Registries¶

`AssetTypes`()
`PresetAssetImplementations`()

Enums¶

`APPSETTINGS.ASSETS`()
`ASSET_FIND_MODE`()	The flags of ASSET_FIND_MODE control the behavior of `AssetRepositoryInterface.FindAssets()`.
`ASSETMETADATA`()
`AssetMetaDataInterface.KIND`()
`ASSETREPOSITORYPROPERTIES`()
`ASSETLICENSETYPE`()
`ASSET.INFO`()
`ASSET.METAPROPERTIES`()
`ASSETTYPEPROPERTIES`()

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.