AssetInterface Class Reference

#include <assets.h>

Inheritance diagram for AssetInterface:

Detailed Description

An Asset represents digital content which can be managed by an asset repository. The management includes versioning, meta data and automatic updates.

Public Member Functions

MAXON_METHOD void SetId (const IdAndVersion &aid, Int update, const AssetRepositoryRef &repository, const Url &url=GetPtrSizedZeroRef< Url >())
 
const MAXON_METHOD AssetType & GetType () const
 
MAXON_METHOD Result< AssetDescription > GetDescription () const
 
MAXON_METHOD Result< BoolGetReferencedAssets (Bool onlyUpdatable, const ValueReceiver< const AssetReference & > &receiver) const
 
MAXON_METHOD Result< BoolGetPendingUpdates (const Block< const AssetBase > &updatedAssets, const ValueReceiver< const AssetReference &, const AssetBase & > &receiver) const
 
MAXON_METHOD void SetMetaData (const AssetMetaData &data)
 
MAXON_METHOD AssetMetaData GetMetaData () const
 

Static Public Member Functions

static const MAXON_METHOD AssetRepositoryRef & GetBuiltinRepository ()
 
static const MAXON_METHOD AssetRepositoryRef & GetApplicationRepository ()
 
static const MAXON_METHOD UpdatableAssetRepositoryRef & GetUserPrefsRepository ()
 
static MAXON_METHOD Result< UpdatableAssetRepositoryRef > CreateRepositoryFromUrl (const Id &rid, const Block< const AssetRepositoryRef > &bases, const Url &url, Bool writable, Bool derivedInPrefs, Bool tempRepository)
 
static MAXON_METHOD Result< IdMakeUuid (const Char *prefix, Bool compact)
 
static MAXON_METHOD Result< UrlAddRepositoryScope (const Url &url, const AssetRepositoryRef &repository)
 
static MAXON_METHOD Result< InternedIdGetLanguageMetaDataId (const Id &languageId)
 
static MAXON_METHOD Result< StringGetVersionString (const AssetDescription &asset)
 
static MAXON_METHOD Result< StringGetVersionString (const Asset &asset)
 
static MAXON_METHOD Result< AssetDescription > ResolveAsset (const Url &url, const AssetRepositoryRef &repository)
 
static MAXON_METHOD Result< UrlGetAssetUrl (const AssetDescription &asset, Bool isLatest)
 
static MAXON_METHOD Result< BoolIsAssetValid (const AssetDescription &asset)
 
static MAXON_METHOD Result< BoolIsAssetVisible (const AssetDescription &asset)
 

Private Member Functions

 MAXON_INTERFACE (AssetInterface, MAXON_REFERENCE_COPY_ON_WRITE, "net.maxon.interface.asset")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( AssetInterface  ,
MAXON_REFERENCE_COPY_ON_WRITE  ,
"net.maxon.interface.asset"   
)
private

◆ GetBuiltinRepository()

static const MAXON_METHOD AssetRepositoryRef& GetBuiltinRepository ( )
static

Returns the built-in repository. This contains the built-in assets which are defined by program code (i.e., not by a data format to read them from a data stream).

Returns
Reference to the built-in repository.
See also
BuiltinAssetLoaders

◆ GetApplicationRepository()

static const MAXON_METHOD AssetRepositoryRef& GetApplicationRepository ( )
static

Returns the application repository. The application repository uses the built-in repository as base and adds the assets found in the resources of the asset.module.

Returns
Reference to the application repository.

◆ GetUserPrefsRepository()

static const MAXON_METHOD UpdatableAssetRepositoryRef& GetUserPrefsRepository ( )
static

Returns the asset repository in the user preferences folder. This repository is writable for the user.

Returns
Reference to the repository in the user preferences folder.

◆ CreateRepositoryFromUrl()

static MAXON_METHOD Result<UpdatableAssetRepositoryRef> CreateRepositoryFromUrl ( const Id rid,
const Block< const AssetRepositoryRef > &  bases,
const Url url,
Bool  writable,
Bool  derivedInPrefs,
Bool  tempRepository 
)
static

Creates an asset repository for the given Url. If there already is a directory structure in the expected format it is read as far as needed to initialize the repository with the found assets, otherwise such a directory structure is created.

Parameters
[in]ridThe repository identifier. There mustn't be a base with the same identifier.
[in]basesThe base repositories for the new repository.
[in]urlThe root directory to use for the repository.
[in]writableTrue if the repository shall be writable.
[in]derivedInPrefsTrue if derived meta data shall be stored in the user preferences folder. This is mandatory if #url is a read-only Url.
[in]tempRepositoryTrue if the repository should not be registered as a description database.
Returns
An asset repository stored at #url.

◆ MakeUuid()

static MAXON_METHOD Result<Id> MakeUuid ( const Char prefix,
Bool  compact 
)
static

Creates a UUID (universally unique identifier). If prefix is given, the returned identifier starts with prefix, followed by an @ sign, followed by the UUID such as {base@5e75b5e319f64055ac5387490d7355c0}, otherwise it is a UUID only. If prefix already contains an @ sign, only the part before that sign is used. If compact is true, a Base64-encoding with $ and _ as last characters is used for the UUID instead of the default Hex encoding, this results in shorter UUIDs like {FR4pAc$UFR_jXb16rXadEB}.

