#include <drawModeAdapter.h>

Inheritance diagram for UsdImagingDrawModeAdapter:

Public Types
using	BaseAdapter = UsdImagingPrimAdapter

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

Public Member Functions
USDIMAGING_API	UsdImagingDrawModeAdapter ()

USDIMAGING_API	~UsdImagingDrawModeAdapter () override

SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy index, UsdImagingInstancerContext const instancerContext=NULL) override

bool	ShouldCullChildren () const override

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

bool	CanPopulateUsdInstance () const override

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

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

Change Processing
USDIMAGING_API HdDirtyBits	ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &property) 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	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	MarkMaterialDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override

Public Member Functions inherited from UsdImagingPrimAdapter
	UsdImagingPrimAdapter ()

virtual USDIMAGING_API	~UsdImagingPrimAdapter ()

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

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

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

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 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 USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim)

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

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

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

virtual USDIMAGING_API PopulationMode	GetPopulationMode ()

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

virtual USDIMAGING_API bool	ShouldIgnoreNativeInstanceSubtrees () const

virtual USDIMAGING_API bool	IsInstancerAdapter () const

Data access
USDIMAGING_API VtValue	Get (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) 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 VtValue	GetTopology (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override

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

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

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

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

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

USDIMAGING_API void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index) override
	Provides to paramName->UsdAttribute value mappings. More...

Detailed Description

Delegate support for the drawMode attribute on UsdGeomModelAPI.

Definition at line 38 of file drawModeAdapter.h.

Member Typedef Documentation

using UsdImagingDrawModeAdapter::BaseAdapter = UsdImagingPrimAdapter

Definition at line 41 of file drawModeAdapter.h.

Constructor & Destructor Documentation

USDIMAGING_API UsdImagingDrawModeAdapter::UsdImagingDrawModeAdapter ( )

USDIMAGING_API UsdImagingDrawModeAdapter::~UsdImagingDrawModeAdapter ( )

override

Member Function Documentation

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

overrideprotectedvirtual

Provides to paramName->UsdAttribute value mappings.

Implements UsdImagingPrimAdapter.

bool UsdImagingDrawModeAdapter::CanPopulateUsdInstance ( ) 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 VtValue UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::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 bool UsdImagingDrawModeAdapter::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 GfRange3d UsdImagingDrawModeAdapter::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 SdfPath UsdImagingDrawModeAdapter::GetMaterialId	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time
	)		const

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

The root transform provided by the delegate.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API VtValue UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::IsSupported ( UsdImagingIndexProxy const * index ) const

overridevirtual

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

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API void UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::MarkMaterialDirty	(	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 UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::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.

SdfPath UsdImagingDrawModeAdapter::Populate	(	UsdPrim const &	prim,
		UsdImagingIndexProxy *	index,
		UsdImagingInstancerContext const *	instancerContext = `NULL`
	)

overridevirtual

Called to populate the RenderIndex for this UsdPrim. The adapter is expected to create one or more Rprims in the render index using the given proxy.

Implements UsdImagingPrimAdapter.

USDIMAGING_API void UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::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.

bool UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::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 UsdImagingDrawModeAdapter::UpdateForTime	(	UsdPrim const &	prim,
		SdfPath const &	cachePath,
		UsdTimeCode	time,
		HdDirtyBits	requestedBits,
		UsdImagingInstancerContext const *	instancerContext = `NULL`
	)		const

overridevirtual

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

This method is expected to be called from multiple threads.

Implements UsdImagingPrimAdapter.

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

pxr/usdImaging/usdImaging/drawModeAdapter.h

Public Types

Public Member Functions

Data access

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation