AssetManagerInterface Class Reference

#include <assetmanagerinterface.h>

Detailed Description

Helper class to control the Asset Manager.

Public Types
using	Filter = Delegate< Bool(const AssetDescription &desc)>
using	AssetDragTuple = Tuple< Url, AssetDescription, String >
using	AssetDragArray = BaseArray< AssetDragTuple >
using	AssetDragSubtypeArray = BaseArray< Id >
using	AssetDragArrayTuple = Tuple< AssetDragArray, AssetDragSubtypeArray >

Static Public Member Functions
static MAXON_METHOD void	SetActiveManager (MASTERFILTER masterFilter, const GraphModelPresenterRef &presenter=GetZeroRef< GraphModelPresenterRef >(), const nodes::NodesGraphModelRef &model=GetZeroRef< nodes::NodesGraphModelRef >())
static MAXON_METHOD Result< Bool >	OpenPopup (ASSETPOPUPOPTIONS flags, MASTERFILTER masterFilter, const String &filterString, const AssetDescription &smartFilter=GetZeroRef< AssetDescription >(), const GraphModelPresenterRef &presenter=GetZeroRef< GraphModelPresenterRef >(), const nodes::NodesGraphModelRef &model=GetZeroRef< nodes::NodesGraphModelRef >(), const String &title=String(), const HashSet< Id > &inSelection=HashSet< Id >(), Delegate< void(const DragAndDropDataAssetArray &)> &&outSelection={})
static MAXON_METHOD Result< Bool >	CheckDownloadAssetWithModalProgressDialog (const AssetDescription &asset, const AssetRepositoryRef &lookupRepository)
static MAXON_METHOD Result< Bool >	CheckDownloadAssetsWithModalProgressDialog (const BaseArray< AssetDescription > &assets, const AssetRepositoryRef &lookupRepository)
static MAXON_METHOD Tuple< Bool, Id, Url, AssetDescription, String >	GetAssetFilenameFromDragData (const void *dragData, Bool updateUsage, Bool showDownloadDialog, const Filter &filter=GetZeroRef< Filter >())
static MAXON_METHOD Result< AssetDragArrayTuple >	GetAssetFilenameFromMultiDragData (const void *dragData, Bool updateUsage, Bool showDownloadDialog, const Filter &filter=GetZeroRef< Filter >())
static MAXON_METHOD Result< void >	RevealAsset (const Block< AssetDescription > &assets)
static MAXON_METHOD Result< Bool >	LoadAssets (const AssetRepositoryRef &searchRepository, const HashMap< Id, String > &selectionAndFilterString, const GraphModelPresenterRef &presenter=GetZeroRef< GraphModelPresenterRef >(), const nodes::NodesGraphModelRef &graphModelRef=GetZeroRef< nodes::NodesGraphModelRef >())
static MAXON_METHOD Result< Bool >	LoadAssets (const AssetRepositoryRef &searchRepository, const HashMap< Id, String > &selectionAndFilterString, const GraphModelPresenterRef &presenter, const nodes::NodesGraphModelRef &graphModelRef, const String &source)
static MAXON_METHOD Result< AssetManagerSubDialogRef >	GetAssetManagerSubDialogRef ()

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (AssetManagerInterface, MAXON_REFERENCE_STATIC, "net.maxon.mvp.assetmanager.interface")

Member Typedef Documentation

Filter

using Filter = Delegate<Bool(const AssetDescription& desc)>

AssetDragTuple

using AssetDragTuple = Tuple<Url, AssetDescription, String>

AssetDragArray

using AssetDragArray = BaseArray<AssetDragTuple>

AssetDragSubtypeArray

using AssetDragSubtypeArray = BaseArray<Id>

AssetDragArrayTuple

using AssetDragArrayTuple = Tuple<AssetDragArray, AssetDragSubtypeArray>

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( AssetManagerInterface  , MAXON_REFERENCE_STATIC  , "net.maxon.mvp.assetmanager.interface"    )

private

SetActiveManager()

static MAXON_METHOD void SetActiveManager ( MASTERFILTER  masterFilter, const GraphModelPresenterRef &  presenter = GetZeroRef< GraphModelPresenterRef >(), const nodes::NodesGraphModelRef &  model = GetZeroRef< nodes::NodesGraphModelRef >()  )

static

SetActiveManager sets the active asset manager mode.

Parameters

[in]	masterFilter	see MASTERFILTER.
[in]	presenter	Optional parameter to pass a NodeGraph presenter.
[in]	model	Optional parameter to pass a NodeGraph.

OpenPopup()

static MAXON_METHOD Result<Bool> OpenPopup ( ASSETPOPUPOPTIONS  flags, MASTERFILTER  masterFilter, const String &  filterString, const AssetDescription &  smartFilter = GetZeroRef< AssetDescription >(), const GraphModelPresenterRef &  presenter = GetZeroRef< GraphModelPresenterRef >(), const nodes::NodesGraphModelRef &  model = GetZeroRef< nodes::NodesGraphModelRef >(), const String &  title = String(), const HashSet< Id > &  inSelection = HashSet< Id >(), Delegate< void(const DragAndDropDataAssetArray &)> &&  outSelection = {}  )

