Open Search
    AssetBrowserInterface Class Reference

    #include <asset_browser.h>

    Inheritance diagram for AssetBrowserInterface:

    Public Types

    using InitDataDelegate = Delegate< Result< void >()>
     
    using GetAssetDataDelegate = Delegate< Result< Int32 >(const AssetDescription &asset)>
     

    Public Member Functions

    MAXON_METHOD void SkipWatchfolders (Bool skip)
     
    MAXON_METHOD void SkipCommandAssets (Bool skip)
     
    MAXON_METHOD void ShowHiddenFlaggedCommandAssets (Bool show)
     
    MAXON_METHOD Bool GetShowHiddenFlaggedCommandAssets () const
     
    MAXON_METHOD void SetLengthUnitSystem (LENGTHUNITSYSTEM system)
     
    MAXON_METHOD void EnableUpdates (Bool enableUpdates)
     
    MAXON_METHOD AssetRepositoryRef GetLookupRepository () const
     
    MAXON_METHOD Result< void > SetGraphModel (const nodes::NodesGraphModelRef &nodesGraphRef)
     
    MAXON_METHOD Result< void > SetBuildEntryDelegate (BuildBrowserEntryDelegate &&builderDelegate)
     
    MAXON_METHOD Result< void > SetAssetTypesFilter (const HashSet< Id > &assetTypes)
     
    MAXON_METHOD Result< void > GetAssetTypesFilter (const ValueReceiver< const Id & > &assetTypes) const
     
    MAXON_METHOD Result< void > SetParentSelection (const HashSet< Id > &parentSelection, const HashSet< Id > &selectOnNextUpdate)
     
    MAXON_METHOD Result< void > SetSelectionOnNextUpdate (const HashSet< Id > &selectOnNextUpdate)
     
    MAXON_METHOD Result< void > GetParentSelection (const ValueReceiver< const Id & > &parentSelection) const
     
    MAXON_METHOD Result< void > GetParentSelection (const ValueReceiver< const IdAndVersion & > &parentSelection) const
     
    MAXON_METHOD HashSet< IdGetAndClearSelectionOnNextUpdate ()
     
    MAXON_METHOD Result< void > SetDatabaseMasterfilter (const HashSet< Id > &masterFilterDatabaseIds)
     
    MAXON_METHOD Result< void > GetDatabaseMasterfilter (const ValueReceiver< const Id & > &filteredDatabases) const
     
    MAXON_METHOD Result< void > SetSmartSearch (const Block< AssetDescription > &smartSearch)
     
    MAXON_METHOD Result< StringGetSmartSearchString () const
     
    MAXON_METHOD Bool GetAndResetClearState ()
     
    MAXON_METHOD void JobRefReset (Bool wait)
     
    MAXON_METHOD void DoFiltering (const String &masterFilter, const String &groupFilter, const String &sortFilter, const String &filterString, Bool localFilterMode, Bool showUnavailable)
     
    MAXON_METHOD void GetFilterStrings (String &masterFilter, String &groupFilter, String &sortFilter, String &filterString, Bool &localFilterMode) const
     
    MAXON_METHOD Block< const StringGetSearchStrings () const
     
    MAXON_METHOD const StringGetFilterString () const
     
    MAXON_METHOD void RequestAssetBrowserUpdate ()
     
    MAXON_METHOD ASSETBROWSERMODE GetBrowseMode () const
     
    MAXON_METHOD Result< void > CopySettingsFrom (const AssetBrowserRef &source)
     
    MAXON_METHOD void SetInitDataDelegate (InitDataDelegate &&delegate)
     
    MAXON_METHOD void SetRelevantMasterFilter (MASTERFILTER filter)
     
    MAXON_METHOD void SetActiveManager (Int32 managerId)
     
    MAXON_METHOD void SetGetCommandRestrictionManagerDelegate (GetAssetDataDelegate &&delegate)
     
    MAXON_METHOD void SetGetAssetDefaultPresetPluginTypeDelegate (GetAssetDataDelegate &&delegate)
     

    Static Public Member Functions

    static MAXON_METHOD Result< AssetBrowserRef > Create (ASSETBROWSERMODE mode=ASSETBROWSERMODE::ASSETS)
     
    static MAXON_METHOD ASSETSORTBY GetDefaultSortByFromGroupBy (ASSETGROUPBY groupBy)
     
    static MAXON_METHOD Result< BoolHasMissingDependencies (const AssetRepositoryRef &lookupRepository, const AssetDescription &asset, HashSet< IdAndVersion > &checked)
     
    static MAXON_METHOD Result< BoolHasRedshiftDependencies (const AssetDescription &ad)
     
    static MAXON_METHOD Tuple< String, StringGetAssetTypeName (const Id &id)
     
    static MAXON_METHOD Result< Tuple< String, String > > GetAssetTypeName (const AssetRepositoryRef &repository, const Id &assetType, const Id &assetId, const Id &versionId, Bool addParentCategories, AssetTypeNameMap *cacheMap)
     
    static MAXON_METHOD Result< Tuple< String, String > > GetAssetTypeName (const AssetRepositoryRef &repository, const AssetType &assetType, const Id &assetId, const Id &versionId, Bool addParentCategories, AssetTypeNameMap *cacheMap)
     
    static MAXON_METHOD Tuple< Bool, ColorGetAssetColorBar (const AssetDescription &asset, const AssetRepositoryRef &lookupRepository)
     
    static MAXON_METHOD Result< StringGetTagStrings (const AssetDescription &asset, const nodes::NodeSystemClass &nodeSystemClass, HashMap< Id, GraphNode > &filterCache)
     
    static MAXON_METHOD Result< FILTERASSETRESULTIsNodeHidden (const AssetDescription &asset, const nodes::NodeSystemClass &cls)
     

    Private Member Functions

     MAXON_INTERFACE (AssetBrowserInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.assetbrowser")
     

    Member Typedef Documentation

    ◆ InitDataDelegate

    using InitDataDelegate = Delegate<Result<void>()>

    ◆ GetAssetDataDelegate

    using GetAssetDataDelegate = Delegate<Result<Int32>(const AssetDescription& asset)>

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( AssetBrowserInterface  ,
    MAXON_REFERENCE_NORMAL  ,
    "net.maxon.interface.assetbrowser"   
    )
    private

    ◆ Create()

    static MAXON_METHOD Result<AssetBrowserRef> Create ( ASSETBROWSERMODE  mode = ASSETBROWSERMODE::ASSETS)
    static

    ◆ SkipWatchfolders()

    MAXON_METHOD void SkipWatchfolders ( Bool  skip)

    ◆ SkipCommandAssets()

    MAXON_METHOD void SkipCommandAssets ( Bool  skip)

    ◆ ShowHiddenFlaggedCommandAssets()

    MAXON_METHOD void ShowHiddenFlaggedCommandAssets ( Bool  show)

    ◆ GetShowHiddenFlaggedCommandAssets()

    MAXON_METHOD Bool GetShowHiddenFlaggedCommandAssets ( ) const

    ◆ SetLengthUnitSystem()

    MAXON_METHOD void SetLengthUnitSystem ( LENGTHUNITSYSTEM  system)

    ◆ EnableUpdates()

    MAXON_METHOD void EnableUpdates ( Bool  enableUpdates)

    ◆ GetLookupRepository()

    MAXON_METHOD AssetRepositoryRef GetLookupRepository ( ) const

    ◆ SetGraphModel()

    MAXON_METHOD Result<void> SetGraphModel ( const nodes::NodesGraphModelRef &  nodesGraphRef)

    ◆ SetBuildEntryDelegate()

    MAXON_METHOD Result<void> SetBuildEntryDelegate ( BuildBrowserEntryDelegate &&  builderDelegate)

    ◆ SetAssetTypesFilter()

    MAXON_METHOD Result<void> SetAssetTypesFilter ( const HashSet< Id > &  assetTypes)

    ◆ GetAssetTypesFilter()

    MAXON_METHOD Result<void> GetAssetTypesFilter ( const ValueReceiver< const Id & > &  assetTypes) const

    ◆ SetParentSelection()

    MAXON_METHOD Result<void> SetParentSelection ( const HashSet< Id > &  parentSelection,
    const HashSet< Id > &  selectOnNextUpdate 
    )

    ◆ SetSelectionOnNextUpdate()

    MAXON_METHOD Result<void> SetSelectionOnNextUpdate ( const HashSet< Id > &  selectOnNextUpdate)

    ◆ GetParentSelection() [1/2]

    MAXON_METHOD Result<void> GetParentSelection ( const ValueReceiver< const Id & > &  parentSelection) const

    ◆ GetParentSelection() [2/2]

    MAXON_METHOD Result<void> GetParentSelection ( const ValueReceiver< const IdAndVersion & > &  parentSelection) const

    ◆ GetAndClearSelectionOnNextUpdate()

    MAXON_METHOD HashSet<Id> GetAndClearSelectionOnNextUpdate ( )

    ◆ SetDatabaseMasterfilter()

    MAXON_METHOD Result<void> SetDatabaseMasterfilter ( const HashSet< Id > &  masterFilterDatabaseIds)

    ◆ GetDatabaseMasterfilter()

    MAXON_METHOD Result<void> GetDatabaseMasterfilter ( const ValueReceiver< const Id & > &  filteredDatabases) const

    ◆ SetSmartSearch()

    MAXON_METHOD Result<void> SetSmartSearch ( const Block< AssetDescription > &  smartSearch)

    ◆ GetSmartSearchString()

    MAXON_METHOD Result<String> GetSmartSearchString ( ) const

    ◆ GetAndResetClearState()

    MAXON_METHOD Bool GetAndResetClearState ( )

    ◆ JobRefReset()

    MAXON_METHOD void JobRefReset ( Bool  wait)

    ◆ DoFiltering()

    MAXON_METHOD void DoFiltering ( const String masterFilter,
    const String groupFilter,
    const String sortFilter,
    const String filterString,
    Bool  localFilterMode,
    Bool  showUnavailable 
    )

    ◆ GetFilterStrings()

    MAXON_METHOD void GetFilterStrings ( String masterFilter,
    String groupFilter,
    String sortFilter,
    String filterString,
    Bool localFilterMode 
    ) const

    ◆ GetSearchStrings()

    MAXON_METHOD Block<const String> GetSearchStrings ( ) const

    ◆ GetFilterString()

    MAXON_METHOD const String& GetFilterString ( ) const

    ◆ RequestAssetBrowserUpdate()

    MAXON_METHOD void RequestAssetBrowserUpdate ( )

    ◆ GetBrowseMode()

    MAXON_METHOD ASSETBROWSERMODE GetBrowseMode ( ) const

    ◆ CopySettingsFrom()

    MAXON_METHOD Result<void> CopySettingsFrom ( const AssetBrowserRef &  source)

    ◆ SetInitDataDelegate()

    MAXON_METHOD void SetInitDataDelegate ( InitDataDelegate &&  delegate)

    ◆ SetRelevantMasterFilter()

    MAXON_METHOD void SetRelevantMasterFilter ( MASTERFILTER  filter)

    ◆ SetActiveManager()

    MAXON_METHOD void SetActiveManager ( Int32  managerId)

    ◆ SetGetCommandRestrictionManagerDelegate()

    MAXON_METHOD void SetGetCommandRestrictionManagerDelegate ( GetAssetDataDelegate &&  delegate)

    ◆ SetGetAssetDefaultPresetPluginTypeDelegate()

    MAXON_METHOD void SetGetAssetDefaultPresetPluginTypeDelegate ( GetAssetDataDelegate &&  delegate)

    ◆ GetDefaultSortByFromGroupBy()

    static MAXON_METHOD ASSETSORTBY GetDefaultSortByFromGroupBy ( ASSETGROUPBY  groupBy)
    static

    ◆ HasMissingDependencies()

    static MAXON_METHOD Result<Bool> HasMissingDependencies ( const AssetRepositoryRef &  lookupRepository,
    const AssetDescription &  asset,
    HashSet< IdAndVersion > &  checked 
    )
    static

    ◆ HasRedshiftDependencies()

    static MAXON_METHOD Result<Bool> HasRedshiftDependencies ( const AssetDescription &  ad)
    static

    ◆ GetAssetTypeName() [1/3]

    static MAXON_METHOD Tuple<String, String> GetAssetTypeName ( const Id id)
    static

    ◆ GetAssetTypeName() [2/3]

    static MAXON_METHOD Result<Tuple<String, String> > GetAssetTypeName ( const AssetRepositoryRef &  repository,
    const Id assetType,
    const Id assetId,
    const Id versionId,
    Bool  addParentCategories,
    AssetTypeNameMap cacheMap 
    )
    static

    ◆ GetAssetTypeName() [3/3]

    static MAXON_METHOD Result<Tuple<String, String> > GetAssetTypeName ( const AssetRepositoryRef &  repository,
    const AssetType &  assetType,
    const Id assetId,
    const Id versionId,
    Bool  addParentCategories,
    AssetTypeNameMap cacheMap 
    )
    static

    ◆ GetAssetColorBar()

    static MAXON_METHOD Tuple<Bool, Color> GetAssetColorBar ( const AssetDescription &  asset,
    const AssetRepositoryRef &  lookupRepository 
    )
    static

    ◆ GetTagStrings()

    static MAXON_METHOD Result<String> GetTagStrings ( const AssetDescription &  asset,
    const nodes::NodeSystemClass &  nodeSystemClass,
    HashMap< Id, GraphNode > &  filterCache 
    )
    static

    ◆ IsNodeHidden()

    static MAXON_METHOD Result<FILTERASSETRESULT> IsNodeHidden ( const AssetDescription &  asset,
    const nodes::NodeSystemClass &  cls 
    )
    static