Delegate support for UsdGeomPointInstancer. More...

Inheritance diagram for UsdImagingPointInstancerAdapter:

Public Types
using	BaseAdapter = UsdImagingPrimAdapter

Public Member Functions
virtual SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy index, UsdImagingInstancerContext const instancerContext=nullptr) override
	Called to populate the RenderIndex for this UsdPrim. More...

virtual bool	ShouldCullChildren () const override

virtual bool	IsInstancerAdapter () const override

Parallel Setup and Resolve
virtual void	TrackVariability (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits timeVaryingBits, UsdImagingInstancerContext const instancerContext=NULL) const override
	For the given `prim`, variability is detected and stored in `timeVaryingBits`. More...

virtual void	UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
	Populates the `cache` for the given `prim`, `time` and `requestedBits`. More...

Change Processing
virtual HdDirtyBits	ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
	Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized. More...

virtual void	ProcessPrimResync (SdfPath const &cachePath, UsdImagingIndexProxy *index) override
	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. More...

virtual void	ProcessPrimRemoval (SdfPath const &cachePath, UsdImagingIndexProxy *index) override
	Removes all associated Rprims and dependencies from the render index without scheduling them for repopulation. More...

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

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

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

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

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

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

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

Instancing
GfMatrix4d	GetInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time) const override
	Get the instancer transform for the given prim. More...

size_t	SampleInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time, size_t maxNumSamples, float sampleTimes, GfMatrix4d sampleValues) override
	Sample the instancer transform for the given prim. More...

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

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

GfMatrix4d	GetTransform (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, bool ignoreRootTransform=false) const override
	Fetches the transform for the given prim at the given time from a pre-computed cache of prim transforms. More...

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...

size_t	SamplePrimvar (UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, size_t maxNumSamples, float sampleTimes, VtValue sampleValues, VtIntArray *sampleIndices) override
	Sample the primvar for the given prim. More...

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

bool	GetVisible (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	Returns true if the given prim is visible, taking into account inherited visibility values. More...

TfToken	GetPurpose (UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &instanceInheritablePurpose) const override
	Returns the purpose token for `prim`. More...

VtValue	GetTopology (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	Gets the topology object of a specific Usd prim. More...

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

GfRange3d	GetExtent (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
	Reads the extent from the given prim. More...

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

SdfPath	GetMaterialId (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override

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

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

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

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

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

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

VtValue	Get (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
	Gets the value of the parameter named key for the given prim (which has the given cache path) and given time. More...

Nested instancing support
virtual GfMatrix4d	GetRelativeInstancerTransform (SdfPath const &instancerPath, SdfPath const &protoInstancerPath, UsdTimeCode time) const override
	Returns the transform of `protoInstancerPath` relative to `instancerPath`. More...

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

virtual 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 HdDirtyBits	ProcessPrimChange (UsdPrim const &prim, SdfPath const &cachePath, TfTokenVector const &changedFields)
	Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized. More...

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	InvokeComputation (SdfPath const &cachePath, HdExtComputationContext *context)

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

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 bool	IsChildPath (SdfPath const &path) const

USDIMAGING_API TfToken	GetInheritablePurpose (UsdPrim const &prim) const
	Returns the purpose token for `prim`, but only if it is inheritable by child prims (i.e. More...

USDIMAGING_API SdfPath	GetMaterialUsdPath (UsdPrim const &prim) const
	Gets the material path for the given prim, walking up namespace if necessary. More...

USDIMAGING_API TfToken	GetModelDrawMode (UsdPrim const &prim)
	Gets the model:drawMode attribute for the given prim, walking up the namespace if necessary. More...

USDIMAGING_API VtArray < VtIntArray >	GetPerPrototypeIndices (UsdPrim const &prim, UsdTimeCode time) const
	Computes the per-prototype instance indices for a UsdGeomPointInstancer. More...

virtual USDIMAGING_API VtValue	GetMaterialResource (UsdPrim const &prim, SdfPath const &cachePath, 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...

	UsdImagingPrimAdapter ()

virtual USDIMAGING_API	~UsdImagingPrimAdapter ()

virtual USDIMAGING_API bool	ShouldIgnoreNativeInstanceSubtrees () const

virtual USDIMAGING_API bool	CanPopulateUsdInstance () const

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

Detailed Description

Delegate support for UsdGeomPointInstancer.

Definition at line 42 of file pointInstancerAdapter.h.

Member Function Documentation

VtValue 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.

HdCullStyle 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.

bool 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.

GfRange3d 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.

SdfPath GetInstancerId	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath
	)		const

overridevirtual

Return the instancerId for this prim.

Reimplemented from UsdImagingPrimAdapter.

SdfPathVector GetInstancerPrototypes	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath
	)		const

overridevirtual

Return the list of known prototypes of this prim.

Reimplemented from UsdImagingPrimAdapter.

GfMatrix4d 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.

TfToken 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.

virtual GfMatrix4d 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.

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

overridevirtual

Get the subdiv tags for this prim.

Reimplemented from UsdImagingPrimAdapter.

VtValue 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.

GfMatrix4d 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 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.

virtual SdfPath 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.

virtual void 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.

virtual void 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.

virtual HdDirtyBits 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.

size_t 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.

size_t 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.

size_t 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.

virtual void 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.

virtual void 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/pointInstancerAdapter.h

Public Types

Public Member Functions

Volume field information

Detailed Description

Member Function Documentation