#include <primAdapter.h>

Inheritance diagram for UsdImagingPrimAdapter:

Public Member Functions
Parallel Setup and Resolve
virtual void	TrackVariability (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits timeVaryingBits, UsdImagingInstancerContext const instancerContext=nullptr) const =0

virtual void	UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const =0

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

virtual HdDirtyBits	ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)=0

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

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

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

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

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

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

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

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

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

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)

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

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

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

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

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

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

virtual 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)

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

Nested instancing support
virtual USDIMAGING_API GfMatrix4d	GetRelativeInstancerTransform (SdfPath const &instancerPath, SdfPath const &protoInstancerPath, UsdTimeCode time) const

Selection
virtual USDIMAGING_API SdfPath	GetScenePrimPath (SdfPath const &cachePath, int instanceIndex, HdInstancerContext *instancerCtx) const

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

virtual USDIMAGING_API SdfPath	GetDataSharingId (SdfPath const &cachePath) const

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

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

Utilities
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
	The root transform provided by the delegate. More...

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

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

USDIMAGING_API TfToken	GetInheritablePurpose (UsdPrim const &prim) const

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

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

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

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

USDIMAGING_API SdfPath	GetMaterialUsdPath (UsdPrim const &prim) const

USDIMAGING_API TfToken	GetModelDrawMode (UsdPrim const &prim)

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

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

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

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

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

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

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

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

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

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

virtual USDIMAGING_API VtValue	GetExtComputationInput (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &name, UsdTimeCode time, const UsdImagingInstancerContext *instancerContext) 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 USDIMAGING_API std::string	GetExtComputationKernel (UsdPrim const &prim, SdfPath const &cachePath, const UsdImagingInstancerContext *instancerContext) const

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

Initialization
	UsdImagingPrimAdapter ()

virtual USDIMAGING_API	~UsdImagingPrimAdapter ()

virtual SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy index, UsdImagingInstancerContext const instancerContext=nullptr)=0

virtual USDIMAGING_API bool	ShouldCullChildren () const

virtual USDIMAGING_API bool	ShouldIgnoreNativeInstanceSubtrees () const

virtual USDIMAGING_API bool	IsInstancerAdapter () const

virtual USDIMAGING_API bool	CanPopulateUsdInstance () const

static USDIMAGING_API bool	ShouldCullSubtree (UsdPrim const &prim)

Render Index Compatibility
using	Keys = UsdImagingPrimvarDescCache::Key
	Returns true if the adapter can be populated into the target index. More...

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

template<typename T >
T	_Get (UsdPrim const &prim, TfToken const &attrToken, UsdTimeCode time) const
	Returns true if the adapter can be populated into the target index. More...

template<typename T >
void	_GetPtr (UsdPrim const &prim, TfToken const &key, UsdTimeCode time, T *out) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API UsdImagingPrimvarDescCache *	_GetPrimvarDescCache () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API UsdPrim	_GetPrim (SdfPath const &usdPath) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API const UsdImagingPrimAdapterSharedPtr &	_GetPrimAdapter (UsdPrim const &prim, bool ignoreInstancing=false) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API const UsdImagingPrimAdapterSharedPtr &	_GetAdapter (TfToken const &adapterKey) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API SdfPath	_GetPrimPathFromInstancerChain (SdfPathVector const &instancerChain) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API UsdTimeCode	_GetTimeWithOffset (float offset) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API SdfPath	_ConvertCachePathToIndexPath (SdfPath const &cachePath) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API SdfPath	_ConvertIndexPathToCachePath (SdfPath const &indexPath) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API TfToken	_GetMaterialBindingPurpose () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API TfTokenVector	_GetMaterialRenderContexts () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API bool	_IsPrimvarFilteringNeeded () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API TfTokenVector	_GetShaderSourceTypes () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API bool	_IsInInvisedPaths (SdfPath const &usdPath) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API bool	_IsVarying (UsdPrim prim, TfToken const &attrName, HdDirtyBits dirtyFlag, TfToken const &perfToken, HdDirtyBits dirtyFlags, bool isInherited, bool exists=nullptr) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API bool	_IsTransformVarying (UsdPrim prim, HdDirtyBits dirtyFlag, TfToken const &perfToken, HdDirtyBits *dirtyFlags) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API void	_MergePrimvar (HdPrimvarDescriptorVector *vec, TfToken const &name, HdInterpolation interp, TfToken const &role=TfToken(), bool indexed=false) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API void	_RemovePrimvar (HdPrimvarDescriptorVector *vec, TfToken const &name) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API void	_ComputeAndMergePrimvar (UsdPrim const &prim, UsdGeomPrimvar const &primvar, UsdTimeCode time, HdPrimvarDescriptorVector primvarDescs, HdInterpolation interpOverride=nullptr) const
	Returns true if the adapter can be populated into the target index. 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 true if the adapter can be populated into the target index. More...

