property.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_PROPERTY_H
#define PXR_USD_USD_PROPERTY_H
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/common.h"
#include "pxr/usd/usd/object.h"
#include "pxr/usd/usd/prim.h"
 
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/propertySpec.h"
#include "pxr/base/vt/value.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class UsdProperty;
 
class UsdProperty : public UsdObject {
public:
    UsdProperty() : UsdObject(_Null<UsdProperty>()) {}
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
 
    USD_API
    SdfPropertySpecHandleVector GetPropertyStack(
        UsdTimeCode time = UsdTimeCode::Default()) const;
 
    USD_API
    std::vector<std::pair<SdfPropertySpecHandle, SdfLayerOffset>> 
    GetPropertyStackWithLayerOffsets(
        UsdTimeCode time = UsdTimeCode::Default()) const;
 
    USD_API
    TfToken GetBaseName() const;
 
    USD_API
    TfToken GetNamespace() const;
 
    USD_API
    std::vector<std::string> SplitName() const;
 
 
    USD_API
    std::string GetDisplayGroup() const;
 
    USD_API
    bool SetDisplayGroup(const std::string& displayGroup) const;
 
    USD_API
    bool ClearDisplayGroup() const;
 
    USD_API
    bool HasAuthoredDisplayGroup() const;
 
    USD_API
    std::vector<std::string> GetNestedDisplayGroups() const;
 
    USD_API
    bool SetNestedDisplayGroups(
        const std::vector<std::string>& nestedGroups) const;
 
    USD_API
    bool IsCustom() const;
 
    USD_API
    bool SetCustom(bool isCustom) const;
 
 
    USD_API
    bool IsDefined() const;
 
    USD_API
    bool IsAuthored() const;
 
    USD_API
    bool IsAuthoredAt(const class UsdEditTarget &editTarget) const;
 
 
    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //
 
    USD_API
    UsdProperty FlattenTo(const UsdPrim &parent) const;
 
    USD_API
    UsdProperty FlattenTo(const UsdPrim &parent,
                          const TfToken &propName) const;
 
    USD_API
    UsdProperty FlattenTo(const UsdProperty &property) const;
 
protected:
    template <class Derived>
    UsdProperty(_Null<Derived>) : UsdObject(_Null<Derived>()) {}
 
    // Gets the targets of the given spec type. Returns true if an authored
    // opinion is found and no composition errors occured. If foundErrors is
    // provided, it will be set to true only if errors are encountered.
    bool _GetTargets(SdfSpecType specType, SdfPathVector *out,
                     bool *foundErrors = nullptr) const;
    
private:
    friend class UsdAttribute;
    friend class UsdObject;
    friend class UsdPrim;
    friend class UsdRelationship;
    friend class Usd_PrimData;
 
    UsdProperty(UsdObjType objType,
                const Usd_PrimDataHandle &prim,
                const SdfPath &proxyPrimPath,
                const TfToken &propName)
        : UsdObject(objType, prim, proxyPrimPath, propName) {}
 
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_PROPERTY_H