HDK
|
#include <niPrototypePropagatingSceneIndex.h>
Static Public Member Functions | |
static USDIMAGING_API UsdImagingNiPrototypePropagatingSceneIndexRefPtr | New (HdSceneIndexBaseRefPtr const &inputSceneIndex) |
Static Public Member Functions inherited from TfRefBase | |
static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
Friends | |
class | _InstanceAggregationSceneIndexObserver |
class | _MergingSceneIndexObserver |
Additional Inherited Members | |
Public Types inherited from TfRefBase | |
typedef void(* | UniqueChangedFuncPtr )(TfRefBase const *, bool) |
Protected Member Functions inherited from HdSceneIndexBase | |
HD_API void | _SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries) |
HD_API void | _SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries) |
HD_API void | _SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries) |
HD_API void | _SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries) |
HD_API bool | _IsObserved () const |
Protected Member Functions inherited from TfRefBase | |
virtual TF_API | ~TfRefBase () |
Protected Member Functions inherited from TfWeakBase | |
~TfWeakBase () | |
TfRefPtr< Tf_Remnant > | _Register () const |
template<class T > | |
TfRefPtr< Tf_Remnant > | _Register (T *tempRmnt) const |
bool | _HasRemnant () const |
A scene index implementing USD native instancing. If combined with the UsdImagingPiPrototypePropagatingSceneIndex, the native instancing scene index has to be run after the point instancing scene index.
This scene index uses the UsdImgingNiInstanceAggregationSceneIndex to find all instances, aggregate them and insert instancers for each set of aggregated instances. This scene index then inserts copies of the corresponding USD prototype underneath each of these instancers. Each of these copies is actually a UsdImagingNiPrototypePropagatingSceneIndex itself. This way, we can handle nested native instancing. In other words, we can call the UsdImagingNiPrototypePropagatingSceneIndex for a USD prototype and it will find the instances within that prototype.
The instancing scene index uses the instancedBy:prototypeRoot of the input scene index during aggregation. Typically, the input scene index will be a UsdImagingPiPrototypePropagatingSceneIndex which populates instancedBy:prototypeRoot based on which point instancer is instancing a prim.
This scene index is implemented by a merging scene index. One input to the merging scene index is the UsdImaging_NiPrototypeSceneIndex which prepares the prototype for which this scene index was created. Another input to the merging scene index is the UsdImaging_NiInstanceAggregationSceneIndex that will insert the instancers for the instances within this prototype. The _InstanceAggregationSceneIndexObserver will observe the latter scene index to add respective UsdImagingNiPrototypePropagatingSceneIndex's under each instancer.
Example 1 (also see Example 1 in niInstanceAggregationSceneIndex.h)
USD:
def Xform "MyPrototype" { def Cube "MyCube" { } }
def "Cube_1" ( instanceable = true references = </MyPrototype> { }
Inputs of the UsdImagingNiPrototypePropagatingSceneIndex(inputSceneIndex):
* HdMergingSceneIndex * UsdImaging_NiPrototypeSceneIndex forPrototype = false * UsdImaging_NiPrototypePruningSceneIndex forPrototype = false * inputSceneIndex (typically a UsdImagingPiPrototypePropagatingSceneIndex) * UsdImaging_NiInstanceAggregationSceneIndex forPrototype = false * UsdImaging_NiPrototypePruningSceneIndex [... as above] * UsdImagingRerootingSceneIndex (inserted by _InstanceAggregationSceneIndexObserver::PrimsAdded through _MergingSceneIndexEntry) srcPrefix = /UsdNiInstancer dstPrefix = /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer * UsdImagingNiPrototypePropagatingSceneIndex prototypeName = __Prototype_1 * HdMergingSceneIndex * UsdImaging_NiPrototypeSceneIndex forPrototype = true * UsdImagingRerootingSceneIndex srcPrefix = /__PrototypeRoot1 dstPrefix = /UsdNiInstancer/UsdNiPrototype * inputSceneIndex * UsdImaging_NiInstanceAggregationSceneIndex forPrototype = true * UsdImagingRerootingSceneIndex [... as just above]
UsdImagingNiPrototypePropagatingSceneIndex
/Cube_1 primType: "" dataSource: instance: # Useful for translating Usd proxy paths for selection.
instancer: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer prototypeId: 0 instanceId: 0 /MyPrototype # Not referenced from a different file, so appears here
primType: "" /MyPrototype/MyCube primType: cube /UsdNiPropagatedPrototypes /UsdNiPropagatedPrototypes/NoBindings /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1 primType: "" /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer primType: instancer dataSource: instancerTopology: instanceIndices: i0: [ 0 ] prototypes: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdNiPrototype instanceLocations: [ /Cube_1 ] # for picking primvars: instanceTransform: primvarValue: [ identity matrix ] interpolation: instance /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdNiPrototype primType: "" dataSource: instancedBy: paths: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer ] prototypeRoot: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1 /UsdNiInstancer/UsdNiPrototype /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdNiPrototype/MyCube primType: cube dataSource: instancedBy: paths: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer ] prototypeRoot: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_1 /UsdNiInstancer/UsdNiPrototype
Example 2:
def Xform "MyNestedPrototype" # Will become USD prototype /__Prototype_1 { def Cube "MyCube" { } }
def Xform "MyPrototype" # Will become USD prototype /__Prototype_2 { def "MyNestedInstance" ( instanceable = true references = </MyNestedPrototype> ) { } }
def Xform "MyInstance" ( instanceable = true references = </MyPrototype>) {
}
UsdImagingNiPrototypePropagatingSceneIndex
... /MyInstance primType: "" dataSource: instance: instancer: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer prototypeId: 0 instanceId: 0 /UsdNiPropagatedPrototypes /UsdNiPropagatedPrototypes/NoBindings /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2 primType: "" /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer primType: instancer dataSource: instanerTopology: prototypes: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype ] ... /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/_Prototype_2 primType: "" /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/_Prototype_2/MyNestedInstance primType: "" dataSource: instancer: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer prototypeId: 0 instanceId: 0 /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1 primType: "" /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer primType: instancer dataSource: instanerTopology: prototypes: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdPiPrototype ] ... instancedBy: paths: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer ] prototypeRoot: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdPiPrototype primType: "" dataSource: instancedBy: paths: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer ] prototypeRoot: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdPiPrototype /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdPiPrototype/MyCube primType: "cube" dataSource: instancedBy: paths: [ /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/UsdPiPrototype/UsdNiInstancer ] prototypeRoot: /UsdNiPropagatedPrototypes/NoBindings/__Prototype_2/UsdNiInstancer/UsdPiPrototype/UsdNiPropagatedPrototypes/NoBindings/__Prototype_1/UsdNiInstancer/UsdPiPrototype ...
Definition at line 247 of file niPrototypePropagatingSceneIndex.h.
|
overridevirtual |
Returns the paths of all scene index prims located immediately below primPath
. This function can be used to traverse the scene by recursing from SdfPath::AbsoluteRootPath()
; such a traversal is expected to give the same set of prims as the flattening of the scene index's PrimsAdded
and PrimsRemoved
messages. This function is expected to be threadsafe.
Implements HdSceneIndexBase.
|
overridevirtual |
Implements HdFilteringSceneIndexBase.
|
overridevirtual |
Returns a pair of (prim type, datasource) for the object at primPath
. If no such object exists, the type will be the empty token and the datasource will be null. This function is expected to be threadsafe.
Implements HdSceneIndexBase.
|
static |
|
friend |
Definition at line 274 of file niPrototypePropagatingSceneIndex.h.
|
friend |
Definition at line 298 of file niPrototypePropagatingSceneIndex.h.