USDIMAGING_API HdDirtyBits	_ProcessPrefixedPrimvarPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName, HdDirtyBits valueChangeDirtyBit=HdChangeTracker::DirtyPrimvar, bool inherited=true) const
	Returns true if the adapter can be populated into the target index. More...

virtual void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index)=0
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API void	_ResyncDependents (SdfPath const &usdPath, UsdImagingIndexProxy *index)
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API UsdImaging_CollectionCache &	_GetCollectionCache () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API UsdImaging_CoordSysBindingStrategy::value_type	_GetCoordSysBindings (UsdPrim const &prim) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API UsdImaging_InheritedPrimvarStrategy::value_type	_GetInheritedPrimvars (UsdPrim const &prim) const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API GfInterval	_GetCurrentTimeSamplingInterval ()
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API Usd_PrimFlagsConjunction	_GetDisplayPredicate () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API Usd_PrimFlagsConjunction	_GetDisplayPredicateForPrototypes () const
	Returns true if the adapter can be populated into the target index. More...

USDIMAGING_API bool	_DoesDelegateSupportCoordSys () const
	Returns true if the adapter can be populated into the target index. More...

static USDIMAGING_API bool	_HasPrimvarsPrefix (TfToken const &propertyName)
	Returns true if the adapter can be populated into the target index. More...

static USDIMAGING_API HdInterpolation	_UsdToHdInterpolation (TfToken const &usdInterp)
	Returns true if the adapter can be populated into the target index. More...

static USDIMAGING_API TfToken	_UsdToHdRole (TfToken const &usdRole)
	Returns true if the adapter can be populated into the target index. More...

Detailed Description

Base class for all PrimAdapters.

Definition at line 65 of file primAdapter.h.

Member Typedef Documentation

using UsdImagingPrimAdapter::Keys = UsdImagingPrimvarDescCache::Key

protected

Returns true if the adapter can be populated into the target index.

Definition at line 602 of file primAdapter.h.

Constructor & Destructor Documentation

UsdImagingPrimAdapter::UsdImagingPrimAdapter ( )

inline

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.

Definition at line 74 of file primAdapter.h.

virtual USDIMAGING_API UsdImagingPrimAdapter::~UsdImagingPrimAdapter ( )

virtual

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.

Member Function Documentation

