utils.h
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 PXR_USD_IMAGING_USDVIEWQ_UTILS_H
25 #define PXR_USD_IMAGING_USDVIEWQ_UTILS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usdImaging/usdviewq/api.h"
29 #include "pxr/usd/usd/prim.h"
30 #include "pxr/usd/usd/timeCode.h"
31 
32 #include <vector>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 
37 class UsdStage;
38 
44 public:
45 
46  struct PrimInfo {
47  PrimInfo(const UsdPrim &prim, const UsdTimeCode time);
48 
49  bool hasCompositionArcs;
50  bool isActive;
51  bool isImageable;
52  bool isDefined;
53  bool isAbstract;
54  bool isInPrototype;
55  bool isInstance;
56  bool supportsGuides;
57  bool supportsDrawMode;
58  bool isVisibilityInherited;
59  bool visVaries;
60  std::string name;
61  std::string typeName;
62  std::string displayName;
63  };
64 
67  //
68  // Furthermore, this method is not intended to be used publically,
69  // ultimately Usd will have better core support for fast prim
70  // filtering by typeName.
71  USDVIEWQ_API
72  static
73  std::vector<UsdPrim> _GetAllPrimsOfType(UsdStagePtr const &stage,
74  TfType const& schemaType);
75 
79  USDVIEWQ_API
80  static UsdviewqUtils::PrimInfo GetPrimInfo(const UsdPrim &prim,
81  const UsdTimeCode time);
82 };
83 
84 
85 PXR_NAMESPACE_CLOSE_SCOPE
86 
87 #endif //PXR_USD_IMAGING_USDVIEWQ_UTILS_H
static USDVIEWQ_API std::vector< UsdPrim > _GetAllPrimsOfType(UsdStagePtr const &stage, TfType const &schemaType)
For the given stage and schemaType, return all active, defined prims that either match the schemaType...
The outermost container for scene description, which owns and presents composed prims as a scenegraph...
Definition: stage.h:147
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
static USDVIEWQ_API UsdviewqUtils::PrimInfo GetPrimInfo(const UsdPrim &prim, const UsdTimeCode time)
Fetch prim-related data in batch to to speed up Qt treeview item population.
Performance enhancing utilities for usdview.
Definition: utils.h:43
TfType represents a dynamic runtime type.
Definition: type.h:64