HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
UsdImagingPlaneAdapter Class Reference

#include <planeAdapter.h>

+ Inheritance diagram for UsdImagingPlaneAdapter:

Public Types

typedef UsdImagingGprimAdapter BaseAdapter
 
- Public Types inherited from UsdImagingGprimAdapter
using BaseAdapter = UsdImagingPrimAdapter
 
- Public Types inherited from UsdImagingPrimAdapter
enum  PopulationMode { RepresentsSelf, RepresentsSelfAndDescendents, RepresentedByAncestor }
 

Public Member Functions

 UsdImagingPlaneAdapter ()
 
virtual USDIMAGING_API ~UsdImagingPlaneAdapter ()
 
USDIMAGING_API SdfPath Populate (UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) 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 HdDirtyBits ProcessPropertyChange (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
 
Parallel Setup and Resolve
USDIMAGING_API void TrackVariability (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
 Thread Safe. More...
 
- Public Member Functions inherited from UsdImagingGprimAdapter
 UsdImagingGprimAdapter ()
 
USDIMAGING_API ~UsdImagingGprimAdapter () override
 
USDIMAGING_API
HdDataSourceLocatorSet 		InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType) override
 
USDIMAGING_API void UpdateForTime (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
 Thread Safe. More...
 
virtual USDIMAGING_API void MarkDirty (UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits dirty, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkRefineLevelDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkReprDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkCullStyleDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkRenderTagDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkTransformDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkVisibilityDirty (UsdPrim const &prim, SdfPath const &cachePath, UsdImagingIndexProxy *index) override
 
virtual USDIMAGING_API void MarkMaterialDirty (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 SdfPath _AddRprim (TfToken const &primType, UsdPrim const &usdPrim, UsdImagingIndexProxy *index, SdfPath const &materialUsdPath, UsdImagingInstancerContext const *instancerContext)
 
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 SdfPath GetMaterialId (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
 
USDIMAGING_API VtValue Get (UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const 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 ProcessPrimResync (SdfPath const &cachePath, UsdImagingIndexProxy *index)
 
virtual USDIMAGING_API void ProcessPrimRemoval (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
 
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 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 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 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
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
 

Data access

USDIMAGING_API VtValue GetTopology (UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
 
USDIMAGING_API VtValue GetPoints (UsdPrim const &prim, UsdTimeCode time) const override
 
static USDIMAGING_API VtValue GetMeshPoints (UsdPrim const &prim, UsdTimeCode time)
 
static USDIMAGING_API VtValue GetMeshTopology ()
 

Detailed Description

Delegate support for UsdGeomPlane.

Definition at line 42 of file planeAdapter.h.

Member Typedef Documentation

typedef UsdImagingGprimAdapter UsdImagingPlaneAdapter::BaseAdapter

Definition at line 44 of file planeAdapter.h.

Constructor & Destructor Documentation

UsdImagingPlaneAdapter::UsdImagingPlaneAdapter ( )
inline

Definition at line 46 of file planeAdapter.h.

virtual USDIMAGING_API UsdImagingPlaneAdapter::~UsdImagingPlaneAdapter ( )
virtual

Member Function Documentation

static USDIMAGING_API VtValue UsdImagingPlaneAdapter::GetMeshPoints ( UsdPrim const &  prim,
UsdTimeCode  time 
)
static
static USDIMAGING_API VtValue UsdImagingPlaneAdapter::GetMeshTopology ( )
static
USDIMAGING_API VtValue UsdImagingPlaneAdapter::GetPoints ( UsdPrim const &  prim,
UsdTimeCode  time 
) const
overridevirtual

Give derived classes an opportunity to override how we get points for a prim. This is useful for implicit primitives.

Reimplemented from UsdImagingGprimAdapter.

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

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

Reimplemented from UsdImagingPrimAdapter.

USDIMAGING_API SdfPath UsdImagingPlaneAdapter::Populate ( UsdPrim const &  prim,
UsdImagingIndexProxy *  index,
UsdImagingInstancerContext const *  instancerContext = nullptr 
)
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.

USDIMAGING_API HdDirtyBits UsdImagingPlaneAdapter::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.

Reimplemented from UsdImagingGprimAdapter.

USDIMAGING_API void UsdImagingPlaneAdapter::TrackVariability ( UsdPrim const &  prim,
SdfPath const &  cachePath,
HdDirtyBits *  timeVaryingBits,
UsdImagingInstancerContext const *  instancerContext = nullptr 
) const
overridevirtual

Thread Safe.

Reimplemented from UsdImagingGprimAdapter.

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