#include <instanceAdapter.h>

Inheritance diagram for UsdImagingInstanceAdapter:

Public Types
using	BaseAdapter = UsdImagingPrimAdapter

Public Types inherited from UsdImagingPrimAdapter
enum	PopulationMode { RepresentsSelf, RepresentsSelfAndDescendents, RepresentedByAncestor }

Public Member Functions
USDIMAGING_API SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy index, UsdImagingInstancerContext const instancerContext=nullptr) override

USDIMAGING_API bool	ShouldCullChildren () const override

USDIMAGING_API bool	IsInstancerAdapter () const override

Parallel Setup and Resolve
USDIMAGING_API void	TrackVariability (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits timeVaryingBits, UsdImagingInstancerContext const instancerContext=NULL) const override

USDIMAGING_API void	UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override

Change Processing
USDIMAGING_API HdDirtyBits	ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override

USDIMAGING_API void	ProcessPrimResync (SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	ProcessPrimRemoval (SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkDirty (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkRefineLevelDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkReprDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkCullStyleDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkRenderTagDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkTransformDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

USDIMAGING_API void	MarkVisibilityDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

Instancing
USDIMAGING_API std::vector < VtArray< TfToken > >	GetInstanceCategories (UsdPrim const &prim) override
	Return an array of the categories used by each instance. More...

USDIMAGING_API GfMatrix4d	GetInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time) const override

USDIMAGING_API SdfPath	GetInstancerId (UsdPrim const &usdPrim, SdfPath const &cachePath) const override
	Return the instancerId for this prim. More...

USDIMAGING_API SdfPathVector	GetInstancerPrototypes (UsdPrim const &usdPrim, SdfPath const &cachePath) const override
	Return the list of known prototypes of this prim. More...

USDIMAGING_API size_t	SampleInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time, size_t maxSampleCount, float sampleTimes, GfMatrix4d sampleValues) override

USDIMAGING_API size_t	SampleTransform (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, size_t maxNumSamples, float sampleTimes, GfMatrix4d sampleValues) override
	Samples the transform for the given prim. More...

USDIMAGING_API size_t	SamplePrimvar (UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, size_t maxNumSamples, float sampleTimes, VtValue sampleValues, VtIntArray *sampleIndices) override

USDIMAGING_API TfToken	GetPurpose (UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &instanceInheritablePurpose) const override

USDIMAGING_API PxOsdSubdivTags	GetSubdivTags (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
	Get the subdiv tags for this prim. More...

USDIMAGING_API VtValue	GetTopology (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override

USDIMAGING_API HdCullStyle	GetCullStyle (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	Gets the cullstyle of a specific path in the scene graph. More...

USDIMAGING_API GfRange3d	GetExtent (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override

USDIMAGING_API bool	IsChildPath (const SdfPath &path) const override
	The root transform provided by the delegate. More...

bool	GetVisible (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override

USDIMAGING_API bool	GetDoubleSided (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	Reads double-sided from the given prim. If not authored, returns false. More...

USDIMAGING_API GfMatrix4d	GetTransform (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, bool ignoreRootTransform=false) const override

USDIMAGING_API SdfPath	GetMaterialId (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	The root transform provided by the delegate. More...

USDIMAGING_API VtValue	GetLightParamValue (const UsdPrim &prim, const SdfPath &cachePath, const TfToken &paramName, UsdTimeCode time) const override

USDIMAGING_API VtValue	GetMaterialResource (const UsdPrim &prim, const SdfPath &cachePath, UsdTimeCode time) const override
	The root transform provided by the delegate. More...

USDIMAGING_API HdExtComputationInputDescriptorVector	GetExtComputationInputs (UsdPrim const &prim, SdfPath const &cachePath, const UsdImagingInstancerContext *instancerContext) const override

USDIMAGING_API HdExtComputationOutputDescriptorVector	GetExtComputationOutputs (UsdPrim const &prim, SdfPath const &cachePath, const UsdImagingInstancerContext *instancerContext) const override

USDIMAGING_API HdExtComputationPrimvarDescriptorVector	GetExtComputationPrimvars (UsdPrim const &prim, SdfPath const &cachePath, HdInterpolation interpolation, const UsdImagingInstancerContext *instancerContext) const override

USDIMAGING_API VtValue	GetExtComputationInput (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &name, UsdTimeCode time, const UsdImagingInstancerContext *instancerContext) const override

USDIMAGING_API std::string	GetExtComputationKernel (UsdPrim const &prim, SdfPath const &cachePath, const UsdImagingInstancerContext *instancerContext) const override

USDIMAGING_API VtValue	GetInstanceIndices (UsdPrim const &instancerPrim, SdfPath const &instancerCachePath, SdfPath const &prototypeCachePath, UsdTimeCode time) const override

USDIMAGING_API VtValue	Get (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override

Nested instancing support
USDIMAGING_API GfMatrix4d	GetRelativeInstancerTransform (SdfPath const &parentInstancerPath, SdfPath const &instancerPath, UsdTimeCode time) const override

Picking & selection
USDIMAGING_API SdfPath	GetScenePrimPath (SdfPath const &cachePath, int instanceIndex, HdInstancerContext *instancerContext) const override

USDIMAGING_API SdfPathVector	GetScenePrimPaths (SdfPath const &cachePath, std::vector< int > const &instanceIndices, std::vector< HdInstancerContext > *instancerCtxs) const override

USDIMAGING_API SdfPath	GetDataSharingId (SdfPath const &cachePath) const override

USDIMAGING_API bool	PopulateSelection (HdSelection::HighlightMode const &highlightMode, SdfPath const &cachePath, UsdPrim const &usdPrim, int const hydraInstanceIndex, VtIntArray const &parentInstanceIndices, HdSelectionSharedPtr const &result) const override

Public Member Functions inherited from UsdImagingPrimAdapter
virtual USDIMAGING_API	~UsdImagingPrimAdapter ()=default

virtual USDIMAGING_API HdDirtyBits	ProcessPrimChange (UsdPrim const &prim, SdfPath const &cachePath, TfTokenVector const &changedFields)

virtual USDIMAGING_API void	MarkMaterialDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)

virtual USDIMAGING_API void	MarkLightParamsDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)

virtual USDIMAGING_API void	MarkWindowPolicyDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)

virtual USDIMAGING_API void	MarkCollectionsDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)

virtual USDIMAGING_API void	InvokeComputation (SdfPath const &cachePath, HdExtComputationContext *context)

USDIMAGING_API GfMatrix4d	GetRootTransform () const
	The root transform provided by the delegate. More...

USDIMAGING_API void	SetDelegate (UsdImagingDelegate *delegate)
	A thread-local XformCache provided by the delegate. More...

USDIMAGING_API TfToken	GetInheritablePurpose (UsdPrim const &prim) const

USDIMAGING_API SdfPath	GetMaterialUsdPath (UsdPrim const &prim) const

USDIMAGING_API TfToken	GetModelDrawMode (UsdPrim const &prim)

USDIMAGING_API HdModelDrawMode	GetFullModelDrawMode (UsdPrim const &prim)

USDIMAGING_API VtArray < VtIntArray >	GetPerPrototypeIndices (UsdPrim const &prim, UsdTimeCode time) const

virtual USDIMAGING_API const TfTokenVector &	GetExtComputationSceneInputNames (SdfPath const &cachePath) const

virtual USDIMAGING_API size_t	SampleExtComputationInput (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &name, UsdTimeCode time, const UsdImagingInstancerContext instancerContext, size_t maxSampleCount, float sampleTimes, VtValue *sampleValues)

virtual bool	IsSupported (UsdImagingIndexProxy const *index) const
	Returns true if the adapter can be populated into the target index. More...

virtual USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim)

virtual USDIMAGING_API TfToken	GetImagingSubprimType (UsdPrim const &prim, TfToken const &subprim)

virtual USDIMAGING_API HdContainerDataSourceHandle	GetImagingSubprimData (UsdPrim const &prim, TfToken const &subprim, const UsdImagingDataSourceStageGlobals &stageGlobals)

virtual USDIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType)

virtual USDIMAGING_API PopulationMode	GetPopulationMode ()

virtual USDIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprimFromDescendent (UsdPrim const &prim, UsdPrim const &descendentPrim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType)

virtual USDIMAGING_API bool	ShouldIgnoreNativeInstanceSubtrees () const

virtual USDIMAGING_API bool	CanPopulateUsdInstance () const

Volume field information
USDIMAGING_API HdVolumeFieldDescriptorVector	GetVolumeFieldDescriptors (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) const override

USDIMAGING_API void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index) overridefinal
	Returns whether custom shading of prims is enabled. More...

Detailed Description

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 75 of file instanceAdapter.h.

Member Typedef Documentation

using UsdImagingInstanceAdapter::BaseAdapter = UsdImagingPrimAdapter

Definition at line 78 of file instanceAdapter.h.

Member Function Documentation

USDIMAGING_API void UsdImagingInstanceAdapter::_RemovePrim	(	SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

finaloverrideprotectedvirtual

Returns whether custom shading of prims is enabled.

Implements UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingInstanceAdapter::Get	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	key,
		UsdTimeCode	time,
		VtIntArray *	outIndices
	)		const

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.

USDIMAGING_API HdCullStyle UsdImagingInstanceAdapter::GetCullStyle	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

Gets the cullstyle of a specific path in the scene graph.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPath UsdImagingInstanceAdapter::GetDataSharingId ( SdfPath const & cachePath ) const

overridevirtual

Deprecated:: Call and implement GetScenePrimPaths instead.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingInstanceAdapter::GetDoubleSided	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

Reads double-sided from the given prim. If not authored, returns false.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingInstanceAdapter::GetExtComputationInput	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	name,
		UsdTimeCode	time,
		const UsdImagingInstancerContext *	instancerContext
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API HdExtComputationInputDescriptorVector UsdImagingInstanceAdapter::GetExtComputationInputs	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		const UsdImagingInstancerContext *	instancerContext
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API std::string UsdImagingInstanceAdapter::GetExtComputationKernel	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		const UsdImagingInstancerContext *	instancerContext
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API HdExtComputationOutputDescriptorVector UsdImagingInstanceAdapter::GetExtComputationOutputs	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		const UsdImagingInstancerContext *	instancerContext
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API HdExtComputationPrimvarDescriptorVector UsdImagingInstanceAdapter::GetExtComputationPrimvars	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		HdInterpolation	interpolation,
		const UsdImagingInstancerContext *	instancerContext
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API GfRange3d UsdImagingInstanceAdapter::GetExtent	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

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.

USDIMAGING_API std::vector<VtArray<TfToken> > UsdImagingInstanceAdapter::GetInstanceCategories ( UsdPrim const & prim )

overridevirtual

Return an array of the categories used by each instance.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingInstanceAdapter::GetInstanceIndices	(	UsdPrim const &	instancerPrim,
		SdfPath const &	instancerCachePath,
		SdfPath const &	prototypeCachePath,
		UsdTimeCode	time
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPath UsdImagingInstanceAdapter::GetInstancerId	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath
	)		const

overridevirtual

Return the instancerId for this prim.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPathVector UsdImagingInstanceAdapter::GetInstancerPrototypes	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath
	)		const

overridevirtual

Return the list of known prototypes of this prim.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API GfMatrix4d UsdImagingInstanceAdapter::GetInstancerTransform	(	UsdPrim const &	instancerPrim,
		SdfPath const &	instancerPath,
		UsdTimeCode	time
	)		const

overridevirtual

Get the instancer transform for the given prim.

See Also: HdSceneDelegate::GetInstancerTransform()

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingInstanceAdapter::GetLightParamValue	(	const UsdPrim &	prim,
		const SdfPath &	cachePath,
		const TfToken &	paramName,
		UsdTimeCode	time
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPath UsdImagingInstanceAdapter::GetMaterialId	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingInstanceAdapter::GetMaterialResource	(	const UsdPrim &	prim,
		const SdfPath &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API TfToken UsdImagingInstanceAdapter::GetPurpose	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	instanceInheritablePurpose
	)		const

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.

USDIMAGING_API GfMatrix4d UsdImagingInstanceAdapter::GetRelativeInstancerTransform	(	SdfPath const &	instancerPath,
		SdfPath const &	protoInstancerPath,
		UsdTimeCode	time
	)		const

overridevirtual

Returns the transform of protoInstancerPath relative to instancerPath. instancerPath must be managed by this adapter.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPath UsdImagingInstanceAdapter::GetScenePrimPath	(	SdfPath const &	cachePath,
		int	instanceIndex,
		HdInstancerContext *	instancerCtx
	)		const

overridevirtual

Deprecated:: Call and implement GetScenePrimPaths instead.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPathVector UsdImagingInstanceAdapter::GetScenePrimPaths	(	SdfPath const &	cachePath,
		std::vector< int > const &	instanceIndices,
		std::vector< HdInstancerContext > *	instancerCtxs
	)		const

overridevirtual

Deprecated:: Call and implement GetScenePrimPaths instead.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API PxOsdSubdivTags UsdImagingInstanceAdapter::GetSubdivTags	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

Get the subdiv tags for this prim.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingInstanceAdapter::GetTopology	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

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.

USDIMAGING_API GfMatrix4d UsdImagingInstanceAdapter::GetTransform	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time,
		bool	ignoreRootTransform = `false`
	)		const

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.

bool UsdImagingInstanceAdapter::GetVisible	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

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.

USDIMAGING_API HdVolumeFieldDescriptorVector UsdImagingInstanceAdapter::GetVolumeFieldDescriptors	(	UsdPrim const &	usdPrim,
		SdfPath const &	id,
		UsdTimeCode	time
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingInstanceAdapter::IsChildPath ( const SdfPath & path ) const

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingInstanceAdapter::IsInstancerAdapter ( ) const

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkCullStyleDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		HdDirtyBits	dirty,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkRefineLevelDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkRenderTagDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkReprDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkTransformDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API void UsdImagingInstanceAdapter::MarkVisibilityDirty	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API SdfPath UsdImagingInstanceAdapter::Populate	(	UsdPrim const &	prim,
		UsdImagingIndexProxy *	index,
		UsdImagingInstancerContext const *	instancerContext = `nullptr`
	)

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.

USDIMAGING_API bool UsdImagingInstanceAdapter::PopulateSelection	(	HdSelection::HighlightMode const &	highlightMode,
		SdfPath const &	cachePath,
		UsdPrim const &	usdPrim,
		int const	hydraInstanceIndex,
		VtIntArray const &	parentInstanceIndices,
		HdSelectionSharedPtr const &	result
	)		const

overridevirtual

Deprecated:: Call and implement GetScenePrimPaths instead.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API void UsdImagingInstanceAdapter::ProcessPrimRemoval	(	SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

overridevirtual

Removes all associated Rprims and dependencies from the render index without scheduling them for repopulation.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API void UsdImagingInstanceAdapter::ProcessPrimResync	(	SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

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.

USDIMAGING_API HdDirtyBits UsdImagingInstanceAdapter::ProcessPropertyChange	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	propertyName
	)

overridevirtual

Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized.

Implements UsdImagingPrimAdapter.

USDIMAGING_API size_t UsdImagingInstanceAdapter::SampleInstancerTransform	(	UsdPrim const &	instancerPrim,
		SdfPath const &	instancerPath,
		UsdTimeCode	time,
		size_t	maxNumSamples,
		float *	sampleTimes,
		GfMatrix4d *	sampleValues
	)

overridevirtual

Sample the instancer transform for the given prim.

See Also: HdSceneDelegate::SampleInstancerTransform()

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API size_t UsdImagingInstanceAdapter::SamplePrimvar	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath,
		TfToken const &	key,
		UsdTimeCode	time,
		size_t	maxNumSamples,
		float *	sampleTimes,
		VtValue *	sampleValues,
		VtIntArray *	sampleIndices
	)

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.

See Also: HdSceneDelegate::SamplePrimvar() and HdSceneDelegate::SampleIndexedPrimvar()

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API size_t UsdImagingInstanceAdapter::SampleTransform	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time,
		size_t	maxNumSamples,
		float *	sampleTimes,
		GfMatrix4d *	sampleValues
	)

overridevirtual

Samples the transform for the given prim.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingInstanceAdapter::ShouldCullChildren ( ) const

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.

USDIMAGING_API void UsdImagingInstanceAdapter::TrackVariability	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		HdDirtyBits *	timeVaryingBits,
		UsdImagingInstancerContext const *	instancerContext = `NULL`
	)		const

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.

USDIMAGING_API void UsdImagingInstanceAdapter::UpdateForTime	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time,
		HdDirtyBits	requestedBits,
		UsdImagingInstancerContext const *	instancerContext = `NULL`
	)		const

overridevirtual

Populates the cache for the given prim, time and requestedBits.

This method is expected to be called from multiple threads.

Implements UsdImagingPrimAdapter.

The documentation for this class was generated from the following file:

pxr/usdImaging/usdImaging/instanceAdapter.h

Public Types

Public Member Functions

Volume field information

Detailed Description

Member Typedef Documentation

Member Function Documentation