inherits.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_INHERITS_H
#define PXR_USD_USD_INHERITS_H
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/common.h"
#include "pxr/usd/usd/prim.h"
 
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/path.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfPrimSpec);
 
class UsdInherits {
    friend class UsdPrim;
 
    explicit UsdInherits(const UsdPrim& prim) : _prim(prim) {}
 
public:
    USD_API
    bool AddInherit(const SdfPath &primPath,
                    UsdListPosition position=UsdListPositionBackOfPrependList);
 
    USD_API
    bool RemoveInherit(const SdfPath &primPath);
 
    USD_API
    bool ClearInherits();
 
    USD_API
    bool SetInherits(const SdfPathVector& items);
 
    USD_API
    SdfPathVector GetAllDirectInherits() const;
    
    const UsdPrim &GetPrim() const { return _prim; }
    UsdPrim GetPrim() { return _prim; }
 
    explicit operator bool() { return bool(_prim); }
 
    // ---------------------------------------------------------------------- //
    // Private Methods and Members
    // ---------------------------------------------------------------------- //
private:
 
    UsdPrim _prim;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_USD_INHERITS_H