HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdImagingPrimAdapter Class Referenceabstract

#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=NULL) const =0
 
virtual void UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) 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 MarkWindowPolicyDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index)
 
Computations
virtual USDIMAGING_API void InvokeComputation (SdfPath const &computationPath, 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 size_t SampleInstancerTransform (UsdPrim const &instancerPrim, SdfPath const &instancerPath, UsdTimeCode time, size_t maxNumSamples, float *sampleTimes, GfMatrix4d *sampleValues)
 
virtual USDIMAGING_API size_t SamplePrimvar (UsdPrim const &usdPrim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, size_t maxNumSamples, float *sampleTimes, VtValue *sampleValues)
 
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 bool PopulateSelection (HdSelection::HighlightMode const &highlightMode, SdfPath const &cachePath, UsdPrim const &usdPrim, int const hydraInstanceIndex, VtIntArray const &parentInstanceIndices, HdSelectionSharedPtr const &result) const
 
Texture resources
virtual USDIMAGING_API
HdTextureResource::ID 
GetTextureResourceID (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time, size_t salt) const
 
virtual USDIMAGING_API
HdTextureResourceSharedPtr 
GetTextureResource (UsdPrim const &usdPrim, SdfPath const &id, UsdTimeCode time) 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...
 
USDIMAGING_API bool GetVisible (UsdPrim const &prim, UsdTimeCode time) const
 
USDIMAGING_API TfToken GetPurpose (UsdPrim const &prim, UsdImagingInstancerContext const *instancerContext) const
 
USDIMAGING_API TfToken GetInheritablePurpose (UsdPrim const &prim) const
 
USDIMAGING_API GfMatrix4d GetTransform (UsdPrim const &prim, 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...
 
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
 

Initialization

 UsdImagingPrimAdapter ()
 
virtual USDIMAGING_API ~UsdImagingPrimAdapter ()
 
virtual SdfPath Populate (UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL)=0
 
virtual USDIMAGING_API bool ShouldCullChildren () const
 
virtual USDIMAGING_API bool IsInstancerAdapter () const
 
virtual USDIMAGING_API bool CanPopulateMaster () const
 
static USDIMAGING_API bool ShouldCullSubtree (UsdPrim const &prim)
 

Render Index Compatibility

typedef UsdImagingValueCache::Key Keys
 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
UsdImagingValueCache
_GetValueCache () 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 TfToken _GetMaterialNetworkSelector () 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()) 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, SdfPath const &cachePath, UsdGeomPrimvar const &primvar, UsdTimeCode time, UsdImagingValueCache *valueCache, 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
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 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 66 of file primAdapter.h.

Member Typedef Documentation

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

Definition at line 432 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,
SdfPath const cachePath,
UsdGeomPrimvar const primvar,
UsdTimeCode  time,
UsdImagingValueCache valueCache,
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 435 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 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 TfToken UsdImagingPrimAdapter::_GetMaterialNetworkSelector ( ) 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.

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

USDIMAGING_API UsdImagingValueCache* UsdImagingPrimAdapter::_GetValueCache ( ) 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() 
) 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.

USDIMAGING_API void UsdImagingPrimAdapter::_RemovePrimvar ( HdPrimvarDescriptorVector vec,
TfToken const name 
) const
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::CanPopulateMaster ( ) 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.

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.

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.

USDIMAGING_API TfToken UsdImagingPrimAdapter::GetPurpose ( UsdPrim const prim,
UsdImagingInstancerContext const instancerContext 
) const

Returns the purpose token for prim. If an instancerContext is provided and the prim doesn't have an explicitly authored or inherited purpose, it may inherit the instancerContext's purpose if the instance has an explicit purpose.

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
virtual USDIMAGING_API PxOsdSubdivTags UsdImagingPrimAdapter::GetSubdivTags ( UsdPrim const usdPrim,
SdfPath const cachePath,
UsdTimeCode  time 
) const
virtual
virtual USDIMAGING_API HdTextureResourceSharedPtr UsdImagingPrimAdapter::GetTextureResource ( UsdPrim const usdPrim,
SdfPath const id,
UsdTimeCode  time 
) const
virtual
virtual USDIMAGING_API HdTextureResource::ID UsdImagingPrimAdapter::GetTextureResourceID ( UsdPrim const usdPrim,
SdfPath const id,
UsdTimeCode  time,
size_t  salt 
) const
virtual
USDIMAGING_API GfMatrix4d UsdImagingPrimAdapter::GetTransform ( UsdPrim const prim,
UsdTimeCode  time,
bool  ignoreRootTransform = false 
) const

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.

USDIMAGING_API bool UsdImagingPrimAdapter::GetVisible ( UsdPrim const prim,
UsdTimeCode  time 
) const

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

virtual USDIMAGING_API HdVolumeFieldDescriptorVector UsdImagingPrimAdapter::GetVolumeFieldDescriptors ( UsdPrim const usdPrim,
SdfPath const id,
UsdTimeCode  time 
) const
virtual
virtual USDIMAGING_API void UsdImagingPrimAdapter::InvokeComputation ( SdfPath const computationPath,
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 UsdImagingPointInstancerAdapter, and UsdImagingInstanceAdapter.

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

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

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

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

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

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

Sample the primvar for the given prim.

See Also
HdSceneDelegate::SamplePrimvar()

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

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.


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