static

OpenPopup opens an asset selection popup.

Parameters

[in]	flags	see ASSETPOPUPOPTIONS.
[in]	masterFilter	see MASTERFILTER.
[in]	filterString	see FilterString.
[in]	smartFilter	SmartFilter to select.
[in]	presenter	Optional parameter to pass a NodeGraph presenter.
[in]	model	Optional parameter to pass a NodeGraph.
[in]	title	Optional Window Title.
[out]	inSelection	Returns the selected elements.
[out]	outSelection	Delegate.

Returns

True on success. False if the user cancelled.

CheckDownloadAssetWithModalProgressDialog()

static MAXON_METHOD Result<Bool> CheckDownloadAssetWithModalProgressDialog ( const AssetDescription &  asset, const AssetRepositoryRef &  lookupRepository  )

static

CheckDownloadAssetWithModalProgressDialog checks if an asset is already cached and if not it will download the asset with a modal progress dialog which can be canceled. Canceling the dialog will continue the download but returns false. Dependencies will be added to the download queue as well.

Parameters

[in]	asset	Asset to inspect/download.
[in]	lookupRepository	Repository to check dependencies for.

Returns

True if done. False if cancelled.

CheckDownloadAssetsWithModalProgressDialog()

static MAXON_METHOD Result<Bool> CheckDownloadAssetsWithModalProgressDialog ( const BaseArray< AssetDescription > &  assets, const AssetRepositoryRef &  lookupRepository  )

static

GetAssetFilenameFromDragData()

static MAXON_METHOD Tuple<Bool, Id, Url, AssetDescription, String> GetAssetFilenameFromDragData ( const void *  dragData, Bool  updateUsage, Bool  showDownloadDialog, const Filter &  filter = GetZeroRef< Filter >()  )

static

GetAssetFilenameFromDragData extracts the filename/url from the legacy d&d message. If filter is null, this will only return assets of type AssetTypes::File, otherwise only assets which pass the given filter.

Parameters

[in]

dragData

DragData containing the asset filename.

Returns

Bool: false if cancelled by user, Id: Asset ID, Url: asset url, AssetDescription: asset description, String: filter string from asset browser

GetAssetFilenameFromMultiDragData()

static MAXON_METHOD Result<AssetDragArrayTuple> GetAssetFilenameFromMultiDragData ( const void *  dragData, Bool  updateUsage, Bool  showDownloadDialog, const Filter &  filter = GetZeroRef< Filter >()  )

static

RevealAsset()

static MAXON_METHOD Result<void> RevealAsset ( const Block< AssetDescription > &  assets )

static

RevealAsset opens the asset browser to show the given assets in the browser.

Parameters

[in]

assets

Assets to show.

Returns

OK on success.

LoadAssets() [1/2]

static MAXON_METHOD Result<Bool> LoadAssets ( const AssetRepositoryRef &  searchRepository, const HashMap< Id, String > &  selectionAndFilterString, const GraphModelPresenterRef &  presenter = GetZeroRef< GraphModelPresenterRef >(), const nodes::NodesGraphModelRef &  graphModelRef = GetZeroRef< nodes::NodesGraphModelRef >()  )

static

LoadAssets executes the load asset command from the asset browser (e.g. double click or open).

Parameters

[in]	searchRepository	Search repository.
[in]	selectionAndFilterString	HashMap which contains the search terms to switch modes in the newly created node/object.
[in]	presenter	Optional presenter to use when creating nodes.
[in]	graphModelRef	Optional parameter to pass the node graph where to insert nodes.

Returns

Bool on success. True if loaded. False indicates another error state.

LoadAssets() [2/2]

static MAXON_METHOD Result<Bool> LoadAssets ( const AssetRepositoryRef &  searchRepository, const HashMap< Id, String > &  selectionAndFilterString, const GraphModelPresenterRef &  presenter, const nodes::NodesGraphModelRef &  graphModelRef, const String &  source  )

static

LoadAssets executes the load asset command from the asset browser (e.g. double click or open).

Parameters

[in]	searchRepository	Search repository.
[in]	selectionAndFilterString	HashMap which contains the search terms to switch modes in the newly created node/object.
[in]	presenter	Optional presenter to use when creating nodes.
[in]	graphModelRef	Optional parameter to pass the node graph where to insert nodes.
[in]	source	Optional parameter to indicate the source of the action, for example "commander".

Returns

Bool on success. True if loaded. False indicates another error state.

GetAssetManagerSubDialogRef()

static MAXON_METHOD Result<AssetManagerSubDialogRef> GetAssetManagerSubDialogRef ( )

static