FnDefaultAssetPlugin.h

// Copyright (c) 2012 The Foundry Visionmongers Ltd. All Rights Reserved.

#ifndef FNDEFAULTASSETPLUGIN__H
#define FNDEFAULTASSETPLUGIN__H

#include <map>
#include <string>
#include <vector>

#include <FnAsset/FnAssetAPI.h>
#include <FnAsset/ns.h>
#include <FnAsset/suite/FnAssetSuite.h>
#include <FnPluginSystem/FnPlugin.h>
#include <FnPluginSystem/FnPluginSystem.h>

FNASSET_NAMESPACE_ENTER
{
    class FNASSET_API DefaultAssetPlugin
    {
    public:

        static bool isAssetId(const std::string& str, bool throwOnError=false);

        static bool containsAssetId(const std::string& str,
                                    bool throwOnError=false);


        static std::string resolveAsset(const std::string& assetId,
                                        bool throwOnError=false);


        static std::string resolveAllAssets(const std::string &inputString,
                                            bool throwOnError = false);

        static std::string resolvePath(const std::string& path, int frame,
                                       bool throwOnError=false);


        static std::string getUniqueScenegraphLocationFromAssetId(
                const std::string & assetId, bool includeVersion,
                bool throwOnError=false);

        static std::string getRelatedAssetId(
                const std::string & assetId, const std::string& relation,
                bool throwOnError=false);

        static bool getAssetAttributes(
            const std::string &assetId, const std::string &scope,
            std::map<std::string, std::string> &attributesMap,
            bool throwOnError = false);

        static bool checkPermissions(
            const std::string &assetId,
            const std::map<std::string, std::string> &context,
            bool throwOnError = false);

        static std::string resolveAssetVersion(
            const std::string &assetId,
            const std::string &versionTag = std::string(),
            bool throwOnError = false);

        static std::string getAssetDisplayName(
            const std::string &assetId, bool throwOnError = false);

        static bool getAssetVersions(
            const std::string& assetId,
            std::vector<std::string> &versions,
            bool throwOnError = false);

        static bool getAssetFields(
            const std::string &assetId, bool includeDefaults,
            std::map<std::string, std::string> &returnFields,
            bool throwOnError = false);

        static std::string buildAssetId(
            const std::map<std::string, std::string> &fields,
            bool throwOnError = false);

        static std::string getAssetIdForScope(
            const std::string &assetId, const std::string &scope,
            bool throwOnError = false);

        static FnPlugStatus setHost(FnPluginHost *host);

    private:
        static const FnDefaultAssetHostSuite* _hostSuite;

    };

}
FNASSET_NAMESPACE_EXIT

#endif  // FNDEFAULTASSETPLUGIN__H