USDIMAGING_API void UsdImagingPrimAdapter::_ComputeAndMergePrimvar	(	UsdPrim const &	prim,
		UsdGeomPrimvar const &	primvar,
		UsdTimeCode	time,
		HdPrimvarDescriptorVector *	primvarDescs,
		HdInterpolation *	interpOverride = `nullptr`
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API SdfPath UsdImagingPrimAdapter::_ConvertCachePathToIndexPath ( SdfPath const & cachePath ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API SdfPath UsdImagingPrimAdapter::_ConvertIndexPathToCachePath ( SdfPath const & indexPath ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API bool UsdImagingPrimAdapter::_DoesDelegateSupportCoordSys ( ) const

protected

Returns true if the adapter can be populated into the target index.

template<typename T >

T UsdImagingPrimAdapter::_Get	(	UsdPrim const &	prim,
		TfToken const &	attrToken,
		UsdTimeCode	time
	)		const

inlineprotected

Returns true if the adapter can be populated into the target index.

Definition at line 605 of file primAdapter.h.

USDIMAGING_API const UsdImagingPrimAdapterSharedPtr& UsdImagingPrimAdapter::_GetAdapter ( TfToken const & adapterKey ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API UsdImaging_CollectionCache& UsdImagingPrimAdapter::_GetCollectionCache ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API UsdImaging_CoordSysBindingStrategy::value_type UsdImagingPrimAdapter::_GetCoordSysBindings ( UsdPrim const & prim ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API GfInterval UsdImagingPrimAdapter::_GetCurrentTimeSamplingInterval ( )

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API Usd_PrimFlagsConjunction UsdImagingPrimAdapter::_GetDisplayPredicate ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API Usd_PrimFlagsConjunction UsdImagingPrimAdapter::_GetDisplayPredicateForPrototypes ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API UsdImaging_InheritedPrimvarStrategy::value_type UsdImagingPrimAdapter::_GetInheritedPrimvars ( UsdPrim const & prim ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API TfToken UsdImagingPrimAdapter::_GetMaterialBindingPurpose ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API TfTokenVector UsdImagingPrimAdapter::_GetMaterialRenderContexts ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API UsdPrim UsdImagingPrimAdapter::_GetPrim ( SdfPath const & usdPath ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API const UsdImagingPrimAdapterSharedPtr& UsdImagingPrimAdapter::_GetPrimAdapter	(	UsdPrim const &	prim,
		bool	ignoreInstancing = `false`
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API SdfPath UsdImagingPrimAdapter::_GetPrimPathFromInstancerChain ( SdfPathVector const & instancerChain ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API UsdImagingPrimvarDescCache* UsdImagingPrimAdapter::_GetPrimvarDescCache ( ) const

protected

Returns true if the adapter can be populated into the target index.

template<typename T >

void UsdImagingPrimAdapter::_GetPtr	(	UsdPrim const &	prim,
		TfToken const &	key,
		UsdTimeCode	time,
		T *	out
	)		const

inlineprotected

Returns true if the adapter can be populated into the target index.

Definition at line 613 of file primAdapter.h.

USDIMAGING_API TfTokenVector UsdImagingPrimAdapter::_GetShaderSourceTypes ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API UsdTimeCode UsdImagingPrimAdapter::_GetTimeWithOffset ( float offset ) const

protected

Returns true if the adapter can be populated into the target index.

static USDIMAGING_API bool UsdImagingPrimAdapter::_HasPrimvarsPrefix ( TfToken const & propertyName )

staticprotected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API bool UsdImagingPrimAdapter::_IsInInvisedPaths ( SdfPath const & usdPath ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API bool UsdImagingPrimAdapter::_IsPrimvarFilteringNeeded ( ) const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API bool UsdImagingPrimAdapter::_IsTransformVarying	(	UsdPrim	prim,
		HdDirtyBits	dirtyFlag,
		TfToken const &	perfToken,
		HdDirtyBits *	dirtyFlags
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API bool UsdImagingPrimAdapter::_IsVarying	(	UsdPrim	prim,
		TfToken const &	attrName,
		HdDirtyBits	dirtyFlag,
		TfToken const &	perfToken,
		HdDirtyBits *	dirtyFlags,
		bool	isInherited,
		bool *	exists = `nullptr`
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API void UsdImagingPrimAdapter::_MergePrimvar	(	HdPrimvarDescriptorVector *	vec,
		TfToken const &	name,
		HdInterpolation	interp,
		TfToken const &	role = `TfToken()`,
		bool	indexed = `false`
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API HdDirtyBits UsdImagingPrimAdapter::_ProcessNonPrefixedPrimvarPropertyChange	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	propertyName,
		TfToken const &	primvarName,
		HdInterpolation const &	primvarInterp,
		HdDirtyBits	valueChangeDirtyBit = `HdChangeTracker::DirtyPrimvar`
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API HdDirtyBits UsdImagingPrimAdapter::_ProcessPrefixedPrimvarPropertyChange	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	propertyName,
		HdDirtyBits	valueChangeDirtyBit = `HdChangeTracker::DirtyPrimvar`,
		bool	inherited = `true`
	)		const

protected

Returns true if the adapter can be populated into the target index.

virtual void UsdImagingPrimAdapter::_RemovePrim	(	SdfPath const &	cachePath,
		UsdImagingIndexProxy *	index
	)

protectedpure virtual

USDIMAGING_API void UsdImagingPrimAdapter::_RemovePrimvar	(	HdPrimvarDescriptorVector *	vec,
		TfToken const &	name
	)		const

protected

Returns true if the adapter can be populated into the target index.

USDIMAGING_API void UsdImagingPrimAdapter::_ResyncDependents	(	SdfPath const &	usdPath,
		UsdImagingIndexProxy *	index
	)

protected

Returns true if the adapter can be populated into the target index.

static USDIMAGING_API HdInterpolation UsdImagingPrimAdapter::_UsdToHdInterpolation ( TfToken const & usdInterp )

staticprotected

Returns true if the adapter can be populated into the target index.

static USDIMAGING_API TfToken UsdImagingPrimAdapter::_UsdToHdRole ( TfToken const & usdRole )

staticprotected

Returns true if the adapter can be populated into the target index.

virtual USDIMAGING_API bool UsdImagingPrimAdapter::CanPopulateUsdInstance ( ) const

virtual

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 in UsdImagingGLDrawModeAdapter, and UsdSkelImagingSkelRootAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingPointInstancerAdapter, UsdImagingGprimAdapter, UsdImagingGLDrawModeAdapter, UsdImagingFieldAdapter, UsdImagingCameraAdapter, UsdImagingMeshAdapter, UsdImagingBasisCurvesAdapter, UsdImagingNurbsCurvesAdapter, UsdImagingPointsAdapter, UsdImagingField3DAssetAdapter, and UsdImagingOpenVDBAssetAdapter.

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

virtual

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

Reimplemented in UsdImagingInstanceAdapter, UsdImagingPointInstancerAdapter, and UsdImagingGLDrawModeAdapter.

virtual USDIMAGING_API SdfPath UsdImagingPrimAdapter::GetDataSharingId ( SdfPath const & cachePath ) const

virtual

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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

Reimplemented in UsdImagingInstanceAdapter, UsdImagingPointInstancerAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, and UsdImagingGLDrawModeAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdSkelImagingSkeletonAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdImagingPointInstancerAdapter, UsdImagingGprimAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingGLDrawModeAdapter.

USDIMAGING_API TfToken UsdImagingPrimAdapter::GetInheritablePurpose ( UsdPrim const & prim ) const

Returns the purpose token for prim, but only if it is inheritable by child prims (i.e. it is an explicitly authored purpose on the prim itself or one of the prim's ancestors), otherwise it returns the empty token.

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

virtual

Return an array of the categories used by each instance.

Reimplemented in UsdImagingInstanceAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Return the instancerId for this prim.

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Return the list of known prototypes of this prim.

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Get the instancer transform for the given prim.

See Also: HdSceneDelegate::GetInstancerTransform()

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

The root transform provided by the delegate.

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingPointInstancerAdapter, UsdImagingGprimAdapter, and UsdImagingGLDrawModeAdapter.

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

virtual

The root transform provided by the delegate.

Reimplemented in UsdImagingGLDrawModeAdapter, UsdImagingLightAdapter, UsdImagingLightFilterAdapter, and UsdImagingMaterialAdapter.

USDIMAGING_API SdfPath UsdImagingPrimAdapter::GetMaterialUsdPath ( UsdPrim const & prim ) const

Gets the material path for the given prim, walking up namespace if necessary.

USDIMAGING_API TfToken UsdImagingPrimAdapter::GetModelDrawMode ( UsdPrim const & prim )

Gets the model:drawMode attribute for the given prim, walking up the namespace if necessary.

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

Computes the per-prototype instance indices for a UsdGeomPointInstancer. XXX: This needs to be defined on the base class, to have access to the delegate, but it's a clear violation of abstraction. This call is only legal for prims of type UsdGeomPointInstancer; in other cases, the returned array will be empty and the computation will issue errors.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

USDIMAGING_API GfMatrix4d UsdImagingPrimAdapter::GetRootTransform ( ) const

The root transform provided by the delegate.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Get the subdiv tags for this prim.

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingPointInstancerAdapter, and UsdImagingMeshAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdImagingPointInstancerAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGLDrawModeAdapter, UsdImagingMeshAdapter, UsdImagingBasisCurvesAdapter, UsdImagingNurbsCurvesAdapter, UsdImagingHermiteCurvesAdapter, UsdImagingSphereAdapter, UsdImagingCubeAdapter, UsdImagingCapsuleAdapter, UsdImagingConeAdapter, UsdImagingCylinderAdapter, and UsdImagingNurbsPatchAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdImagingGLDrawModeAdapter, and UsdImagingPointInstancerAdapter.

virtual USDIMAGING_API bool UsdImagingPrimAdapter::GetVisible	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

virtual

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 in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, UsdImagingPointInstancerAdapter, and UsdImagingVolumeAdapter.

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

virtual

Reimplemented in UsdSkelImagingSkeletonAdapter.

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

The root transform provided by the delegate.

virtual USDIMAGING_API bool UsdImagingPrimAdapter::IsInstancerAdapter ( ) const

virtual

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 in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

virtual bool UsdImagingPrimAdapter::IsSupported ( UsdImagingIndexProxy const * index ) const

inlinevirtual

Returns true if the adapter can be populated into the target index.

Reimplemented in UsdSkelImagingSkeletonAdapter, UsdImagingGLDrawModeAdapter, UsdImagingHermiteCurvesAdapter, UsdImagingLightAdapter, UsdImagingMeshAdapter, UsdImagingSphereAdapter, UsdImagingCameraAdapter, UsdImagingFieldAdapter, UsdImagingBasisCurvesAdapter, UsdImagingCubeAdapter, UsdImagingLightFilterAdapter, UsdImagingNurbsCurvesAdapter, UsdImagingPointsAdapter, UsdImagingCapsuleAdapter, UsdImagingConeAdapter, UsdImagingCylinderAdapter, UsdImagingCylinderLightAdapter, UsdImagingDiskLightAdapter, UsdImagingDistantLightAdapter, UsdImagingGeometryLightAdapter, UsdImagingNurbsPatchAdapter, UsdImagingPluginLightAdapter, UsdImagingPluginLightFilterAdapter, UsdImagingPortalLightAdapter, UsdImagingRectLightAdapter, UsdImagingSphereLightAdapter, UsdRiImagingPxrBarnLightFilterAdapter, UsdRiImagingPxrIntMultLightFilterAdapter, UsdRiImagingPxrRodLightFilterAdapter, UsdImagingCoordSysAdapter, UsdImagingMaterialAdapter, and UsdImagingVolumeAdapter.

Definition at line 597 of file primAdapter.h.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, and UsdImagingPointInstancerAdapter.

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

pure virtual

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.

Implemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdSkelImagingSkelRootAdapter, UsdImagingLightAdapter, UsdImagingGLDrawModeAdapter, UsdImagingFieldAdapter, UsdImagingCoordSysAdapter, UsdImagingLightFilterAdapter, UsdImagingCameraAdapter, UsdImagingMaterialAdapter, UsdImagingPointInstancerAdapter, and UsdImagingGprimAdapter.

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

virtual

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

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

virtual

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 in UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, UsdImagingGLDrawModeAdapter, and UsdImagingMaterialAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingPointInstancerAdapter, and UsdImagingGprimAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, UsdImagingPointInstancerAdapter, UsdImagingLightAdapter, UsdImagingGLDrawModeAdapter, UsdImagingFieldAdapter, UsdImagingCoordSysAdapter, UsdImagingLightFilterAdapter, and UsdImagingCameraAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingGprimAdapter, UsdImagingPointInstancerAdapter, UsdImagingLightAdapter, UsdImagingGLDrawModeAdapter, UsdImagingFieldAdapter, and UsdImagingLightFilterAdapter.

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

virtual

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

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

pure virtual

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.

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

virtual

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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.

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

virtual

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

Reimplemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, UsdImagingMaterialAdapter, UsdSkelImagingSkeletonAdapter, UsdImagingPointInstancerAdapter, and UsdImagingCoordSysAdapter.

virtual HdDirtyBits UsdImagingPrimAdapter::ProcessPropertyChange	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		TfToken const &	propertyName
	)

pure virtual

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

Implemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdSkelImagingSkelRootAdapter, UsdImagingLightAdapter, UsdImagingGLDrawModeAdapter, UsdImagingFieldAdapter, UsdImagingCoordSysAdapter, UsdImagingLightFilterAdapter, UsdImagingMeshAdapter, UsdImagingBasisCurvesAdapter, UsdImagingCameraAdapter, UsdImagingPointsAdapter, UsdImagingMaterialAdapter, UsdImagingGprimAdapter, UsdImagingNurbsCurvesAdapter, UsdImagingHermiteCurvesAdapter, UsdImagingPointInstancerAdapter, UsdImagingNurbsPatchAdapter, UsdImagingSphereAdapter, UsdImagingCubeAdapter, UsdImagingCapsuleAdapter, UsdImagingConeAdapter, and UsdImagingCylinderAdapter.

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

virtual

Reimplemented in UsdSkelImagingSkeletonAdapter.

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

virtual

Sample the instancer transform for the given prim.

See Also: HdSceneDelegate::SampleInstancerTransform()

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

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 in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

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

virtual

Samples the transform for the given prim.

Reimplemented in UsdImagingInstanceAdapter, and UsdImagingPointInstancerAdapter.

USDIMAGING_API void UsdImagingPrimAdapter::SetDelegate ( UsdImagingDelegate * delegate )

A thread-local XformCache provided by the delegate.

virtual USDIMAGING_API bool UsdImagingPrimAdapter::ShouldCullChildren ( ) const

virtual

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 in UsdImagingInstanceAdapter, UsdImagingGLDrawModeAdapter, and UsdImagingPointInstancerAdapter.

static USDIMAGING_API bool UsdImagingPrimAdapter::ShouldCullSubtree ( UsdPrim const & prim )

static

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.

virtual USDIMAGING_API bool UsdImagingPrimAdapter::ShouldIgnoreNativeInstanceSubtrees ( ) const

virtual

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

virtual void UsdImagingPrimAdapter::TrackVariability	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		HdDirtyBits *	timeVaryingBits,
		UsdImagingInstancerContext const *	instancerContext = `nullptr`
	)		const

pure virtual

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.

Implemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdSkelImagingSkelRootAdapter, UsdImagingSphereAdapter, UsdImagingGLDrawModeAdapter, UsdImagingCubeAdapter, UsdImagingCapsuleAdapter, UsdImagingConeAdapter, UsdImagingCylinderAdapter, UsdImagingHermiteCurvesAdapter, UsdImagingLightAdapter, UsdImagingMeshAdapter, UsdImagingCameraAdapter, UsdImagingFieldAdapter, UsdImagingBasisCurvesAdapter, UsdImagingLightFilterAdapter, UsdImagingNurbsCurvesAdapter, UsdImagingPointsAdapter, UsdImagingNurbsPatchAdapter, UsdImagingGprimAdapter, UsdImagingCoordSysAdapter, UsdImagingMaterialAdapter, UsdImagingPointInstancerAdapter, and UsdImagingVolumeAdapter.

virtual void UsdImagingPrimAdapter::UpdateForTime	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time,
		HdDirtyBits	requestedBits,
		UsdImagingInstancerContext const *	instancerContext = `nullptr`
	)		const

pure virtual

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

This method is expected to be called from multiple threads.

Implemented in UsdImagingInstanceAdapter, UsdSkelImagingSkeletonAdapter, UsdSkelImagingSkelRootAdapter, UsdImagingGLDrawModeAdapter, UsdImagingLightAdapter, UsdImagingMeshAdapter, UsdImagingCameraAdapter, UsdImagingFieldAdapter, UsdImagingBasisCurvesAdapter, UsdImagingCoordSysAdapter, UsdImagingLightFilterAdapter, UsdImagingNurbsCurvesAdapter, UsdImagingPointsAdapter, UsdImagingGprimAdapter, UsdImagingMaterialAdapter, UsdImagingPointInstancerAdapter, and UsdImagingVolumeAdapter.

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

pxr/usdImaging/usdImaging/primAdapter.h

Public Member Functions

Initialization

Render Index Compatibility

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation