HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
stageOpts.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_STAGEOPTS_H_
25 #define _GUSD_STAGEOPTS_H_
26 
27 #include <SYS/SYS_Hash.h>
28 
29 #include "gusd/api.h"
30 
31 #include "pxr/pxr.h"
32 #include "pxr/usd/usd/stage.h"
33 
34 
36 
37 
38 /// Options for configuring creation of a new stage.
39 /// This currently just includes the initial load set,
40 /// but may include other options in the future.
42 {
43 public:
45 
46  GusdStageOpts(const GusdStageOpts& o) = default;
47 
49  : _loadSet(loadSet) {}
50 
51  /// Return options that a configure a stage to be loaded with payloads.
53  { return GusdStageOpts(UsdStage::LoadAll); }
54 
55  /// Return options that a configure a stage to be loaded without payloads.
58 
60  { return _loadSet; }
61 
62  void SetLoadSet(InitialLoadSet loadSet)
63  { _loadSet = loadSet; }
64 
65  size_t GetHash() const
66  { return SYShash(_loadSet); }
67 
68  bool operator==(const GusdStageOpts& o) const
69  { return _loadSet == o._loadSet; }
70 
71 private:
72  InitialLoadSet _loadSet;
73 };
74 
75 
77 
78 
79 #endif /*_GUSD_STAGEOPTS_H_*/
size_t GetHash() const
Definition: stageOpts.h:65
void SetLoadSet(InitialLoadSet loadSet)
Definition: stageOpts.h:62
InitialLoadSet
Definition: stage.h:155
static GusdStageOpts LoadAll()
Return options that a configure a stage to be loaded with payloads.
Definition: stageOpts.h:52
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
Load all loadable prims.
Definition: stage.h:157
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
InitialLoadSet GetLoadSet() const
Definition: stageOpts.h:59
#define GUSD_API
Definition: api.h:40
bool operator==(const GusdStageOpts &o) const
Definition: stageOpts.h:68
GusdStageOpts(InitialLoadSet loadSet=UsdStage::LoadAll)
Definition: stageOpts.h:48
static GusdStageOpts LoadNone()
Return options that a configure a stage to be loaded without payloads.
Definition: stageOpts.h:56
Load no loadable prims.
Definition: stage.h:158