#include <pointInstancerAdapter.h>

Inheritance diagram for UsdImagingPointInstancerAdapter:

Public Types
using	BaseAdapter = UsdImagingInstanceablePrimAdapter

Public Types inherited from UsdImagingInstanceablePrimAdapter
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

Scene Index Support
USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim) override

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

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

USDIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) 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

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

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

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

USDIMAGING_API size_t	SampleInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time, size_t maxNumSamples, float sampleTimes, GfMatrix4d sampleValues) 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 GfMatrix4d	GetTransform (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, bool ignoreRootTransform=false) const 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 PxOsdSubdivTags	GetSubdivTags (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
	Get the subdiv tags for this prim. More...

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

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

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

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	GetDoubleSided (UsdPrim const &usdPrim, SdfPath const &cachePath, UsdTimeCode time) const override
	Reads double-sided from the given prim. If not authored, returns false. More...

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 &instancerPath, SdfPath const &protoInstancerPath, 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	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 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 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
class	UsdImagingInstanceAdapter

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

Utility
USDIMAGING_API SdfPath	ResolveCachePath (const SdfPath &usdPath, const UsdImagingInstancerContext *ctx=nullptr) const override
	Returns whether custom shading of prims is enabled. More...

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

Additional Inherited Members
Static Public Member Functions inherited from UsdImagingPrimAdapter
static USDIMAGING_API UsdAttribute	LookupLightParamAttribute (UsdPrim const &prim, TfToken const &paramName)
	Provides to paramName->UsdAttribute value mappings. More...

static USDIMAGING_API bool	ShouldCullSubtree (UsdPrim const &prim)

Protected Types inherited from UsdImagingPrimAdapter
using	Keys = UsdImagingPrimvarDescCache::Key
	Returns whether custom shading of prims is enabled. More...

Protected Member Functions inherited from UsdImagingInstanceablePrimAdapter
USDIMAGING_API SdfPath	ResolveProxyPrimPath (const SdfPath &cachePath, const UsdImagingInstancerContext *instancerContext=nullptr) const

Protected Member Functions inherited from UsdImagingPrimAdapter
template<typename T >
T	_Get (UsdPrim const &prim, TfToken const &attrToken, UsdTimeCode time) const
	Returns whether custom shading of prims is enabled. More...

template<typename T >
void	_GetPtr (UsdPrim const &prim, TfToken const &key, UsdTimeCode time, T *out) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdImagingPrimvarDescCache *	_GetPrimvarDescCache () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdImaging_NonlinearSampleCountCache *	_GetNonlinearSampleCountCache () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdImaging_BlurScaleCache *	_GetBlurScaleCache () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdPrim	_GetPrim (SdfPath const &usdPath) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API const UsdImagingPrimAdapterSharedPtr &	_GetPrimAdapter (UsdPrim const &prim, bool ignoreInstancing=false) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API const UsdImagingPrimAdapterSharedPtr &	_GetAdapter (TfToken const &adapterKey) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API SdfPath	_GetPrimPathFromInstancerChain (SdfPathVector const &instancerChain) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdTimeCode	_GetTimeWithOffset (float offset) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API SdfPath	_ConvertCachePathToIndexPath (SdfPath const &cachePath) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API SdfPath	_ConvertIndexPathToCachePath (SdfPath const &indexPath) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API TfToken	_GetMaterialBindingPurpose () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API TfTokenVector	_GetMaterialRenderContexts () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API TfTokenVector	_GetRenderSettingsNamespaces () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API bool	_GetSceneMaterialsEnabled () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API bool	_GetSceneLightsEnabled () const
	Returns whether lights found in the usdscene are enabled. More...

USDIMAGING_API bool	_IsPrimvarFilteringNeeded () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API TfTokenVector	_GetShaderSourceTypes () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API bool	_IsInInvisedPaths (SdfPath const &usdPath) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API bool	_IsVarying (UsdPrim prim, TfToken const &attrName, HdDirtyBits dirtyFlag, TfToken const &perfToken, HdDirtyBits dirtyFlags, bool isInherited, bool exists=nullptr) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API bool	_IsTransformVarying (UsdPrim prim, HdDirtyBits dirtyFlag, TfToken const &perfToken, HdDirtyBits *dirtyFlags) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API void	_MergePrimvar (HdPrimvarDescriptorVector *vec, TfToken const &name, HdInterpolation interp, TfToken const &role=TfToken(), bool indexed=false) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API void	_RemovePrimvar (HdPrimvarDescriptorVector *vec, TfToken const &name) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API void	_ComputeAndMergePrimvar (UsdPrim const &prim, UsdGeomPrimvar const &primvar, UsdTimeCode time, HdPrimvarDescriptorVector primvarDescs, HdInterpolation interpOverride=nullptr) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API HdDirtyBits	_ProcessNonPrefixedPrimvarPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName, TfToken const &primvarName, HdInterpolation const &primvarInterp, HdDirtyBits valueChangeDirtyBit=HdChangeTracker::DirtyPrimvar) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API HdDirtyBits	_ProcessPrefixedPrimvarPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName, HdDirtyBits valueChangeDirtyBit=HdChangeTracker::DirtyPrimvar, bool inherited=true) const
	Returns whether custom shading of prims is enabled. More...

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

