7#ifndef PXR_USD_USD_GEOM_BBOX_CACHE_H
8#define PXR_USD_USD_GEOM_BBOX_CACHE_H
11#include "pxr/usd/usdGeom/api.h"
12#include "pxr/usd/usdGeom/xformCache.h"
14#include "pxr/usd/usd/attributeQuery.h"
17#include "pxr/base/tf/hashmap.h"
22PXR_NAMESPACE_OPEN_SCOPE
92 bool useExtentsHint=
false,
bool ignoreVisibility=
false);
128 const SdfPathSet &pathsToSkip,
130 const TfHashMap<SdfPath, GfMatrix4d, SdfPath::Hash> &ctmOverrides);
142 const UsdPrim &relativeToAncestorPrim);
187 const SdfPathSet &pathsToSkip,
188 const TfHashMap<SdfPath, GfMatrix4d, SdfPath::Hash> &ctmOverrides);
199 int64_t
const *instanceIdBegin,
227 int64_t
const *instanceIdBegin,
229 const UsdPrim &relativeToAncestorPrim,
238 const UsdPrim &relativeToAncestorPrim) {
241 instancer, &instanceId, 1, relativeToAncestorPrim, &ret);
257 int64_t
const *instanceIdBegin,
265 int64_t instanceId) {
286 int64_t
const *instanceIdBegin,
295 int64_t instanceId) {
298 instancer, &instanceId, 1, &ret);
323 return _useExtentsHint;
329 return _ignoreVisibility;
350 _baseTime = baseTime;
356 return _baseTime.value_or(
GetTime());
362 _baseTime = std::nullopt;
368 return static_cast<bool>(_baseTime);
376 class _PrototypeBBoxResolver;
379 typedef std::map<TfToken, GfBBox3d, TfTokenFastArbitraryLessThan>
399 struct _PrimContext {
405 TfToken instanceInheritablePurpose;
407 _PrimContext() =
default;
408 explicit _PrimContext(
const UsdPrim &prim_,
410 : prim(prim_), instanceInheritablePurpose(purpose) {};
412 bool operator==(
const _PrimContext &rhs)
const {
413 return prim == rhs.prim &&
414 instanceInheritablePurpose == rhs.instanceInheritablePurpose;
418 std::string ToString()
const;
421 template<
typename TransformType>
422 GfBBox3d _ComputeBoundWithOverridesHelper(
424 const SdfPathSet &pathsToSkip,
425 const TransformType &primOverride,
426 const TfHashMap<SdfPath, GfMatrix4d, SdfPath::Hash> &ctmOverrides);
429 _ComputePointInstanceBoundsHelper(
431 int64_t
const *instanceIdBegin,
438 bool _ShouldIncludePrim(
const UsdPrim& prim);
449 bool _Resolve(
const UsdPrim& prim, _PurposeToBBoxMap *bboxes);
456 void _ResolvePrim(
const _BBoxTask* task,
457 const _PrimContext& prim,
468 _PurposeToBBoxMap bboxes;
472 std::shared_ptr<UsdAttributeQuery[]> queries;
494 _Entry* _FindOrCreateEntriesForPrim(
495 const _PrimContext& prim,
496 std::vector<_PrimContext> *prototypePrimContexts);
500 GfBBox3d _GetCombinedBBoxForIncludedPurposes(
501 const _PurposeToBBoxMap &bboxes);
506 bool _GetBBoxFromExtentsHint(
509 _PurposeToBBoxMap *bboxes);
513 bool _ShouldPruneChildren(
const UsdPrim &prim, _Entry *entry);
521 template <
bool IsRecursive>
522 void _ComputePurposeInfo(_Entry *entry,
const _PrimContext &prim);
525 inline bool _UseExtentsHintForPrim(
UsdPrim const &prim)
const;
528 template <
typename HashState>
529 friend void TfHashAppend(HashState& h,
const _PrimContext &key)
532 h.Append(key.instanceInheritablePurpose);
536 friend size_t hash_value(
const _PrimContext &key) {
return TfHash{}(key); }
538 typedef TfHash _PrimContextHash;
539 typedef TfHashMap<_PrimContext, _Entry, _PrimContextHash> _PrimBBoxHashMap;
542 _Entry *_FindEntry(
const _PrimContext &primContext)
549 _Entry *_InsertEntry(
const _PrimContext &primContext)
551 return &(_bboxCache[primContext]);
556 std::optional<UsdTimeCode> _baseTime;
559 _PrimBBoxHashMap _bboxCache;
560 bool _useExtentsHint;
561 bool _ignoreVisibility;
565PXR_NAMESPACE_CLOSE_SCOPE
Basic type: arbitrarily oriented 3D bounding box.
Stores a 4x4 matrix of double elements.
A user-extensible hashing mechanism for use with runtime hash tables.
Token for efficient comparison, assignment, and hashing of known strings.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Object for efficiently making repeated queries for attribute values.
Caches bounds by recursively computing and aggregating bounds of children in world space and aggregat...
GfBBox3d ComputePointInstanceWorldBound(const UsdGeomPointInstancer &instancer, int64_t instanceId)
Compute the bound of the given point instance in world space.
bool GetUseExtentsHint() const
Returns whether authored extent hints are used to compute bounding boxes.
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 void SetIncludedPurposes(const TfTokenVector &includedPurposes)
Indicate the set of includedPurposes to use when resolving child bounds.
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.
UsdTimeCode GetBaseTime() const
Return the base time if set, otherwise GetTime().
USDGEOM_API UsdGeomBBoxCache & operator=(UsdGeomBBoxCache const &other)
Copy assignment.
UsdTimeCode GetTime() const
Get the current time from which this cache is reading values.
bool GetIgnoreVisibility() const
Returns whether prim visibility should be ignored when computing bounding boxes.
bool HasBaseTime() const
Return true if this cache has a baseTime that's been explicitly set, false otherwise.
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...
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...
GfBBox3d ComputePointInstanceUntransformedBound(const UsdGeomPointInstancer &instancer, int64_t instanceId)
Computes the bound of the given point instances, but does not include the instancer's transform.
void ClearBaseTime()
Clear this cache's baseTime if one has been set.
void SetBaseTime(UsdTimeCode baseTime)
Set the base time value for this bbox cache.
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 void Clear()
Clears all pre-cached values.
USDGEOM_API GfBBox3d ComputeWorldBound(const UsdPrim &prim)
Compute the bound of the given prim in world space, leveraging any pre-existing, cached bounds.
USDGEOM_API GfBBox3d ComputeUntransformedBound(const UsdPrim &prim, const SdfPathSet &pathsToSkip, const TfHashMap< SdfPath, GfMatrix4d, SdfPath::Hash > &ctmOverrides)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USDGEOM_API GfBBox3d ComputeWorldBoundWithOverrides(const UsdPrim &prim, const SdfPathSet &pathsToSkip, const GfMatrix4d &primOverride, const TfHashMap< SdfPath, GfMatrix4d, SdfPath::Hash > &ctmOverrides)
Computes the bound of the prim's descendents in world space while excluding the subtrees rooted at th...
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,...
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.
const TfTokenVector & GetIncludedPurposes()
Get the current set of included purposes.
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.
USDGEOM_API GfBBox3d ComputeUntransformedBound(const UsdPrim &prim)
Computes the bound of the prim's children leveraging any pre-existing, cached bounds,...
USDGEOM_API GfBBox3d ComputeLocalBound(const UsdPrim &prim)
Computes the oriented bounding box of the given prim, leveraging any pre-existing,...
GfBBox3d ComputePointInstanceLocalBound(const UsdGeomPointInstancer &instancer, int64_t instanceId)
Compute the oriented bounding boxes of the given point instances.
USDGEOM_API UsdGeomBBoxCache(UsdGeomBBoxCache const &other)
Copy constructor.
UsdGeomModelAPI extends the generic UsdModelAPI schema with geometry specific concepts such as cached...
Encodes vectorized instancing of multiple, potentially animated, prototypes (object/instance masters)...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
A work dispatcher runs concurrent tasks.
Container::mapped_type * TfMapLookupPtr(Container &map, Key const &key)
Checks if an item exists in a map or TfHashMap, without copying it.
Value type containing information about a prim's computed effective purpose as well as storing whethe...
std::vector< TfToken > TfTokenVector
Convenience types.