HDK
|
#include <instanceAdapter.h>
Public Types | |
using | BaseAdapter = UsdImagingPrimAdapter |
Public Types inherited from UsdImagingPrimAdapter | |
enum | PopulationMode { RepresentsSelf, RepresentsSelfAndDescendents, RepresentedByAncestor } |
Volume field information | |
virtual HdVolumeFieldDescriptorVector | GetVolumeFieldDescriptors (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) const override |
virtual void | _RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index) overridefinal |
Provides to paramName->UsdAttribute value mappings. More... | |
Delegate support for instanced prims.
In addition to prim schemas that support instancing, like the point instancer, USD has a built in instancing feature that will allow prims composed from the same assets, with compatible attributes, to be de-duplicated inside of USD.
When these prims are found during scene load, the prim location is marked as an instance (meaning prim.IsInstance() == true), and its descendants are added to a new hidden scene root. There can be multiple prototype scene roots, and each one can be pointed to by many instance prims, and these prototype sub-scenes can themselves contain instances.
We handle this by sending all instance prims to the instance adapter. In order to preserve USD's native instancing work during rendering, for each prototype scene root, we insert one hydra gprim per prototype USD gprim, and we insert a hydra instancer that computes all of the places these gprims (and any child instancers) are referenced in the scene, adjusting the instancing count accordingly.
The instance adapter is responsible for computing and passing down a small amount of inheritable data that we allow to vary per-instance: for example, transform and visibility state, and inherited constant primvars. Otherwise, prototypes have no knowledge of the instance prims that refer to them.
Just like the scene root, the root of the prototype tree isn't allowed to have attributes or a prim type; those are set on the instance prim instead. This means if a gprim is directly instanced, USD won't actually de-duplicate it. The instance adapter could theoretically bucket such gprims together, but the difficulty of doing so is the same as the difficulty of deduplicating arbitrary prims in the scene. Instead, the instance adapter refuses to image directly-instanced gprims, and the recommended authoring guidelines is to only enable USD instancing on enclosing scopes or xforms.
There's a small set of extremely-special-case prims that are allowed to be directly instanced, including cards and support prims that designate e.g. skinning buffers. These prim adapters opt-in via CanPopulateUsdInstance, and generally require very careful coding and support in the instance adapter; but they are useful for restricted schemas where we know how to vary the data per-instance or know how to efficiently aggregate instances.
Finally, there's a small (hopefully shrinking) set of inherited attributes that we need to respect, but don't know how to vary per-instance; for example, material bindings. If two instances point to the same USD proto root, but have different material bindings, we currently populate two hydra instancers with two sets of hydra prototypes. This cuts into the efficiency of instancing, so we try to minimize it.
Definition at line 91 of file instanceAdapter.h.
Definition at line 94 of file instanceAdapter.h.
UsdImagingInstanceAdapter::UsdImagingInstanceAdapter | ( | ) |
|
virtual |
|
finaloverrideprotectedvirtual |
Provides to paramName->UsdAttribute value mappings.
Implements UsdImagingPrimAdapter.
|
overridevirtual |
Gets the value of the parameter named key for the given prim (which has the given cache path) and given time. If outIndices is not nullptr and the value has indices, it will return the unflattened value and set outIndices to the value's associated indices.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Gets the cullstyle of a specific path in the scene graph.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reads double-sided from the given prim. If not authored, returns false.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reads the extent from the given prim. If the extent is not authored, an empty GfRange3d is returned, the extent will not be computed.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Return an array of the categories used by each instance.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Return the instancerId for this prim.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Return the list of known prototypes of this prim.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Get the instancer transform for the given prim.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
The root transform provided by the delegate.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
The root transform provided by the delegate.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns the purpose token for prim
. If a non-empty instanceInheritablePurpose
is specified and the prim doesn't have an explicitly authored or inherited purpose, it may inherit the instancer's purpose if the instance has an explicit purpose.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns the transform of protoInstancerPath
relative to instancerPath
. instancerPath
must be managed by this adapter.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Get the subdiv tags for this prim.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Gets the topology object of a specific Usd prim. If the adapter is a mesh it will return an HdMeshTopology, if it is of type basis curves, it will return an HdBasisCurvesTopology. If the adapter does not have a topology, it returns an empty VtValue.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Fetches the transform for the given prim at the given time from a pre-computed cache of prim transforms. Requesting transforms at incoherent times is currently inefficient.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns true if the given prim is visible, taking into account inherited visibility values. Inherited values are strongest, Usd has no notion of "super vis/invis".
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Called to populate the RenderIndex for this UsdPrim. The adapter is expected to create one or more prims in the render index using the given proxy.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Implements UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
changedFields
contains a list of changed scene description fields for this prim. This may be empty in certain cases, like the addition of an inert prim spec for the given prim
.
The default implementation returns HdChangeTracker::AllDirty if any of the changed fields are plugin metadata fields, HdChangeTracker::Clean otherwise.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Called to populate the RenderIndex for this UsdPrim. The adapter is expected to create one or more prims in the render index using the given proxy.
Implements UsdImagingPrimAdapter.
|
overridevirtual |
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Removes all associated Rprims and dependencies from the render index without scheduling them for repopulation.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
When a PrimResync event occurs, the prim may have been deleted entirely, adapter plug-ins should override this method to free any per-prim state that was accumulated in the adapter.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.
Implements UsdImagingPrimAdapter.
|
overridevirtual |
Sample the instancer transform for the given prim.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Sample the primvar for the given prim. If *sampleIndices is not nullptr and the primvar has indices, it will sample the unflattened primvar and set *sampleIndices to the primvar's sampled indices.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Samples the transform for the given prim.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
Called to populate the RenderIndex for this UsdPrim. The adapter is expected to create one or more prims in the render index using the given proxy.
Reimplemented from UsdImagingPrimAdapter.
|
overridevirtual |
For the given prim
, variability is detected and stored in timeVaryingBits
. Initial values are cached into the value cache.
This method is expected to be called from multiple threads.
Implements UsdImagingPrimAdapter.
|
overridevirtual |
Populates the cache
for the given prim
, time
and requestedBits
.
This method is expected to be called from multiple threads.
Implements UsdImagingPrimAdapter.