USDIMAGING_API UsdImaging_CollectionCache &	_GetCollectionCache () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdStageRefPtr	_GetStage () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdImaging_CoordSysBindingStrategy::value_type	_GetCoordSysBindings (UsdPrim const &prim) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdImaging_InheritedPrimvarStrategy::value_type	_GetInheritedPrimvars (UsdPrim const &prim) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API UsdGeomPrimvar	_GetInheritedPrimvar (UsdPrim const &prim, TfToken const &primvarName) const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API GfInterval	_GetCurrentTimeSamplingInterval ()
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API Usd_PrimFlagsConjunction	_GetDisplayPredicate () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API Usd_PrimFlagsConjunction	_GetDisplayPredicateForPrototypes () const
	Returns whether custom shading of prims is enabled. More...

USDIMAGING_API bool	_DoesDelegateSupportCoordSys () const
	Returns whether custom shading of prims is enabled. More...

Static Protected Member Functions inherited from UsdImagingPrimAdapter
static USDIMAGING_API bool	_HasPrimvarsPrefix (TfToken const &propertyName)
	Returns whether custom shading of prims is enabled. More...

Detailed Description

Delegate support for UsdGeomPointInstancer

Definition at line 28 of file pointInstancerAdapter.h.

Member Typedef Documentation

using UsdImagingPointInstancerAdapter::BaseAdapter = UsdImagingInstanceablePrimAdapter

Definition at line 31 of file pointInstancerAdapter.h.

Member Function Documentation

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

finaloverrideprotectedvirtual

Returns whether custom shading of prims is enabled.

Implements UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::GetDataSharingId ( SdfPath const & cachePath ) const

overridevirtual

Deprecated:: Call and implement GetScenePrimPaths instead.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::GetExtComputationInput	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	name,
		UsdTimeCode	time,
		const UsdImagingInstancerContext *	instancerContext
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API GfRange3d UsdImagingPointInstancerAdapter::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 HdContainerDataSourceHandle UsdImagingPointInstancerAdapter::GetImagingSubprimData	(	UsdPrim const &	prim,
		TfToken const &	subprim,
		const UsdImagingDataSourceStageGlobals &	stageGlobals
	)

overridevirtual

Returns the prim's behavior with regard to population and invalidation. See PopulationMode for possible values.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API TfTokenVector UsdImagingPointInstancerAdapter::GetImagingSubprims ( UsdPrim const & prim )

overridevirtual

Returns the prim's behavior with regard to population and invalidation. See PopulationMode for possible values.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API TfToken UsdImagingPointInstancerAdapter::GetImagingSubprimType	(	UsdPrim const &	prim,
		TfToken const &	subprim
	)

overridevirtual

Returns the prim's behavior with regard to population and invalidation. See PopulationMode for possible values.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Return the instancerId for this prim.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Return the list of known prototypes of this prim.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API GfMatrix4d UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::GetLightParamValue	(	const UsdPrim &	prim,
		const SdfPath &	cachePath,
		const TfToken &	paramName,
		UsdTimeCode	time
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API TfToken UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::GetScenePrimPath	(	SdfPath const &	cachePath,
		int	instanceIndex,
		HdInstancerContext *	instancerCtx
	)		const

overridevirtual

Deprecated:: Call and implement GetScenePrimPaths instead.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPathVector UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::GetSubdivTags	(	UsdPrim const &	usdPrim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

Get the subdiv tags for this prim.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::GetVolumeFieldDescriptors	(	UsdPrim const &	usdPrim,
		SdfPath const &	id,
		UsdTimeCode	time
	)		const

overridevirtual

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Returns the prim's behavior with regard to population and invalidation. See PopulationMode for possible values.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::MarkCollectionsDirty	(	const UsdPrim &	prim,
		const SdfPath &	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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::MarkLightParamsDirty	(	const UsdPrim &	prim,
		const SdfPath &	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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 SdfPath UsdImagingPointInstancerAdapter::ResolveCachePath	(	const SdfPath &	usdPath,
		const UsdImagingInstancerContext *	instancerContext = `nullptr`
	)		const

overrideprotectedvirtual

Returns whether custom shading of prims is enabled.

Reimplemented from UsdImagingInstanceablePrimAdapter.

USDIMAGING_API size_t UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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 UsdImagingPointInstancerAdapter::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.

Friends And Related Function Documentation

friend class UsdImagingInstanceAdapter

friend

Definition at line 364 of file pointInstancerAdapter.h.

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

pxr/usdImaging/usdImaging/pointInstancerAdapter.h

Public Types

Public Member Functions

Volume field information

Utility

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation