attributeSpec.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 PXR_USD_SDF_ATTRIBUTE_SPEC_H
#define PXR_USD_SDF_ATTRIBUTE_SPEC_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareSpec.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/propertySpec.h"
#include "pxr/usd/sdf/types.h"
#include "pxr/base/tf/enum.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TsSpline;
 
class SdfAttributeSpec : public SdfPropertySpec
{
    SDF_DECLARE_SPEC(SdfAttributeSpec, SdfPropertySpec);
 
public:
    typedef SdfAttributeSpec This;
    typedef SdfPropertySpec Parent;
 
 
    SDF_API
    static SdfAttributeSpecHandle
    New(const SdfPrimSpecHandle& owner,
        const std::string& name, const SdfValueTypeName& typeName,
        SdfVariability variability = SdfVariabilityVarying,
        bool custom = false);
 
 
 
    SDF_API
    SdfConnectionsProxy GetConnectionPathList() const;
 
    SDF_API
    bool HasConnectionPaths() const;
 
    SDF_API
    void ClearConnectionPaths();
 
 
    SDF_API
    VtTokenArray GetAllowedTokens() const;
 
    SDF_API
    void SetAllowedTokens(const VtTokenArray& allowedTokens);
 
    SDF_API
    bool HasAllowedTokens() const;
 
    SDF_API
    void ClearAllowedTokens(); 
 
    SDF_API
    VtDictionary GetLimits() const;
 
    SDF_API
    void SetLimits(const VtDictionary& limits);
 
    SDF_API
    bool HasLimits() const;
 
    SDF_API
    void ClearLimits();
 
    SDF_API
    TfEnum GetDisplayUnit() const;
 
    SDF_API
    void SetDisplayUnit(const TfEnum& displayUnit);
 
    SDF_API
    bool HasDisplayUnit() const;
 
    SDF_API
    void ClearDisplayUnit();
 
    SDF_API
    TfToken GetColorSpace() const;
 
    SDF_API
    void SetColorSpace(const TfToken &colorSpace);
 
    SDF_API
    bool HasColorSpace() const;
 
    SDF_API
    void ClearColorSpace();
 
    SDF_API
    int64_t GetArraySizeConstraint() const;
 
    SDF_API
    void SetArraySizeConstraint(int64_t constraint);
 
    SDF_API
    bool HasArraySizeConstraint() const;
 
    SDF_API
    void ClearArraySizeConstraint();
 
 
    SDF_API
    TfToken GetRoleName() const;
 
    
    SDF_API
    bool HasSpline() const;
 
    SDF_API
    TsSpline GetSpline() const;
 
    SDF_API
    void SetSpline(const TsSpline& value);
 
    SDF_API
    void ClearSpline();
 
 
    SDF_API
    SdfTimeSampleMap GetTimeSampleMap() const;
 
    SDF_API
    std::set<double> ListTimeSamples() const;
 
    SDF_API
    size_t GetNumTimeSamples() const;
 
    SDF_API
    bool GetBracketingTimeSamples(double time, double* tLower,
                                  double* tUpper) const;
 
    SDF_API
    bool QueryTimeSample(double time, VtValue *value=NULL) const;
    SDF_API
    bool QueryTimeSample(double time, SdfAbstractDataValue *value) const;
 
    template <class T>
    bool QueryTimeSample(double time, T* data) const
    {
        if (!data) {
            return QueryTimeSample(time);
        }
 
        SdfAbstractDataTypedValue<T> outValue(data);
        const bool hasValue = QueryTimeSample(
            time, static_cast<SdfAbstractDataValue *>(&outValue));
 
        if (std::is_same<T, SdfValueBlock>::value) {
            return hasValue && outValue.isValueBlock;
        }
 
        return hasValue && (!outValue.isValueBlock);
    }
 
    SDF_API
    void SetTimeSample(double time, const VtValue & value);
    SDF_API
    void SetTimeSample(double time, const SdfAbstractDataConstValue& value);
 
    template <class T>
    void SetTimeSample(double time, const T& value)
    {
        const SdfAbstractDataConstTypedValue<T> inValue(&value);
        const SdfAbstractDataConstValue& untypedInValue = inValue;
        return SetTimeSample(time, untypedInValue);
    }
 
    SDF_API
    void EraseTimeSample(double time);
 
};
 
SDF_API
SdfAttributeSpecHandle
SdfCreatePrimAttributeInLayer(
    const SdfLayerHandle &layer,
    const SdfPath &attrPath,
    const SdfValueTypeName &typeName,
    SdfVariability variability = SdfVariabilityVarying,
    bool isCustom = false);
 
SDF_API
bool
SdfJustCreatePrimAttributeInLayer(
    const SdfLayerHandle &layer,
    const SdfPath &attrPath,
    const SdfValueTypeName &typeName,
    SdfVariability variability = SdfVariabilityVarying,
    bool isCustom = false);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_ATTRIBUTE_SPEC_H