UsdImagingDistantLightAdapter Class Reference

#include <distantLightAdapter.h>

Inheritance diagram for UsdImagingDistantLightAdapter:

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

Public Member Functions
	UsdImagingDistantLightAdapter ()
virtual USDIMAGING_API	~UsdImagingDistantLightAdapter ()
Public Member Functions inherited from UsdImagingLightAdapter
	UsdImagingLightAdapter ()
USDIMAGING_API	~UsdImagingLightAdapter () override
USDIMAGING_API HdContainerDataSourceHandle	GetImagingSubprimData (UsdPrim const &prim, TfToken const &subprim, const UsdImagingDataSourceStageGlobals &stageGlobals) override
USDIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) override
USDIMAGING_API SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
USDIMAGING_API bool	IsSupported (UsdImagingIndexProxy const *index) const override
	Returns true if the adapter can be populated into the target index. More...
USDIMAGING_API void	TrackVariability (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
	Thread Safe. More...
USDIMAGING_API void	UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=NULL) const override
	Thread Safe. More...
USDIMAGING_API HdDirtyBits	ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) 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	MarkLightParamsDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
virtual USDIMAGING_API void	MarkCollectionsDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
USDIMAGING_API VtValue	GetMaterialResource (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
USDIMAGING_API SdfPath	_AddSprim (const TfToken &primType, const UsdPrim &usdPrim, UsdImagingIndexProxy *index, const UsdImagingInstancerContext *instancerContext=nullptr)
USDIMAGING_API void	_RemoveSprim (const TfToken &primType, const SdfPath &cachePath, UsdImagingIndexProxy *index)
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	ProcessPrimResync (SdfPath const &cachePath, UsdImagingIndexProxy *index)
virtual USDIMAGING_API void	ProcessPrimRemoval (SdfPath const &cachePath, UsdImagingIndexProxy *index)
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	MarkMaterialDirty (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
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 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 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 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	ShouldCullChildren () const
virtual USDIMAGING_API bool	ShouldIgnoreNativeInstanceSubtrees () const
virtual USDIMAGING_API bool	IsInstancerAdapter () const
virtual USDIMAGING_API bool	CanPopulateUsdInstance () const

Scene Index Support
USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim) override
USDIMAGING_API TfToken	GetImagingSubprimType (UsdPrim const &prim, TfToken const &subprim) override
USDIMAGING_API SdfPath	Populate (UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=NULL) override
USDIMAGING_API bool	IsSupported (UsdImagingIndexProxy const *index) const override
	Returns true if the adapter can be populated into the target index. More...
virtual void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index) final
	Provides to paramName->UsdAttribute value mappings. More...

Additional Inherited Members
Static Public Member Functions inherited from UsdImagingLightAdapter
static USDIMAGING_API bool	IsEnabledSceneLights ()
static USDIMAGING_API SdfPath	_ResolveCachePath (const SdfPath &usdPath, const UsdImagingInstancerContext *instancerContext)
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
	Provides to paramName->UsdAttribute value mappings. More...
Protected Member Functions inherited from UsdImagingLightAdapter
void	_RemovePrim (SdfPath const &cachePath, UsdImagingIndexProxy *index) override
void	_UnregisterLightCollections (SdfPath const &cachePath)
void	_RegisterLightCollections (UsdPrim const &prim)
Protected Member Functions inherited from UsdImagingPrimAdapter
template<typename T >
T	_Get (UsdPrim const &prim, TfToken const &attrToken, UsdTimeCode time) const
	Provides to paramName->UsdAttribute value mappings. More...
template<typename T >
void	_GetPtr (UsdPrim const &prim, TfToken const &key, UsdTimeCode time, T *out) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdImagingPrimvarDescCache *	_GetPrimvarDescCache () const
	Provides to paramName->UsdAttribute value mappings. More...
UsdImaging_NonlinearSampleCountCache *	_GetNonlinearSampleCountCache () const
	Provides to paramName->UsdAttribute value mappings. More...
