HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.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 PXR_USD_IMAGING_USDVIEWQ_UTILS_H
25 #define PXR_USD_IMAGING_USDVIEWQ_UTILS_H
26 
27 #include "pxr/pxr.h"
29 #include "pxr/usd/usd/prim.h"
30 #include "pxr/usd/usd/timeCode.h"
31 
32 #include <vector>
33 
35 
36 
37 class UsdStage;
38 
39 /// \class UsdviewqUtils
40 ///
41 /// Performance enhancing utilities for usdview.
42 ///
44 public:
45 
46  struct PrimInfo {
47  PrimInfo(const UsdPrim &prim, const UsdTimeCode time);
48 
50  bool isActive;
52  bool isDefined;
53  bool isAbstract;
55  bool isInstance;
59  bool visVaries;
63  };
64 
65  /// For the given \p stage and \p schemaType, return all active, defined
66  /// prims that either match the schemaType exactly or are a descendant type.
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.
72  static
73  std::vector<UsdPrim> _GetAllPrimsOfType(UsdStagePtr const &stage,
74  TfType const& schemaType);
75 
76  /// Fetch prim-related data in batch to to speed up Qt treeview item
77  /// population. Takes a time argument so that we can evaluate the prim's
78  /// visibiity if it is imageable.
80  static UsdviewqUtils::PrimInfo GetPrimInfo(const UsdPrim &prim,
81  const UsdTimeCode time);
82 };
83 
84 
86 
87 #endif //PXR_USD_IMAGING_USDVIEWQ_UTILS_H
std::string name
Definition: utils.h:60
GT_API const UT_StringHolder time
static USDVIEWQ_API UsdviewqUtils::PrimInfo GetPrimInfo(const UsdPrim &prim, const UsdTimeCode time)
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
#define USDVIEWQ_API
Definition: api.h:40
std::string displayName
Definition: utils.h:62
Definition: prim.h:135
PrimInfo(const UsdPrim &prim, const UsdTimeCode time)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
bool isVisibilityInherited
Definition: utils.h:58
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
static USDVIEWQ_API std::vector< UsdPrim > _GetAllPrimsOfType(UsdStagePtr const &stage, TfType const &schemaType)
std::string typeName
Definition: utils.h:61