attribute.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_USD_ATTRIBUTE_H
#define PXR_USD_USD_ATTRIBUTE_H
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/common.h"
#include "pxr/usd/usd/property.h"
#include "pxr/usd/usd/resolveInfo.h"
 
#include "pxr/usd/sdf/abstractData.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/types.h"
#include "pxr/base/vt/dictionary.h"
#include "pxr/base/vt/value.h"
#include "pxr/base/gf/interval.h"
 
#include <string>
#include <type_traits>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdAttribute;
class UsdAttributeLimits;
class TsSpline;
 
typedef std::vector<UsdAttribute> UsdAttributeVector;
 
class UsdAttribute : public UsdProperty {
public:
    UsdAttribute() : UsdProperty(_Null<UsdAttribute>()) {}
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
 
    USD_API
    SdfVariability GetVariability() const;
 
    USD_API
    bool SetVariability(SdfVariability variability) const;
 
    USD_API
    SdfValueTypeName GetTypeName() const;
 
    USD_API
    bool SetTypeName(const SdfValueTypeName& typeName) const;
 
    USD_API
    TfToken GetRoleName() const;
 
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
 
    USD_API
    bool GetTimeSamples(std::vector<double>* times) const;
 
    USD_API
    bool GetTimeSamplesInInterval(const GfInterval& interval,
                                  std::vector<double>* times) const;
 
    USD_API
    static bool GetUnionedTimeSamples(const std::vector<UsdAttribute> &attrs, 
                                      std::vector<double> *times);
 
    USD_API
    static bool GetUnionedTimeSamplesInInterval(
        const std::vector<UsdAttribute> &attrs, 
        const GfInterval &interval,
        std::vector<double> *times);
 
    USD_API
    size_t GetNumTimeSamples() const;
 
    USD_API
    bool GetBracketingTimeSamples(double desiredTime, 
                                  double* lower, 
                                  double* upper, 
                                  bool* hasTimeSamples) const;
 
    USD_API
    bool HasValue() const;
 
    USD_API
    bool HasAuthoredValueOpinion() const;
 
    USD_API
    bool HasAuthoredValue() const;
 
    USD_API
    bool HasFallbackValue() const;
 
    USD_API
    bool ValueMightBeTimeVarying() const;
 
    template <typename T>
    bool Get(T* value, UsdTimeCode time = UsdTimeCode::Default()) const {
        static_assert(!std::is_const<T>::value, "");
        static_assert(SdfValueTypeTraits<T>::IsValueType, "");
        return _Get(value, time);
    }
    USD_API
    bool Get(VtValue* value, UsdTimeCode time = UsdTimeCode::Default()) const;
 
    template <typename T>
    bool GetFallbackValue(T* value) const {
        static_assert(!std::is_const<T>::value);
        static_assert(SdfValueTypeTraits<T>::IsValueType);
        UsdPrimDefinition::Attribute attrDef =
            _GetStage()->_GetSchemaAttribute(*this);
        return attrDef && attrDef.GetFallbackValue<T>(value);
    }
 
    USD_API
    bool GetFallbackValue(VtValue* value) const;
 
    USD_API
    UsdResolveInfo
    GetResolveInfo(UsdTimeCode time) const;
 
    USD_API
    UsdResolveInfo
    GetResolveInfo() const;
 
    template <typename T>
    bool Set(const T& value, UsdTimeCode time = UsdTimeCode::Default()) const {
        static_assert(!std::is_pointer<T>::value, "");
        static_assert(SdfValueTypeTraits<T>::IsValueType ||
                      std::is_same<T, SdfValueBlock>::value ||
                      std::is_same<T, SdfAnimationBlock>::value, "");
        return _Set(value, time);
    }
 
    USD_API
    bool Set(const char* value, UsdTimeCode time = UsdTimeCode::Default()) const;
 