UsdImaging_BlurScaleCache *	_GetBlurScaleCache () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdPrim	_GetPrim (SdfPath const &usdPath) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API const UsdImagingPrimAdapterSharedPtr &	_GetPrimAdapter (UsdPrim const &prim, bool ignoreInstancing=false) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API const UsdImagingPrimAdapterSharedPtr &	_GetAdapter (TfToken const &adapterKey) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API SdfPath	_GetPrimPathFromInstancerChain (SdfPathVector const &instancerChain) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdTimeCode	_GetTimeWithOffset (float offset) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API SdfPath	_ConvertCachePathToIndexPath (SdfPath const &cachePath) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API SdfPath	_ConvertIndexPathToCachePath (SdfPath const &indexPath) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API TfToken	_GetMaterialBindingPurpose () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API TfTokenVector	_GetMaterialRenderContexts () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API TfTokenVector	_GetRenderSettingsNamespaces () const
	Provides to paramName->UsdAttribute value mappings. 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
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API TfTokenVector	_GetShaderSourceTypes () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API bool	_IsInInvisedPaths (SdfPath const &usdPath) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API bool	_IsVarying (UsdPrim prim, TfToken const &attrName, HdDirtyBits dirtyFlag, TfToken const &perfToken, HdDirtyBits *dirtyFlags, bool isInherited, bool *exists=nullptr) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API bool	_IsTransformVarying (UsdPrim prim, HdDirtyBits dirtyFlag, TfToken const &perfToken, HdDirtyBits *dirtyFlags) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API void	_MergePrimvar (HdPrimvarDescriptorVector *vec, TfToken const &name, HdInterpolation interp, TfToken const &role=TfToken(), bool indexed=false) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API void	_RemovePrimvar (HdPrimvarDescriptorVector *vec, TfToken const &name) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API void	_ComputeAndMergePrimvar (UsdPrim const &prim, UsdGeomPrimvar const &primvar, UsdTimeCode time, HdPrimvarDescriptorVector *primvarDescs, HdInterpolation *interpOverride=nullptr) const
	Provides to paramName->UsdAttribute value mappings. 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
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API HdDirtyBits	_ProcessPrefixedPrimvarPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName, HdDirtyBits valueChangeDirtyBit=HdChangeTracker::DirtyPrimvar, bool inherited=true) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API void	_ResyncDependents (SdfPath const &usdPath, UsdImagingIndexProxy *index)
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdImaging_CollectionCache &	_GetCollectionCache () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdStageRefPtr	_GetStage () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdImaging_CoordSysBindingStrategy::value_type	_GetCoordSysBindings (UsdPrim const &prim) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdImaging_InheritedPrimvarStrategy::value_type	_GetInheritedPrimvars (UsdPrim const &prim) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API UsdGeomPrimvar	_GetInheritedPrimvar (UsdPrim const &prim, TfToken const &primvarName) const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API GfInterval	_GetCurrentTimeSamplingInterval ()
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API Usd_PrimFlagsConjunction	_GetDisplayPredicate () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API Usd_PrimFlagsConjunction	_GetDisplayPredicateForPrototypes () const
	Provides to paramName->UsdAttribute value mappings. More...
USDIMAGING_API bool	_DoesDelegateSupportCoordSys () const
	Provides to paramName->UsdAttribute value mappings. More...
Static Protected Member Functions inherited from UsdImagingPrimAdapter
static USDIMAGING_API bool	_HasPrimvarsPrefix (TfToken const &propertyName)
	Provides to paramName->UsdAttribute value mappings. More...

Detailed Description

Adapter class for lights of type DistantLight

Definition at line 42 of file distantLightAdapter.h.

Member Typedef Documentation

typedef UsdImagingLightAdapter UsdImagingDistantLightAdapter::BaseAdapter

Definition at line 44 of file distantLightAdapter.h.

Constructor & Destructor Documentation

UsdImagingDistantLightAdapter::UsdImagingDistantLightAdapter ( )

inline

Definition at line 46 of file distantLightAdapter.h.

virtual USDIMAGING_API UsdImagingDistantLightAdapter::~UsdImagingDistantLightAdapter ( )

virtual

Member Function Documentation

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

finalprotectedvirtual

Provides to paramName->UsdAttribute value mappings.

Implements UsdImagingPrimAdapter.

USDIMAGING_API TfTokenVector UsdImagingDistantLightAdapter::GetImagingSubprims ( UsdPrim const &  prim )

overridevirtual

Returns the prim's behavior with regard to population and invalidation. See PopulationMode for possible values.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API TfToken UsdImagingDistantLightAdapter::GetImagingSubprimType ( UsdPrim const &  prim, TfToken const &  subprim  )

overridevirtual

Returns the prim's behavior with regard to population and invalidation. See PopulationMode for possible values.

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API bool UsdImagingDistantLightAdapter::IsSupported ( UsdImagingIndexProxy const *  index ) const

overridevirtual

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

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPath UsdImagingDistantLightAdapter::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 prims in the render index using the given proxy.

Implements UsdImagingPrimAdapter.

---

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

• pxr/usdImaging/usdImaging/distantLightAdapter.h