#include <instanceablePrimAdapter.h>

Inheritance diagram for UsdImagingInstanceablePrimAdapter:

Public Types
using	BaseAdapter = UsdImagingPrimAdapter

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

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

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

virtual void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index)=0
	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...

Friends
class	UsdImagingInstanceAdapter

class	UsdImagingPointInstancerAdapter

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

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

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)

virtual USDIMAGING_API void	MarkCollectionsDirty (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...

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

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

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

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

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

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

virtual USDIMAGING_API bool	IsChildPath (const SdfPath &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 HdModelDrawMode	GetFullModelDrawMode (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...

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

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

virtual USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim)

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

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

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

virtual USDIMAGING_API PopulationMode	GetPopulationMode ()

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

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

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

An abstract adapter class for prims that are instanceable. Adapters for instanceable prims should derive from this class instead of UsdImaginggPrimAdapter.

Definition at line 22 of file instanceablePrimAdapter.h.

Member Typedef Documentation

using UsdImagingInstanceablePrimAdapter::BaseAdapter = UsdImagingPrimAdapter

Definition at line 25 of file instanceablePrimAdapter.h.

Member Function Documentation

USDIMAGING_API SdfPath UsdImagingInstanceablePrimAdapter::ResolveCachePath	(	const SdfPath &	usdPath,
		const UsdImagingInstancerContext *	instancerContext = `nullptr`
	)		const

overrideprotectedvirtual

Returns whether custom shading of prims is enabled.

Reimplemented from UsdImagingPrimAdapter.

Reimplemented in UsdImagingPointInstancerAdapter.

USDIMAGING_API SdfPath UsdImagingInstanceablePrimAdapter::ResolveProxyPrimPath	(	const SdfPath &	cachePath,
		const UsdImagingInstancerContext *	instancerContext = `nullptr`
	)		const

protected

Friends And Related Function Documentation

friend class UsdImagingInstanceAdapter

friend

Definition at line 28 of file instanceablePrimAdapter.h.

friend class UsdImagingPointInstancerAdapter

friend

Definition at line 29 of file instanceablePrimAdapter.h.

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

pxr/usdImaging/usdImaging/instanceablePrimAdapter.h

Public Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation