HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stageEdit.h
Go to the documentation of this file.
1 //
2 // Copyright 2017 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 _GUSD_STAGEEDIT_H_
25 #define _GUSD_STAGEEDIT_H_
26 
27 #include "gusd/api.h"
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/sdf/path.h"
31 #include "pxr/usd/sdf/layer.h"
32 #include "pxr/usd/usd/stage.h"
33 
34 #include <UT/UT_Array.h>
35 #include <UT/UT_Error.h>
36 #include <UT/UT_IntrusivePtr.h>
37 
38 
40 
41 
43 
44 
45 /// Basic stage edit covering common types of edits.
46 ///
47 /// This class provides a single point for describing all of the common
48 /// types of edits so that, at least in the typical cases, code pulling
49 /// data from the stage cache are using a common type of edit.
50 ///
51 /// Note that when applying variant edits, variant selection paths should be
52 /// stripped of any trailing path components following the variant selection.
53 /// For example, rather than creating an edit applying variant selection
54 /// `/foo{a=b}bar`, it is better to use path `/foo{a=b}` as the variant
55 /// selection path. The GetPrimPathAndEditFromVariantsPath helper automatically
56 /// strips all such trailing path components.
58  : public UT_IntrusiveRefCounter<GusdStageEdit>
59 {
60 public:
61 
62  /// Extract a prim path and an edit from a path string,
63  /// which may include variant selections.
64  /// This covers the common case where a single parameter
65  /// provides a prim path, which may include variant selections
66  /// (Eg., as /foo{variant=sel}bar).
67  static void
68  GetPrimPathAndEditFromVariantsPath(const SdfPath& pathWithVariants,
69  SdfPath& primPath,
70  GusdStageEditPtr& edit);
71 
72  bool Apply(const SdfLayerHandle& layer,
74 
75  bool Apply(const UsdStagePtr& stage,
77 
78  size_t GetHash() const;
79 
80  bool operator==(const GusdStageEdit& o) const;
81 
83  { return _variants; }
84 
86  { return _variants; }
87 
88  const std::vector<std::string>& GetLayersToMute() const
89  { return _layersToMute; }
90 
91  std::vector<std::string>& GetLayersToMute()
92  { return _layersToMute; }
93 
94 private:
95  UT_Array<SdfPath> _variants;
96  std::vector<std::string> _layersToMute;
97 };
98 
99 
101 
102 #endif /*_GUSD_STAGEEDIT_H_*/
const UT_Array< SdfPath > & GetVariants() const
Definition: stageEdit.h:82
UT_ErrorSeverity
Definition: UT_Error.h:25
A reference counter base class for use with UT_IntrusivePtr.
const std::vector< std::string > & GetLayersToMute() const
Definition: stageEdit.h:88
bool operator==(const BaseDimensions< T > &a, const BaseDimensions< Y > &b)
Definition: Dimensions.h:137
UT_Array< SdfPath > & GetVariants()
Definition: stageEdit.h:85
Wrapper around hboost::intrusive_ptr.
std::vector< std::string > & GetLayersToMute()
Definition: stageEdit.h:91
Definition: path.h:287
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
GLint GLboolean GLint layer
Definition: glew.h:3601
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
#define GUSD_API
Definition: api.h:40