    USD_API
    bool Set(const VtValue& value, UsdTimeCode time = UsdTimeCode::Default()) const;
 
    USD_API
    bool HasSpline() const;
 
    USD_API
    TsSpline GetSpline() const;
 
    USD_API
    bool SetSpline(const TsSpline &spline) const;
 
    USD_API
    bool Clear() const;
 
    USD_API
    bool ClearAtTime(UsdTimeCode time) const;
 
    USD_API
    bool ClearDefault() const;
 
    USD_API
    void Block() const;
 
    USD_API
    void BlockAnimation() const;
 
 
 
    USD_API
    bool AddConnection(const SdfPath& source,
           UsdListPosition position=UsdListPositionBackOfPrependList) const;
 
    USD_API
    bool RemoveConnection(const SdfPath& source) const;
 
    USD_API
    bool SetConnections(const SdfPathVector& sources) const;
 
    USD_API
    bool ClearConnections() const;
 
    USD_API
    bool GetConnections(SdfPathVector* sources) const;
 
    USD_API
    bool HasAuthoredConnections() const;
 
    
    // ---------------------------------------------------------------------- //
    // ---------------------------------------------------------------------- //
 
    USD_API
    TfToken GetColorSpace() const;
 
    USD_API
    void SetColorSpace(const TfToken &colorSpace) const;
 
    USD_API
    bool HasColorSpace() const;
 
    USD_API
    bool ClearColorSpace() const;
 
 
 
    USD_API
    VtDictionary GetLimits() const;
 
    USD_API
    bool SetLimits(const VtDictionary& limits) const;
 
    USD_API
    bool HasAuthoredLimits() const;
 
    USD_API
    bool ClearLimits() const;
 
    USD_API
    UsdAttributeLimits GetSoftLimits() const;
 
    USD_API
    UsdAttributeLimits GetHardLimits() const;
 
    USD_API
    UsdAttributeLimits GetLimits(const TfToken& key) const;
 
 
 
    USD_API
    int64_t GetArraySizeConstraint() const;
 
    USD_API
    bool SetArraySizeConstraint(int64_t constraint) const;
 
    USD_API
    bool HasAuthoredArraySizeConstraint() const;
 
    USD_API
    bool ClearArraySizeConstraint() const;
 
 
    // ---------------------------------------------------------------------- //
    // Private Methods and Members 
    // ---------------------------------------------------------------------- //
private:
    friend class UsdAttributeQuery;
    friend class UsdObject;
    friend class UsdPrim;
    friend class UsdSchemaBase;
    friend class Usd_PrimData;
    friend struct UsdPrim_AttrConnectionFinder;
    
    UsdAttribute(const Usd_PrimDataHandle &prim,
                 const SdfPath &proxyPrimPath,
                 const TfToken &attrName)
        : UsdProperty(UsdTypeAttribute, prim, proxyPrimPath, attrName) {}
 
    UsdAttribute(UsdObjType objType,
                 const Usd_PrimDataHandle &prim,
                 const SdfPath &proxyPrimPath,
                 const TfToken &propName)
        : UsdProperty(objType, prim, proxyPrimPath, propName) {}
 
    SdfAttributeSpecHandle
    _CreateSpec(const SdfValueTypeName &typeName, bool custom,
                const SdfVariability &variability) const;
 
    // Like _CreateSpec(), but fail if this attribute is not built-in and there
    // isn't already existing scene description to go on rather than stamping
    // new information.
    SdfAttributeSpecHandle _CreateSpec() const;
 
    bool _Create(const SdfValueTypeName &typeName, bool custom,
                 const SdfVariability &variability) const;
 
    template <typename T>
    bool _Get(T* value, UsdTimeCode time) const;
 
    template <typename T>
    bool _Set(const T& value, UsdTimeCode time) const;
 
    SdfPath
    _GetPathForAuthoring(const SdfPath &path, std::string* whyNot) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_ATTRIBUTE_H