All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
layerTree.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef SDF_LAYER_TREE_H
25 #define SDF_LAYER_TREE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/sdf/api.h"
31 #include "pxr/usd/sdf/declareHandles.h"
32 #include "pxr/usd/sdf/layerOffset.h"
33 
34 #include <boost/noncopyable.hpp>
35 #include <vector>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 // Layer tree forward declarations.
40 class SdfLayerTree;
42 typedef std::vector<SdfLayerTreeHandle> SdfLayerTreeHandleVector;
43 
44 SDF_DECLARE_HANDLES(SdfLayer);
45 
58 class SdfLayerTree : public TfRefBase, public TfWeakBase, boost::noncopyable {
59 public:
61  SDF_API
62  static SdfLayerTreeHandle
63  New( const SdfLayerHandle & layer,
64  const SdfLayerTreeHandleVector & childTrees,
65  const SdfLayerOffset & cumulativeOffset = SdfLayerOffset() );
66 
68  SDF_API const SdfLayerHandle & GetLayer() const;
69 
71  SDF_API const SdfLayerOffset & GetOffset() const;
72 
74  SDF_API const SdfLayerTreeHandleVector & GetChildTrees() const;
75 
76 private:
77  SdfLayerTree( const SdfLayerHandle & layer,
78  const SdfLayerTreeHandleVector & childTrees,
79  const SdfLayerOffset & cumulativeOffset );
80 
81 private:
82  const SdfLayerHandle _layer;
83  const SdfLayerOffset _offset;
84  const SdfLayerTreeHandleVector _childTrees;
85 };
86 
87 PXR_NAMESPACE_CLOSE_SCOPE
88 
89 #endif // SDF_LAYER_TREE_H
A unit of scene description that you combine with other units of scene description to form a shot...
Definition: layer.h:93
SDF_API const SdfLayerTreeHandleVector & GetChildTrees() const
Returns the children of this tree node.
SDF_API const SdfLayerHandle & GetLayer() const
Returns the layer handle this tree node represents.
Enable a concrete base class for use with TfRefPtr.
Definition: refBase.h:72
static SDF_API SdfLayerTreeHandle New(const SdfLayerHandle &layer, const SdfLayerTreeHandleVector &childTrees, const SdfLayerOffset &cumulativeOffset=SdfLayerOffset())
Create a new layer tree node.
SDF_API const SdfLayerOffset & GetOffset() const
Returns the cumulative layer offset from the root of the tree.
A SdfLayerTree is an immutable tree structure representing a sublayer stack and its recursive structu...
Definition: layerTree.h:58
Represents a time offset and scale between layers.
Definition: layerOffset.h:61
Enable a concrete base class for use with TfWeakPtr.
Definition: weakBase.h:142