UsdImagingGLDrawModeAdapter Class Reference

Delegate support for the drawMode attribute on UsdGeomModelAPI. More...

Inheritance diagram for UsdImagingGLDrawModeAdapter:

Public Types
using	BaseAdapter = UsdImagingPrimAdapter

Public Member Functions
SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
	Called to populate the RenderIndex for this UsdPrim. More...
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
USDIMAGINGGL_API void	TrackVariability (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
	For the given prim, variability is detected and stored in timeVaryingBits. More...
USDIMAGINGGL_API void	UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
	Populates the cache for the given prim, time and requestedBits. More...
Change Processing
USDIMAGINGGL_API HdDirtyBits	ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &property) override
	Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized. More...
USDIMAGINGGL_API void	MarkDirty (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index) override
USDIMAGINGGL_API void	MarkTransformDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
USDIMAGINGGL_API void	MarkVisibilityDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
USDIMAGINGGL_API void	MarkMaterialDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
Public Member Functions inherited from UsdImagingPrimAdapter
virtual USDIMAGING_API HdDirtyBits	ProcessPrimChange (UsdPrim const &prim, SdfPath const &cachePath, TfTokenVector const &changedFields)
	Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must be resynchronized. More...
virtual USDIMAGING_API void	ProcessPrimResync (SdfPath const &cachePath, UsdImagingIndexProxy *index)
	When a PrimResync event occurs, the prim may have been deleted entirely, adapter plug-ins should override this method to free any per-prim state that was accumulated in the adapter. More...
virtual USDIMAGING_API void	ProcessPrimRemoval (SdfPath const &cachePath, UsdImagingIndexProxy *index)
	Removes all associated Rprims and dependencies from the render index without scheduling them for repopulation. More...
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	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
	Get the instancer transform for the given prim. More...
virtual USDIMAGING_API size_t	SampleInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time, size_t maxNumSamples, float *sampleTimes, GfMatrix4d *sampleValues)
	Sample the instancer transform for the given prim. More...
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)
	Sample the primvar for the given prim. More...
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
	Returns the transform of protoInstancerPath relative to instancerPath. More...
virtual USDIMAGING_API SdfPath	GetScenePrimPath (SdfPath const &cachePath, int instanceIndex, HdInstancerContext *instancerCtx) 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
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
virtual USDIMAGING_API bool	GetVisible (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const
	Returns true if the given prim is visible, taking into account inherited visibility values. More...
virtual USDIMAGING_API TfToken	GetPurpose (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &instanceInheritablePurpose) const
	Returns the purpose token for prim. More...
USDIMAGING_API TfToken	GetInheritablePurpose (UsdPrim const &prim) const
	Returns the purpose token for prim, but only if it is inheritable by child prims (i.e. More...
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
	Gets the material path for the given prim, walking up namespace if necessary. More...
USDIMAGING_API TfToken	GetModelDrawMode (UsdPrim const &prim)
	Gets the model:drawMode attribute for the given prim, walking up the namespace if necessary. More...
USDIMAGING_API VtArray < VtIntArray >	GetPerPrototypeIndices (UsdPrim const &prim, UsdTimeCode time) const
	Computes the per-prototype instance indices for a UsdGeomPointInstancer. More...
virtual USDIMAGING_API 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
	UsdImagingPrimAdapter ()
virtual USDIMAGING_API	~UsdImagingPrimAdapter ()
virtual USDIMAGING_API bool	ShouldIgnoreNativeInstanceSubtrees () const
virtual USDIMAGING_API bool	IsInstancerAdapter () const

Data access
USDIMAGINGGL_API VtValue	Get (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
	Gets the value of the parameter named key for the given prim (which has the given cache path) and given time. More...
USDIMAGINGGL_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...
USDIMAGINGGL_API VtValue	GetTopology (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	Gets the topology object of a specific Usd prim. More...
USDIMAGINGGL_API GfRange3d	GetExtent (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
	Reads the extent from the given prim. More...
USDIMAGINGGL_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...
USDIMAGINGGL_API GfMatrix4d	GetTransform (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, bool ignoreRootTransform=false) const override
	Fetches the transform for the given prim at the given time from a pre-computed cache of prim transforms. More...
USDIMAGINGGL_API SdfPath	GetMaterialId (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
USDIMAGING_API VtValue	GetMaterialResource (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
USDIMAGINGGL_API void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index) override

Detailed Description

Delegate support for the drawMode attribute on UsdGeomModelAPI.

Definition at line 38 of file drawModeAdapter.h.

Member Function Documentation

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

overridevirtual

Gets the value of the parameter named key for the given prim (which has the given cache path) and given time.

If outIndices is not nullptr and the value has indices, it will return the unflattened value and set outIndices to the value's associated indices.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGINGGL_API HdCullStyle GetCullStyle ( UsdPrim const &  prim, SdfPath const &  cachePath, UsdTimeCode  time  ) const

overridevirtual

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

Reimplemented from UsdImagingPrimAdapter.

USDIMAGINGGL_API bool GetDoubleSided ( UsdPrim const &  prim, SdfPath const &  cachePath, UsdTimeCode  time  ) const

overridevirtual

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

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Reads the extent from the given prim.

If the extent is not authored, an empty GfRange3d is returned, the extent will not be computed.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Gets the topology object of a specific Usd prim.

If the adapter is a mesh it will return an HdMeshTopology, if it is of type basis curves, it will return an HdBasisCurvesTopology. If the adapter does not have a topology, it returns an empty VtValue.

Reimplemented from UsdImagingPrimAdapter.

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

overridevirtual

Fetches the transform for the given prim at the given time from a pre-computed cache of prim transforms.

Requesting transforms at incoherent times is currently inefficient.

Reimplemented from UsdImagingPrimAdapter.

bool IsSupported ( UsdImagingIndexProxy const *  index ) const

overridevirtual

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

Reimplemented from UsdImagingPrimAdapter.

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

USDIMAGINGGL_API HdDirtyBits ProcessPropertyChange ( UsdPrim const &  prim, SdfPath const &  cachePath, TfToken const &  propertyName  )

overridevirtual

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

Implements UsdImagingPrimAdapter.

USDIMAGINGGL_API void TrackVariability ( UsdPrim const &  prim, SdfPath const &  cachePath, HdDirtyBits *  timeVaryingBits, UsdImagingInstancerContext const *  instancerContext = NULL  ) const

overridevirtual

For the given prim, variability is detected and stored in timeVaryingBits.

Initial values are cached into the value cache.

This method is expected to be called from multiple threads.

Implements UsdImagingPrimAdapter.

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

overridevirtual

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

This method is expected to be called from multiple threads.

Implements UsdImagingPrimAdapter.

---

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

• pxr/usdImaging/usdImagingGL/drawModeAdapter.h