bboxCache.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_USD_GEOM_BBOX_CACHE_H
25 #define PXR_USD_USD_GEOM_BBOX_CACHE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usdGeom/api.h"
29 #include "pxr/usd/usdGeom/xformCache.h"
31 #include "pxr/usd/usd/attributeQuery.h"
32 #include "pxr/base/gf/bbox3d.h"
33 #include "pxr/base/tf/hashmap.h"
35 
36 #include <boost/optional.hpp>
37 #include <boost/shared_array.hpp>
38 
39 PXR_NAMESPACE_OPEN_SCOPE
40 
41 
42 class UsdGeomModelAPI;
43 
88 {
89 public:
107  USDGEOM_API
108  UsdGeomBBoxCache(UsdTimeCode time, TfTokenVector includedPurposes,
109  bool useExtentsHint=false, bool ignoreVisibility=false);
110 
112  USDGEOM_API
113  UsdGeomBBoxCache(UsdGeomBBoxCache const &other);
114 
116  USDGEOM_API
118 
128  USDGEOM_API
129  GfBBox3d ComputeWorldBound(const UsdPrim& prim);
130 
138  USDGEOM_API
140  const UsdPrim &relativeToAncestorPrim);
141 
150  USDGEOM_API
151  GfBBox3d ComputeLocalBound(const UsdPrim& prim);
152 
163  USDGEOM_API
165 
182  USDGEOM_API
184  const UsdPrim &prim,
185  const SdfPathSet &pathsToSkip,
186  const TfHashMap<SdfPath, GfMatrix4d, SdfPath::Hash> &ctmOverrides);
187 
193  USDGEOM_API
194  bool
196  const UsdGeomPointInstancer& instancer,
197  int64_t const *instanceIdBegin,
198  size_t numIds,
199  GfBBox3d *result);
200 
203  GfBBox3d
205  const UsdGeomPointInstancer& instancer, int64_t instanceId) {
206  GfBBox3d ret;
207  ComputePointInstanceWorldBounds(instancer, &instanceId, 1, &ret);
208  return ret;
209  }
210 
221  USDGEOM_API
222  bool
224  const UsdGeomPointInstancer &instancer,
225  int64_t const *instanceIdBegin,
226  size_t numIds,
227  const UsdPrim &relativeToAncestorPrim,
228  GfBBox3d *result);
229 
232  GfBBox3d
234  const UsdGeomPointInstancer &instancer,
235  int64_t instanceId,
236  const UsdPrim &relativeToAncestorPrim) {
237  GfBBox3d ret;
239  instancer, &instanceId, 1, relativeToAncestorPrim, &ret);
240  return ret;
241  }
242 
251  USDGEOM_API
252  bool
254  const UsdGeomPointInstancer& instancer,
255  int64_t const *instanceIdBegin,
256  size_t numIds,
257  GfBBox3d *result);
258 
260  GfBBox3d
262  const UsdGeomPointInstancer& instancer,
263  int64_t instanceId) {
264  GfBBox3d ret;
265  ComputePointInstanceLocalBounds(instancer, &instanceId, 1, &ret);
266  return ret;
267  }
268 
269 
280  USDGEOM_API
281  bool
283  const UsdGeomPointInstancer& instancer,
284  int64_t const *instanceIdBegin,
285  size_t numIds,
286  GfBBox3d *result);
287 
290  GfBBox3d
292  const UsdGeomPointInstancer& instancer,
293  int64_t instanceId) {
294  GfBBox3d ret;
296  instancer, &instanceId, 1, &ret);
297  return ret;
298  }
299 
301  USDGEOM_API
302  void Clear();
303 
312  USDGEOM_API
313  void SetIncludedPurposes(const TfTokenVector& includedPurposes);
314 
316  const TfTokenVector& GetIncludedPurposes() { return _includedPurposes; }
317 
320  bool GetUseExtentsHint() const {
321  return _useExtentsHint;
322  }
323 
326  bool GetIgnoreVisibility() const {
327  return _ignoreVisibility;
328  }
329 
333  USDGEOM_API
334  void SetTime(UsdTimeCode time);
335 
337  UsdTimeCode GetTime() const { return _time; }
338 
347  void SetBaseTime(UsdTimeCode baseTime) {
348  _baseTime = baseTime;
349  }
350 
354  return _baseTime.get_value_or(GetTime());
355  }
356 
359  void ClearBaseTime() {
360  _baseTime = boost::none;
361  }
362 
365  bool HasBaseTime() const {
366  return static_cast<bool>(_baseTime);
367  }
368 
369 private:
370  // Worker task.
371  class _BBoxTask;
372 
373  // Helper object for computing bounding boxes for instance prototypes.
374  class _PrototypeBBoxResolver;
375 
376  // Map of purpose tokens to associated bboxes.
377  typedef std::map<TfToken, GfBBox3d, TfTokenFastArbitraryLessThan>
378  _PurposeToBBoxMap;
379 
380  // Each individual prim will have it's own entry in the bbox cache. When
381  // instancing is involved we store the prototype prims and their children in
382  // the cache for use by each prim that instances each prototype. However,
383  // because of the way we compute and inherit purpose, we may end up needed
384  // to compute multitple different bboxes for prototypes and their children
385  // if the prims that instance them would cause these prototypes to inherit a
386  // different purpose value when the prims under the prototype don't have an
387  // authored purpose of their own.
388  //
389  // This struct is here to represent a prim and the purpose that it would
390  // inherit from the prim that instances it. It is used as the key for the
391  // map of prim's to the cached entries, allowing prims in prototypes to have
392  // more than one bbox cache entry for each distinct context needed to
393  // appropriately compute for all instances. instanceInheritablePurpose will
394  // always be empty for prims that aren't prototypes or children of
395  // prototypes, meaning that prims not in prototypes will only have one
396  // context each.
397  struct _PrimContext {
398  // The prim itself
399  UsdPrim prim;
400 
401  // The purpose that would be inherited from the instancing prim if this
402  // prim does not have an explicit purpose.
403  TfToken instanceInheritablePurpose;
404 
405  _PrimContext() = default;
406  explicit _PrimContext(const UsdPrim &prim_,
407  const TfToken &purpose = TfToken())
408  : prim(prim_), instanceInheritablePurpose(purpose) {};
409 
410  bool operator==(const _PrimContext &rhs) const {
411  return prim == rhs.prim &&
412  instanceInheritablePurpose == rhs.instanceInheritablePurpose;
413  }
414 
415  // Convenience stringify for debugging.
416  std::string ToString() const;
417  };
418 
419  bool
420  _ComputePointInstanceBoundsHelper(
421  const UsdGeomPointInstancer &instancer,
422  int64_t const *instanceIdBegin,
423  size_t numIds,
424  GfMatrix4d const &xform,
425  GfBBox3d *result);
426 
427  // Returns true if the \p prim should be included during child bounds
428  // accumulation.
429  bool _ShouldIncludePrim(const UsdPrim& prim);
430 
431  // True if \p attr or \p query may return different values given different
432  // time queries. Note that a true result implies the attribute may have no
433  // value, a default value or a single time sample value.
434  bool _IsVarying(const UsdAttribute& attr);
435  bool _IsVarying(const UsdAttributeQuery& query);
436 
437  // Populate the local bbox for the requested prim, without the
438  // local-to-world transform or local transform applied. Return true when
439  // bbox volume > 0.
440  bool _Resolve(const UsdPrim& prim, _PurposeToBBoxMap *bboxes);
441 
442  // Compute the extent of a UsdGeomBoundable object. Return true if the
443  // computation succeeds and false on failure.
444  bool _ComputeExtent(
445  const UsdGeomBoundable& boundableObj,
446  VtVec3fArray* extent) const;
447 
448  // Resolves a single prim. This method must be thread safe. Assumes the
449  // cache entry has been created for \p prim.
450  //
451  // \p inverseComponentCtm is used to combine all the child bboxes in
452  // component-relative space.
453  void _ResolvePrim(_BBoxTask* task,
454  const _PrimContext& prim,
455  const GfMatrix4d &inverseComponentCtm);
456 
457  struct _Entry {
458  _Entry()
459  : isComplete(false)
460  , isVarying(false)
461  , isIncluded(false)
462  { }
463 
464  // The cached bboxes for the various values of purpose token.
465  _PurposeToBBoxMap bboxes;
466 
467  // True when data in the entry is valid.
468  bool isComplete;
469 
470  // True when the entry varies over time.
471  bool isVarying;
472 
473  // True when the entry is visible.
474  bool isIncluded;
475 
476  // Computed purpose info of the prim that's associated with the entry.
477  // This data includes the prim's actual computed purpose as well as
478  // whether this purpose is inheritable by child prims.
479  UsdGeomImageable::PurposeInfo purposeInfo;
480 
481  // Queries for attributes that need to be re-computed at each
482  // time for this entry. This will be invalid for non-varying entries.
483  boost::shared_array<UsdAttributeQuery> queries;
484  };
485 
486  // Returns the cache entry for the given \p prim if one already exists.
487  // If no entry exists, creates (but does not resolve) entries for
488  // \p prim and all of its descendents. In this case, the prototype prims
489  // whose bounding boxes need to be resolved in order to resolve \p prim
490  // will be returned in \p prototypePrimContexts.
491  _Entry* _FindOrCreateEntriesForPrim(
492  const _PrimContext& prim,
493  std::vector<_PrimContext> *prototypePrimContexts);
494 
495  // Returns the combined bounding box for the currently included set of
496  // purposes given a _PurposeToBBoxMap.
497  GfBBox3d _GetCombinedBBoxForIncludedPurposes(
498  const _PurposeToBBoxMap &bboxes);
499 
500  // Populates \p bbox with the bounding box computed from the authored
501  // extents hint. Based on the included purposes, the extents in the
502  // extentsHint attribute are combined together to compute the bounding box.
503  bool _GetBBoxFromExtentsHint(
504  const UsdGeomModelAPI &geomModel,
505  const UsdAttributeQuery &extentsHintQuery,
506  _PurposeToBBoxMap *bboxes);
507 
508  // Returns whether the children of the given prim can be pruned
509  // from the traversal to pre-populate entries.
510  bool _ShouldPruneChildren(const UsdPrim &prim, _Entry *entry);
511 
512  // Helper function for computing a prim's purpose info efficiently by
513  // using the parent entry's cached computed purpose info and caching it
514  // its cache entry.
515  // Optionally this can recursively compute and cache the purposes for any
516  // existing parent entries in the cache that haven't had their purposes
517  // computed yet.
518  template <bool IsRecursive>
519  void _ComputePurposeInfo(_Entry *entry, const _PrimContext &prim);
520 
521  // Helper to determine if we should use extents hints for \p prim.
522  inline bool _UseExtentsHintForPrim(UsdPrim const &prim) const;
523 
524  // Need hash_value for boost to key cache entries by prim context.
525  friend size_t hash_value(const _PrimContext &key);
526 
527  typedef boost::hash<_PrimContext> _PrimContextHash;
528  typedef TfHashMap<_PrimContext, _Entry, _PrimContextHash> _PrimBBoxHashMap;
529 
530  // Finds the cache entry for the prim context if it exists.
531  _Entry *_FindEntry(const _PrimContext &primContext)
532  {
533  return TfMapLookupPtr(_bboxCache, primContext);
534  }
535 
536  // Returns the cache entry for the prim context, adding it if doesn't
537  // exist.
538  _Entry *_InsertEntry(const _PrimContext &primContext)
539  {
540  return &(_bboxCache[primContext]);
541  }
542 
543  WorkDispatcher _dispatcher;
544  UsdTimeCode _time;
545  boost::optional<UsdTimeCode> _baseTime;
546  TfTokenVector _includedPurposes;
547  UsdGeomXformCache _ctmCache;
548  _PrimBBoxHashMap _bboxCache;
549  bool _useExtentsHint;
550  bool _ignoreVisibility;
551 };
552 
553 
554 PXR_NAMESPACE_CLOSE_SCOPE
555 
556 #endif // PXR_USD_USD_GEOM_BBOX_CACHE_H
USDGEOM_API UsdGeomBBoxCache & operator=(UsdGeomBBoxCache const &other)
Copy assignment.
bool GetIgnoreVisibility() const
Returns whether prim visibility should be ignored when computing bounding boxes.
Definition: bboxCache.h:326
UsdGeomModelAPI extends the generic UsdModelAPI schema with geometry specific concepts such as cached...
Definition: modelAPI.h:148
A work dispatcher runs concurrent tasks.
Definition: dispatcher.h:71
USDGEOM_API bool ComputePointInstanceLocalBounds(const UsdGeomPointInstancer &instancer, int64_t const *instanceIdBegin, size_t numIds, GfBBox3d *result)
Compute the oriented bounding boxes of the given point instances.
Object for efficiently making repeated queries for attribute values.
const TfTokenVector & GetIncludedPurposes()
Get the current set of included purposes.
Definition: bboxCache.h:316
bool GetUseExtentsHint() const
Returns whether authored extent hints are used to compute bounding boxes.
Definition: bboxCache.h:320
void ClearBaseTime()
Clear this cache's baseTime if one has been set.
Definition: bboxCache.h:359
Caches bounds by recursively computing and aggregating bounds of children in world space and aggregat...
Definition: bboxCache.h:87
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdTimeCode GetBaseTime() const
Return the base time if set, otherwise GetTime().
Definition: bboxCache.h:353
USDGEOM_API void Clear()
Clears all pre-cached values.
GfBBox3d ComputePointInstanceRelativeBound(const UsdGeomPointInstancer &instancer, int64_t instanceId, const UsdPrim &relativeToAncestorPrim)
Compute the bound of the given point instance in the space of an ancestor prim relativeToAncestorPrim...
Definition: bboxCache.h:233
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
void SetBaseTime(UsdTimeCode baseTime)
Set the base time value for this bbox cache.
Definition: bboxCache.h:347
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
USDGEOM_API bool ComputePointInstanceUntransformedBounds(const UsdGeomPointInstancer &instancer, int64_t const *instanceIdBegin, size_t numIds, GfBBox3d *result)
Computes the bound of the given point instances, but does not include the transform (if any) authored...
Value type containing information about a prim's computed effective purpose as well as storing whethe...
Definition: imageable.h:427
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:82
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
USDGEOM_API GfBBox3d ComputeWorldBound(const UsdPrim &prim)
Compute the bound of the given prim in world space, leveraging any pre-existing, cached bounds.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDGEOM_API bool ComputePointInstanceWorldBounds(const UsdGeomPointInstancer &instancer, int64_t const *instanceIdBegin, size_t numIds, GfBBox3d *result)
Compute the bound of the given point instances in world space.
GfBBox3d ComputePointInstanceUntransformedBound(const UsdGeomPointInstancer &instancer, int64_t instanceId)
Computes the bound of the given point instances, but does not include the instancer's transform.
Definition: bboxCache.h:291
UsdTimeCode GetTime() const
Get the current time from which this cache is reading values.
Definition: bboxCache.h:337
USDGEOM_API GfBBox3d ComputeRelativeBound(const UsdPrim &prim, const UsdPrim &relativeToAncestorPrim)
Compute the bound of the given prim in the space of an ancestor prim, relativeToAncestorPrim,...
Container::mapped_type * TfMapLookupPtr(Container &map, Key const &key)
Checks if an item exists in a map or TfHashMap, without copying it.
Definition: stl.h:143
USDGEOM_API bool ComputePointInstanceRelativeBounds(const UsdGeomPointInstancer &instancer, int64_t const *instanceIdBegin, size_t numIds, const UsdPrim &relativeToAncestorPrim, GfBBox3d *result)
Compute the bounds of the given point instances in the space of an ancestor prim relativeToAncestorPr...
USDGEOM_API GfBBox3d ComputeLocalBound(const UsdPrim &prim)
Computes the oriented bounding box of the given prim, leveraging any pre-existing,...
USDGEOM_API UsdGeomBBoxCache(UsdTimeCode time, TfTokenVector includedPurposes, bool useExtentsHint=false, bool ignoreVisibility=false)
Construct a new BBoxCache for a specific time and set of includedPurposes.
GfBBox3d ComputePointInstanceLocalBound(const UsdGeomPointInstancer &instancer, int64_t instanceId)
Compute the oriented bounding boxes of the given point instances.
Definition: bboxCache.h:261
GfBBox3d ComputePointInstanceWorldBound(const UsdGeomPointInstancer &instancer, int64_t instanceId)
Compute the bound of the given point instance in world space.
Definition: bboxCache.h:204
Encodes vectorized instancing of multiple, potentially animated, prototypes (object/instance masters)...
VT_API bool operator==(VtDictionary const &, VtDictionary const &)
Equality comparison.
USDGEOM_API void SetTime(UsdTimeCode time)
Use the new time when computing values and may clear any existing values cached for the previous time...
USDGEOM_API GfBBox3d ComputeUntransformedBound(const UsdPrim &prim)
Computes the bound of the prim's children leveraging any pre-existing, cached bounds,...
USDGEOM_API void SetIncludedPurposes(const TfTokenVector &includedPurposes)
Indicate the set of includedPurposes to use when resolving child bounds.
Basic type: arbitrarily oriented 3D bounding box.
Definition: bbox3d.h:84
A caching mechanism for transform matrices.
Definition: xformCache.h:58
bool HasBaseTime() const
Return true if this cache has a baseTime that's been explicitly set, false otherwise.
Definition: bboxCache.h:365