colorSpaceAPI.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef USD_GENERATED_COLORSPACEAPI_H
#define USD_GENERATED_COLORSPACEAPI_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usd/tokens.h"
 
#include "pxr/base/gf/colorSpace.h"
#include "pxr/base/tf/bigRWMutex.h"
 
 
#include "pxr/base/vt/value.h"
 
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"
 
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfAssetPath;
 
// -------------------------------------------------------------------------- //
// COLORSPACEAPI                                                              //
// -------------------------------------------------------------------------- //
 
class UsdColorSpaceAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
 
    explicit UsdColorSpaceAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }
 
    explicit UsdColorSpaceAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }
 
    USD_API
    virtual ~UsdColorSpaceAPI();
 
    USD_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USD_API
    static UsdColorSpaceAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
 
    USD_API
    static bool 
    CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
 
    USD_API
    static UsdColorSpaceAPI 
    Apply(const UsdPrim &prim);
 
protected:
    USD_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USD_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USD_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // COLORSPACENAME 
    // --------------------------------------------------------------------- //
    USD_API
    UsdAttribute GetColorSpaceNameAttr() const;
 
    USD_API
    UsdAttribute CreateColorSpaceNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--
 
    class ColorSpaceCache {
    public:
        ColorSpaceCache() = default;
        virtual ~ColorSpaceCache() = default;
 
        virtual TfToken Find(const SdfPath& prim) = 0;
        virtual void Insert(const SdfPath& prim, const TfToken& colorSpace) = 0;
    };
 
    class ColorSpaceHashCache : public ColorSpaceCache {
    protected:
        TfHashMap<SdfPath, TfToken, SdfPath::Hash> _cache;
        mutable TfBigRWMutex _mutex;
    public:
        ColorSpaceHashCache() = default;
        ~ColorSpaceHashCache() = default;
 
        TfToken Find(const SdfPath& prim) override {
            TfBigRWMutex::ScopedLock lock(_mutex, /*write=*/false);
            auto it = _cache.find(prim);
            if (it != _cache.end()) {
                return it->second;
            }
            return TfToken();
        }
 
        void Insert(const SdfPath& prim, const TfToken& colorSpace) override {
            TfBigRWMutex::ScopedLock lock(_mutex);
            _cache[prim] = colorSpace;
        }
    };
 
    USD_API
    static TfToken ComputeColorSpaceName(const UsdAttribute& attribute,
                                                 ColorSpaceCache* cache = nullptr);
 
    USD_API
    static GfColorSpace ComputeColorSpace(const UsdAttribute& attribute,
                                                  ColorSpaceCache* cache = nullptr);
 
    USD_API
    static TfToken ComputeColorSpaceName(UsdPrim prim,
                                         ColorSpaceCache* cache = nullptr);
 
    USD_API
    static GfColorSpace ComputeColorSpace(UsdPrim prim,
                                          const TfToken& colorSpace,
                                          ColorSpaceCache* cache = nullptr);
 
    USD_API
    static GfColorSpace ComputeColorSpace(UsdPrim prim,
                                          ColorSpaceCache* cache = nullptr);
 
    USD_API
    static bool IsValidColorSpaceName(UsdPrim prim, 
                                      const TfToken& colorSpace,
                                      ColorSpaceCache* cache = nullptr);
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif