layerTree.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_LAYER_TREE_H
#define PXR_USD_SDF_LAYER_TREE_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/layerOffset.h"
 
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
// Layer tree forward declarations.
class SdfLayerTree;
typedef TfRefPtr<SdfLayerTree> SdfLayerTreeHandle;
typedef std::vector<SdfLayerTreeHandle> SdfLayerTreeHandleVector;
 
SDF_DECLARE_HANDLES(SdfLayer);
 
class SdfLayerTree : public TfRefBase, public TfWeakBase {
    SdfLayerTree(const SdfLayerTree&) = delete;
    SdfLayerTree& operator=(const SdfLayerTree&) = delete;
public:
    SDF_API
    static SdfLayerTreeHandle
    New( const SdfLayerHandle & layer,
         const SdfLayerTreeHandleVector & childTrees,
         const SdfLayerOffset & cumulativeOffset = SdfLayerOffset() );
 
    SDF_API const SdfLayerHandle & GetLayer() const;
 
    SDF_API const SdfLayerOffset & GetOffset() const;
 
    SDF_API const SdfLayerTreeHandleVector & GetChildTrees() const;
 
private:
    SdfLayerTree( const SdfLayerHandle & layer,
                  const SdfLayerTreeHandleVector & childTrees,
                  const SdfLayerOffset & cumulativeOffset );
 
private:
    const SdfLayerHandle _layer;
    const SdfLayerOffset _offset;
    const SdfLayerTreeHandleVector _childTrees;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_LAYER_TREE_H