Parameters
[in]prefixThe prefix for the identifier, may be nullptr. Only the characters up to the first @ sign are used.
[in]compactTrue if the shorter Base64-encoding shall be used, false for Hex encoding.
Returns
A new UUID. It is safe to assume that this UUID differs from any other UUID returned by this method.

◆ AddRepositoryScope()

static MAXON_METHOD Result<Url> AddRepositoryScope ( const Url url,
const AssetRepositoryRef &  repository 
)
static

◆ GetLanguageMetaDataId()

static MAXON_METHOD Result<InternedId> GetLanguageMetaDataId ( const Id languageId)
static

◆ GetVersionString() [1/2]

static MAXON_METHOD Result<String> GetVersionString ( const AssetDescription &  asset)
static

◆ GetVersionString() [2/2]

static MAXON_METHOD Result<String> GetVersionString ( const Asset asset)
static

◆ SetId()

MAXON_METHOD void SetId ( const IdAndVersion aid,
Int  update,
const AssetRepositoryRef &  repository,
const Url url = GetPtrSizedZeroRefUrl >() 
)

Sets identifier, version and repository of this asset. This method should only be called by the owning asset repository when it stores an asset to establish the link between asset and repository.

Parameters
[in]aidIdentifier and version identifier of the asset.
[in]updateUpdate counter, see AssetBaseWithUpdateInterface::GetUpdate.
[in]repositoryThe repository which stored the asset.
[in]urlAn optional Url where the repository stored the asset. @MAXON_ANNOTATION{returnsThis}

◆ GetType()

const MAXON_METHOD AssetType& GetType ( ) const

Returns the AssetType of this asset.

Returns
The asset's type.

◆ GetDescription()

MAXON_METHOD Result<AssetDescription> GetDescription ( ) const

◆ GetReferencedAssets()

MAXON_METHOD Result<Bool> GetReferencedAssets ( Bool  onlyUpdatable,
const ValueReceiver< const AssetReference & > &  receiver 
) const

Yields all direct references which this asset makes to other assets. The AssetReference objects are used later for the update mechanism: The method UpdatableAssetInterface::Update gets a block of tuples (AssetReference, AssetBase) as input, and each tuple indicates to which asset an AssetReference shall be updated. So for example if an asset has two links to the same asset this has to be reported as two AssetReference objects, and when only the first one is passed to UpdatableAssetInterface::Update only the first link has to be updated, while the second has to remain unchanged.

Parameters
[in]onlyUpdatableIf true only references which use updatable links shall be reported (update policy different from ASSET_UPDATE_POLICY::NEVER), otherwise all references.
[in]receiverReceiver to which references are reported.
Returns
false if the receiver cancelled further evaluation, true otherwise.

◆ GetPendingUpdates()

MAXON_METHOD Result<Bool> GetPendingUpdates ( const Block< const AssetBase > &  updatedAssets,
const ValueReceiver< const AssetReference &, const AssetBase & > &  receiver 
) const

Yields all possible AssetReference updates for this asset due to #updatedAssets to #receiver. This method finds all direct references which this asset makes to other assets, and checks if they are affected by the list of #updatedAssets. This check takes into account the update policy of the AssetLink used for the reference. Whenever there is an updatable AssetLink and #updatedAssets contains a newer version for that link, this is reported by a call to #receiver with the reference as first argument and the newer asset from #updatedAssets as second argument.

Parameters
[in]updatedAssetsA block of assets with (potentially) newer versions.
[in]receiverReceiver to which all pending updates due to #updatedAssets are reported.
Returns
false if the receiver cancelled further evaluation, true otherwise.

◆ SetMetaData()

MAXON_METHOD void SetMetaData ( const AssetMetaData &  data)

Sets the meta data object to use for this asset. This method should only be called by the owning asset repository.

Parameters
[in]dataThe meta data of the asset.

◆ GetMetaData()

MAXON_METHOD AssetMetaData GetMetaData ( ) const

Returns the meta data of this asset.

Returns
The meta data of this asset.

◆ ResolveAsset()

static MAXON_METHOD Result<AssetDescription> ResolveAsset ( const Url url,
const AssetRepositoryRef &  repository 
)
static

ResolveAsset returns the asset description from a given url with the URLSCHEME_ASSET.

Parameters
[in]urlUrl to search.
[in]repositoryLookup repository.
Returns
AssetDescription on success.

◆ GetAssetUrl()

static MAXON_METHOD Result<Url> GetAssetUrl ( const AssetDescription &  asset,
Bool  isLatest 
)
static

GetAssetUrl returns the url to access the asset data. e.g. asset:///file_634545662344

Parameters
[in]assetasset to convert.
[in]isLatestTrue if the asset is the latest asset. In that case the version will not be added to the url.

◆ IsAssetValid()

static MAXON_METHOD Result<Bool> IsAssetValid ( const AssetDescription &  asset)
static

IsAssetValid checks if the asset is valid for the current license and program version.

Parameters
[in]assetAsset to check
Returns
OK on success.

◆ IsAssetVisible()

static MAXON_METHOD Result<Bool> IsAssetVisible ( const AssetDescription &  asset)
static

IsAssetVisible checks if the asset is visible for the current license and program version.

Parameters
[in]assetAsset to check
Returns
OK on success.