All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
USD_TraverseSimple.h
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_USD_TRAVERSESIMPLE_H_
25 #define _GUSD_USD_TRAVERSESIMPLE_H_
26 
27 #include "pxr/pxr.h"
28 
29 #include "gusd/defaultArray.h"
30 #include "gusd/USD_Traverse.h"
31 #include "gusd/USD_ThreadedTraverse.h"
32 
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
39 template <class Visitor>
41 {
42 public:
43  GusdUSD_TraverseSimpleT(const Visitor& visitor)
44  : GusdUSD_Traverse(), _visitor(visitor) {}
45 
46  virtual ~GusdUSD_TraverseSimpleT() {}
47 
48  virtual bool FindPrims(const UsdPrim& root,
49  UsdTimeCode time,
50  GusdPurposeSet purposes,
51  UT_Array<UsdPrim>& prims,
52  bool skipRoot=true,
53  const Opts* opts=NULL) const;
54 
55  virtual bool FindPrims(const UT_Array<UsdPrim>& roots,
56  const GusdDefaultArray<UsdTimeCode>& times,
57  const GusdDefaultArray<GusdPurposeSet>& purposes,
58  UT_Array<PrimIndexPair>& prims,
59  bool skipRoot=true,
60  const Opts* opts=NULL) const;
61 
62 private:
63  const Visitor& _visitor;
64 };
65 
66 
67 template <class Visitor>
68 bool
70  UsdTimeCode time,
71  GusdPurposeSet purposes,
72  UT_Array<UsdPrim>& prims,
73  bool skipRoot,
74  const Opts* opts) const
75 {
76  return GusdUSD_ThreadedTraverse::ParallelFindPrims(
77  root, time, purposes, prims, _visitor, skipRoot);
78 }
79 
80 
81 template <class Visitor>
82 bool
84  const UT_Array<UsdPrim>& roots,
85  const GusdDefaultArray<UsdTimeCode>& times,
86  const GusdDefaultArray<GusdPurposeSet>& purposes,
87  UT_Array<PrimIndexPair>& prims,
88  bool skipRoot,
89  const Opts* opts) const
90 {
91  return GusdUSD_ThreadedTraverse::ParallelFindPrims(
92  roots, times, purposes, prims, _visitor, skipRoot);
93 }
94 
95 PXR_NAMESPACE_CLOSE_SCOPE
96 
97 #endif /*_GUSD_USD_TRAVERSESIMPLE_H_*/
virtual bool FindPrims(const UsdPrim &root, UsdTimeCode time, GusdPurposeSet purposes, UT_Array< UsdPrim > &prims, bool skipRoot=true, const Opts *opts=NULL) const
Find prims beneath the given root.
Base class for custom stage traversal.
Definition: USD_Traverse.h:57
Base class that can be derived to provide configuration options to the traversal. ...
Definition: USD_Traverse.h:96
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
Methods for USD scene traversal.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a &quot;Prim&quot; as ...
Definition: prim.h:131
Templated class for declaring simple, threaded traversals.