HdUnitTestDelegate Class Reference

A simple delegate class for unit test driver. More...

+ Inheritance diagram for HdUnitTestDelegate:

Public Member Functions

HD_API HdUnitTestDelegate (HdRenderIndex *parentIndex, SdfPath const &delegateID)
 
void SetUseInstancePrimvars (bool v)
 
HD_API void SetRefineLevel (int level)
 
HD_API void SetVisibility (bool vis)
 
HD_API void AddMesh (SdfPath const &id)
 
HD_API void AddMesh (SdfPath const &id, GfMatrix4f const &transform, VtVec3fArray const &points, VtIntArray const &numVerts, VtIntArray const &verts, bool guide=false, SdfPath const &instancerId=SdfPath(), TfToken const &scheme=PxOsdOpenSubdivTokens->catmullClark, TfToken const &orientation=HdTokens->rightHanded, bool doubleSided=false)
 
HD_API void AddMesh (SdfPath const &id, GfMatrix4f const &transform, VtVec3fArray const &points, VtIntArray const &numVerts, VtIntArray const &verts, VtIntArray const &holes, PxOsdSubdivTags const &subdivTags, VtValue const &color, HdInterpolation colorInterpolation, VtValue const &opacity, HdInterpolation opacityInterpolation, bool guide=false, SdfPath const &instancerId=SdfPath(), TfToken const &scheme=PxOsdOpenSubdivTokens->catmullClark, TfToken const &orientation=HdTokens->rightHanded, bool doubleSided=false)
 
HD_API void AddMesh (SdfPath const &id, GfMatrix4f const &transform, VtVec3fArray const &points, VtIntArray const &numVerts, VtIntArray const &verts, VtIntArray const &holes, PxOsdSubdivTags const &subdivTags, VtValue const &color, VtIntArray const &colorIndices, HdInterpolation colorInterpolation, VtValue const &opacity, VtIntArray const &opacityIndices, HdInterpolation opacityInterpolation, bool guide=false, SdfPath const &instancerId=SdfPath(), TfToken const &scheme=PxOsdOpenSubdivTokens->catmullClark, TfToken const &orientation=HdTokens->rightHanded, bool doubleSided=false)
 
HD_API void AddCube (SdfPath const &id, GfMatrix4f const &transform, bool guide=false, SdfPath const &instancerId=SdfPath(), TfToken const &scheme=PxOsdOpenSubdivTokens->catmullClark)
 Add a cube. More...
 
HD_API void AddGrid (SdfPath const &id, int x, int y, GfMatrix4f const &transform, bool rightHanded=true, bool doubleSided=false, SdfPath const &instancerId=SdfPath())
 Add a grid with division x*y. More...
 
HD_API void AddGridWithFaceColor (SdfPath const &id, int x, int y, GfMatrix4f const &transform, bool rightHanded=true, bool doubleSided=false, SdfPath const &instancerId=SdfPath())
 Add a grid with division x*y. More...
 
HD_API void AddGridWithVertexColor (SdfPath const &id, int x, int y, GfMatrix4f const &transform, bool rightHanded=true, bool doubleSided=false, SdfPath const &instancerId=SdfPath())
 Add a grid with division x*y. More...
 
HD_API void AddGridWithFaceVaryingColor (SdfPath const &id, int x, int y, GfMatrix4f const &transform, bool rightHanded=true, bool doubleSided=false, SdfPath const &instancerId=SdfPath())
 Add a grid with division x*y. More...
 
HD_API void AddGridWithCustomColor (SdfPath const &id, int nx, int ny, GfMatrix4f const &transform, VtValue const &color, HdInterpolation colorInterpolation, bool rightHanded=true, bool doubleSided=false, SdfPath const &instancerId=SdfPath())
 
HD_API void AddPolygons (SdfPath const &id, GfMatrix4f const &transform, HdInterpolation colorInterp, SdfPath const &instancerId=SdfPath())
 Add a triangle, quad and pentagon. More...
 
HD_API void AddFaceVaryingPolygons (SdfPath const &id, GfMatrix4f const &transform, SdfPath const &instancerId=SdfPath())
 Add a triangle, quad and pentagon with face-varying displayColor and displayOpacity. More...
 
HD_API void AddSubdiv (SdfPath const &id, GfMatrix4f const &transform, SdfPath const &insatancerId=SdfPath())
 Add a subdiv with various tags. More...
 
HD_API void AddBasisCurves (SdfPath const &id, VtVec3fArray const &points, VtIntArray const &curveVertexCounts, VtIntArray const &curveIndices, VtVec3fArray const &normals, TfToken const &type, TfToken const &basis, VtValue const &color, HdInterpolation colorInterpolation, VtValue const &opacity, HdInterpolation opacityInterpolation, VtValue const &width, HdInterpolation widthInterpolation, SdfPath const &instancerId=SdfPath())
 
HD_API void AddCurves (SdfPath const &id, TfToken const &type, TfToken const &basis, GfMatrix4f const &transform, HdInterpolation colorInterp=HdInterpolationConstant, HdInterpolation widthInterp=HdInterpolationConstant, bool authoredNormals=false, SdfPath const &instancerId=SdfPath())
 Add a basis curves prim containing two curves. More...
 
HD_API void SetCurveWrapMode (SdfPath const &id, TfToken const &wrap)
 
HD_API void AddPoints (SdfPath const &id, VtVec3fArray const &points, VtValue const &color, HdInterpolation colorInterpolation, VtValue const &opacity, HdInterpolation opacityInterpolation, VtValue const &width, HdInterpolation widthInterpolation, SdfPath const &instancerId=SdfPath())
 
HD_API void AddPoints (SdfPath const &id, GfMatrix4f const &transform, HdInterpolation colorInterp=HdInterpolationConstant, HdInterpolation widthInterp=HdInterpolationConstant, SdfPath const &instancerId=SdfPath())
 Add a points prim. More...
 
HD_API void AddInstancer (SdfPath const &id, SdfPath const &parentId=SdfPath(), GfMatrix4f const &rootTransform=GfMatrix4f(1))
 Instancer. More...
 
HD_API void SetInstancerProperties (SdfPath const &id, VtIntArray const &prototypeIndex, VtVec3fArray const &scale, VtVec4fArray const &rotate, VtVec3fArray const &translate)
 
HD_API void UpdateInstancer (SdfPath const &rprimId, SdfPath const &instancerId)
 
HD_API void AddPrimvar (SdfPath const &id, TfToken const &name, VtValue const &value, HdInterpolation const &interp, TfToken const &role, VtIntArray const &indices=VtIntArray(0))
 Primvars. More...
 
HD_API void UpdatePrimvarValue (SdfPath const &id, TfToken const &name, VtValue const &value, VtIntArray const &indices=VtIntArray(0))
 
HD_API void RemovePrimvar (SdfPath const &id, TfToken const &name)
 
HD_API void UpdateTransform (SdfPath const &id, GfMatrix4f const &mat)
 Transform. More...
 
HD_API void AddMaterialResource (SdfPath const &id, VtValue materialResource)
 Material. More...
 
HD_API void UpdateMaterialResource (SdfPath const &materialId, VtValue materialResource)
 Update a material resource. More...
 
HD_API void BindMaterial (SdfPath const &rprimId, SdfPath const &materialId)
 
HD_API void RebindMaterial (SdfPath const &rprimId, SdfPath const &materialId)
 Example to update a material binding on the fly. More...
 
HD_API void AddRenderBuffer (SdfPath const &id, HdRenderBufferDescriptor const &desc)
 Render buffers. More...
 
HD_API void UpdateRenderBuffer (SdfPath const &id, HdRenderBufferDescriptor const &desc)
 
HD_API void AddCamera (SdfPath const &id)
 Camera. More...
 
HD_API void UpdateCamera (SdfPath const &id, TfToken const &key, VtValue value)
 
template<typename T >
void AddTask (SdfPath const &id)
 Tasks. More...
 
HD_API void UpdateTask (SdfPath const &id, TfToken const &key, VtValue value)
 
HD_API void Remove (SdfPath const &id)
 Remove a prim. More...
 
HD_API void Clear ()
 Clear all prims. More...
 
HD_API void HideRprim (SdfPath const &id)
 
HD_API void UnhideRprim (SdfPath const &id)
 
HD_API void SetReprSelector (SdfPath const &id, HdReprSelector const &reprSelector)
 
HD_API void SetRefineLevel (SdfPath const &id, int refineLevel)
 
HD_API void SetVisibility (SdfPath const &id, bool vis)
 
HD_API void MarkRprimDirty (SdfPath path, HdDirtyBits flag)
 Marks an rprim in the RenderIndex as dirty with the given dirty flags. More...
 
HD_API void UpdatePositions (SdfPath const &id, float time)
 
HD_API void UpdateRprims (float time)
 
HD_API void UpdateInstancerPrimvars (float time)
 
HD_API void UpdateInstancerPrototypes (float time)
 
HD_API void UpdateCurvePrimvarsInterpMode (float time)
 
HD_API GfVec3f PopulateBasicTestSet ()
 
HD_API GfVec3f PopulateInvalidPrimsSet ()
 
virtual HD_API HdMeshTopology GetMeshTopology (SdfPath const &id) override
 Gets the topological mesh data for a given prim. More...
 
virtual HD_API HdBasisCurvesTopology GetBasisCurvesTopology (SdfPath const &id) override
 Gets the topological curve data for a given prim. More...
 
virtual HD_API TfToken GetRenderTag (SdfPath const &id) override
 Returns the render tag that will be used to bucket prims during render pass bucketing. More...
 
virtual HD_API TfTokenVector GetTaskRenderTags (SdfPath const &taskId) override
 
virtual HD_API PxOsdSubdivTags GetSubdivTags (SdfPath const &id) override
 Gets the subdivision surface tags (sharpness, holes, etc). More...
 
virtual HD_API GfRange3d GetExtent (SdfPath const &id) override
 Gets the axis aligned bounds of a prim. More...
 
virtual HD_API GfMatrix4d GetTransform (SdfPath const &id) override
 Returns the object space transform, including all parent transforms. More...
 
virtual HD_API bool GetVisible (SdfPath const &id) override
 Returns the authored visible state of the prim. More...
 
virtual HD_API bool GetDoubleSided (SdfPath const &id) override
 Returns the doubleSided state for the given prim. More...
 
virtual HD_API HdDisplayStyle GetDisplayStyle (SdfPath const &id) override
 Returns the refinement level for the given prim in the range [0,8]. More...
 
virtual HD_API VtValue Get (SdfPath const &id, TfToken const &key) override
 Returns a named value. More...
 
virtual HD_API VtValue GetIndexedPrimvar (SdfPath const &id, TfToken const &key, VtIntArray *outIndices) override
 Returns a named primvar value. More...
 
virtual HD_API HdReprSelector GetReprSelector (SdfPath const &id) override
 Returns the authored repr (if any) for the given prim. More...
 
virtual HD_API HdPrimvarDescriptorVector GetPrimvarDescriptors (SdfPath const &id, HdInterpolation interpolation) override
 Returns descriptors for all primvars of the given interpolation type. More...
 
virtual HD_API VtIntArray GetInstanceIndices (SdfPath const &instancerId, SdfPath const &prototypeId) override
 Gets the extracted indices array of the prototype id used in the instancer. More...
 
virtual HD_API SdfPathVector GetInstancerPrototypes (SdfPath const &instancerId) override
 Returns a list of prototypes of this instancer. More...
 
virtual HD_API GfMatrix4d GetInstancerTransform (SdfPath const &instancerId) override
 Returns the instancer transform. More...
 
virtual HD_API SdfPath GetMaterialId (SdfPath const &rprimId) override
 Returns the material ID bound to the rprim rprimId. More...
 
virtual HD_API SdfPath GetInstancerId (SdfPath const &primId) override
 Returns the parent instancer of the given rprim or instancer. More...
 
virtual HD_API VtValue GetMaterialResource (SdfPath const &materialId) override
 
virtual HD_API VtValue GetCameraParamValue (SdfPath const &cameraId, TfToken const &paramName) override
 Returns a single value for a given camera and parameter. More...
 
virtual HD_API HdRenderBufferDescriptor GetRenderBufferDescriptor (SdfPath const &id) override
 Returns the allocation descriptor for a given render buffer prim. More...
 
- Public Member Functions inherited from HdSceneDelegate
HD_API HdSceneDelegate (HdRenderIndex *parentIndex, SdfPath const &delegateID)
 Constructor used for nested delegate objects which share a RenderIndex. More...
 
HdRenderIndexGetRenderIndex ()
 Returns the RenderIndex owned by this delegate. More...
 
SdfPath const & GetDelegateID () const
 Returns the ID of this delegate, which is used as a prefix for all objects it creates in the RenderIndex. More...
 
virtual HD_API void Sync (HdSyncRequestVector *request)
 Synchronizes the delegate state for the given request vector. More...
 
virtual HD_API void PostSyncCleanup ()
 Opportunity for the delegate to clean itself up after performing parallel work during sync phase. More...
 
virtual HD_API bool IsEnabled (TfToken const &option) const
 Returns true if the named option is enabled by the delegate. More...
 
virtual HD_API HdCullStyle GetCullStyle (SdfPath const &id)
 Returns the cullstyle for the given prim. More...
 
virtual HD_API VtValue GetShadingStyle (SdfPath const &id)
 Returns the shading style for the given prim. More...
 
virtual HD_API VtArray< TfTokenGetCategories (SdfPath const &id)
 Returns the prim categories. More...
 
virtual HD_API std::vector< VtArray< TfToken > > GetInstanceCategories (SdfPath const &instancerId)
 Returns the categories for all instances in the instancer. More...
 
virtual HD_API HdIdVectorSharedPtr GetCoordSysBindings (SdfPath const &id)
 Returns the coordinate system bindings, or a nullptr if none are bound. More...
 
virtual HD_API size_t SampleTransform (SdfPath const &id, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
 Store up to maxSampleCount transform samples in *sampleValues. More...
 
template<unsigned int CAPACITY>
void SampleTransform (SdfPath const &id, HdTimeSampleArray< GfMatrix4d, CAPACITY > *sa)
 Convenience form of SampleTransform() that takes an HdTimeSampleArray. More...
 
virtual HD_API size_t SampleInstancerTransform (SdfPath const &instancerId, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
 Store up to maxSampleCount transform samples in *sampleValues. More...
 
template<unsigned int CAPACITY>
void SampleInstancerTransform (SdfPath const &instancerId, HdTimeSampleArray< GfMatrix4d, CAPACITY > *sa)
 Convenience form of SampleInstancerTransform() that takes an HdTimeSampleArray. More...
 
virtual HD_API size_t SamplePrimvar (SdfPath const &id, TfToken const &key, size_t maxSampleCount, float *sampleTimes, VtValue *sampleValues)
 Store up to maxSampleCount primvar samples in *samplesValues. More...
 
template<unsigned int CAPACITY>
void SamplePrimvar (SdfPath const &id, TfToken const &key, HdTimeSampleArray< VtValue, CAPACITY > *sa)
 Convenience form of SamplePrimvar() that takes an HdTimeSampleArray. More...
 
virtual HD_API size_t SampleIndexedPrimvar (SdfPath const &id, TfToken const &key, size_t maxSampleCount, float *sampleTimes, VtValue *sampleValues, VtIntArray *sampleIndices)
 SamplePrimvar() for getting an unflattened primvar and its indices. More...
 
template<unsigned int CAPACITY>
void SampleIndexedPrimvar (SdfPath const &id, TfToken const &key, HdIndexedTimeSampleArray< VtValue, CAPACITY > *sa)
 Convenience form of SampleIndexedPrimvar() that takes HdTimeSampleArrays. More...
 
virtual HD_API SdfPath GetScenePrimPath (SdfPath const &rprimId, int instanceIndex, HdInstancerContext *instancerContext=nullptr)
 Returns the scene address of the prim corresponding to the given rprim/instance index. More...
 
virtual HD_API SdfPathVector GetScenePrimPaths (SdfPath const &rprimId, std::vector< int > instanceIndices, std::vector< HdInstancerContext > *instancerContexts=nullptr)
 A vectorized version of GetScenePrimPath that allows the prim adapter to amortize expensive calculations across a number of path evaluations in a single call. More...
 
virtual HD_API VtValue GetLightParamValue (SdfPath const &id, TfToken const &paramName)
 
virtual HD_API HdVolumeFieldDescriptorVector GetVolumeFieldDescriptors (SdfPath const &volumeId)
 
virtual HD_API TfTokenVector GetExtComputationSceneInputNames (SdfPath const &computationId)
 For the given computation id, returns a list of inputs which will be requested from the scene delegate using the Get() method. More...
 
virtual HD_API HdExtComputationInputDescriptorVector GetExtComputationInputDescriptors (SdfPath const &computationId)
 For the given computation id, returns a list of computation input descriptors. More...
 
virtual HD_API HdExtComputationOutputDescriptorVector GetExtComputationOutputDescriptors (SdfPath const &computationId)
 For the given computation id, returns a list of computation output descriptors. More...
 
virtual HD_API HdExtComputationPrimvarDescriptorVector GetExtComputationPrimvarDescriptors (SdfPath const &id, HdInterpolation interpolationMode)
 Returns a list of primvar names that should be bound to a generated output from an ExtComputation for the given prim id and interpolation mode. More...
 
virtual HD_API VtValue GetExtComputationInput (SdfPath const &computationId, TfToken const &input)
 Returns a single value for a given computation id and input token. More...
 
virtual HD_API size_t SampleExtComputationInput (SdfPath const &computationId, TfToken const &input, size_t maxSampleCount, float *sampleTimes, VtValue *sampleValues)
 Return up to maxSampleCount samples for a given computation id and input token. More...
 
template<unsigned int CAPACITY>
void SampleExtComputationInput (SdfPath const &computationId, TfToken const &input, HdTimeSampleArray< VtValue, CAPACITY > *sa)
 Convenience form of SampleExtComputationInput() that takes an HdTimeSampleArray. More...
 
virtual HD_API std::string GetExtComputationKernel (SdfPath const &computationId)
 Returns the kernel source assigned to the computation at the path id. More...
 
virtual HD_API void InvokeExtComputation (SdfPath const &computationId, HdExtComputationContext *context)
 Requests the scene delegate run the ExtComputation with the given id. More...
 

Detailed Description

A simple delegate class for unit test driver.

Definition at line 51 of file unitTestDelegate.h.

Member Function Documentation

◆ AddCamera()

HD_API void AddCamera ( SdfPath const &  id)

Camera.

◆ AddCube()

HD_API void AddCube ( SdfPath const &  id,
GfMatrix4f const &  transform,
bool  guide = false,
SdfPath const &  instancerId = SdfPath(),
TfToken const &  scheme = PxOsdOpenSubdivTokens->catmullClark 
)

Add a cube.

◆ AddCurves()

HD_API void AddCurves ( SdfPath const &  id,
TfToken const &  type,
TfToken const &  basis,
GfMatrix4f const &  transform,
HdInterpolation  colorInterp = HdInterpolationConstant,
HdInterpolation  widthInterp = HdInterpolationConstant,
bool  authoredNormals = false,
SdfPath const &  instancerId = SdfPath() 
)

Add a basis curves prim containing two curves.

◆ AddFaceVaryingPolygons()

HD_API void AddFaceVaryingPolygons ( SdfPath const &  id,
GfMatrix4f const &  transform,
SdfPath const &  instancerId = SdfPath() 
)

Add a triangle, quad and pentagon with face-varying displayColor and displayOpacity.

◆ AddGrid()

HD_API void AddGrid ( SdfPath const &  id,
int  x,
int  y,
GfMatrix4f const &  transform,
bool  rightHanded = true,
bool  doubleSided = false,
SdfPath const &  instancerId = SdfPath() 
)

Add a grid with division x*y.

◆ AddGridWithFaceColor()

HD_API void AddGridWithFaceColor ( SdfPath const &  id,
int  x,
int  y,
GfMatrix4f const &  transform,
bool  rightHanded = true,
bool  doubleSided = false,
SdfPath const &  instancerId = SdfPath() 
)

Add a grid with division x*y.

◆ AddGridWithFaceVaryingColor()

HD_API void AddGridWithFaceVaryingColor ( SdfPath const &  id,
int  x,
int  y,
GfMatrix4f const &  transform,
bool  rightHanded = true,
bool  doubleSided = false,
SdfPath const &  instancerId = SdfPath() 
)

Add a grid with division x*y.

◆ AddGridWithVertexColor()

HD_API void AddGridWithVertexColor ( SdfPath const &  id,
int  x,
int  y,
GfMatrix4f const &  transform,
bool  rightHanded = true,
bool  doubleSided = false,
SdfPath const &  instancerId = SdfPath() 
)

Add a grid with division x*y.

◆ AddInstancer()

HD_API void AddInstancer ( SdfPath const &  id,
SdfPath const &  parentId = SdfPath(),
GfMatrix4f const &  rootTransform = GfMatrix4f(1) 
)

Instancer.

◆ AddMaterialResource()

HD_API void AddMaterialResource ( SdfPath const &  id,
VtValue  materialResource 
)

Material.

◆ AddPoints()

HD_API void AddPoints ( SdfPath const &  id,
GfMatrix4f const &  transform,
HdInterpolation  colorInterp = HdInterpolationConstant,
HdInterpolation  widthInterp = HdInterpolationConstant,
SdfPath const &  instancerId = SdfPath() 
)

Add a points prim.

◆ AddPolygons()

HD_API void AddPolygons ( SdfPath const &  id,
GfMatrix4f const &  transform,
HdInterpolation  colorInterp,
SdfPath const &  instancerId = SdfPath() 
)

Add a triangle, quad and pentagon.

◆ AddPrimvar()

HD_API void AddPrimvar ( SdfPath const &  id,
TfToken const &  name,
VtValue const &  value,
HdInterpolation const &  interp,
TfToken const &  role,
VtIntArray const &  indices = VtIntArray(0) 
)

Primvars.

◆ AddRenderBuffer()

HD_API void AddRenderBuffer ( SdfPath const &  id,
HdRenderBufferDescriptor const &  desc 
)

Render buffers.

◆ AddSubdiv()

HD_API void AddSubdiv ( SdfPath const &  id,
GfMatrix4f const &  transform,
SdfPath const &  insatancerId = SdfPath() 
)

Add a subdiv with various tags.

◆ AddTask()

void AddTask ( SdfPath const &  id)
inline

Tasks.

Definition at line 301 of file unitTestDelegate.h.

◆ Clear()

HD_API void Clear ( )

Clear all prims.

◆ Get()

virtual HD_API VtValue Get ( SdfPath const &  id,
TfToken const &  key 
)
overridevirtual

Returns a named value.

Reimplemented from HdSceneDelegate.

◆ GetBasisCurvesTopology()

virtual HD_API HdBasisCurvesTopology GetBasisCurvesTopology ( SdfPath const &  id)
overridevirtual

Gets the topological curve data for a given prim.

Reimplemented from HdSceneDelegate.

◆ GetCameraParamValue()

virtual HD_API VtValue GetCameraParamValue ( SdfPath const &  cameraId,
TfToken const &  paramName 
)
overridevirtual

Returns a single value for a given camera and parameter.

See HdCameraTokens for the list of paramters.

Reimplemented from HdSceneDelegate.

◆ GetDisplayStyle()

virtual HD_API HdDisplayStyle GetDisplayStyle ( SdfPath const &  id)
overridevirtual

Returns the refinement level for the given prim in the range [0,8].

The refinement level indicates how many iterations to apply when subdividing subdivision surfaces or other refinable primitives.

Reimplemented from HdSceneDelegate.

◆ GetDoubleSided()

virtual HD_API bool GetDoubleSided ( SdfPath const &  id)
overridevirtual

Returns the doubleSided state for the given prim.

Reimplemented from HdSceneDelegate.

◆ GetExtent()

virtual HD_API GfRange3d GetExtent ( SdfPath const &  id)
overridevirtual

Gets the axis aligned bounds of a prim.

The returned bounds are in the local space of the prim (transform is yet to be applied) and should contain the bounds of any child prims.

The returned bounds does not include any displacement that might occur as the result of running shaders on the prim.

Reimplemented from HdSceneDelegate.

◆ GetIndexedPrimvar()

virtual HD_API VtValue GetIndexedPrimvar ( SdfPath const &  id,
TfToken const &  key,
VtIntArray *  outIndices 
)
overridevirtual

Returns a named primvar value.

If *outIndices is not nullptr and the primvar has indices, it will return the unflattened primvar and set *outIndices to the primvar's associated indices, clearing the array if the primvar is not indexed.

Reimplemented from HdSceneDelegate.

◆ GetInstanceIndices()

virtual HD_API VtIntArray GetInstanceIndices ( SdfPath const &  instancerId,
SdfPath const &  prototypeId 
)
overridevirtual

Gets the extracted indices array of the prototype id used in the instancer.

example instances: 0, 1, 2, 3, 4, 5 protoypes: A, B, A, A, B, C

GetInstanceIndices(A) : [0, 2, 3] GetInstanceIndices(B) : [1, 4] GetInstanceIndices(C) : [5] GetInstanceIndices(D) : []

Reimplemented from HdSceneDelegate.

◆ GetInstancerId()

virtual HD_API SdfPath GetInstancerId ( SdfPath const &  primId)
overridevirtual

Returns the parent instancer of the given rprim or instancer.

Reimplemented from HdSceneDelegate.

◆ GetInstancerPrototypes()

virtual HD_API SdfPathVector GetInstancerPrototypes ( SdfPath const &  instancerId)
overridevirtual

Returns a list of prototypes of this instancer.

The intent is to let renderers cache instance indices by giving them a complete set of prims to call GetInstanceIndices(instancer, prototype) on. XXX: This is currently unused, but may be used in the future.

Reimplemented from HdSceneDelegate.

◆ GetInstancerTransform()

virtual HD_API GfMatrix4d GetInstancerTransform ( SdfPath const &  instancerId)
overridevirtual

Returns the instancer transform.

Reimplemented from HdSceneDelegate.

◆ GetMaterialId()

virtual HD_API SdfPath GetMaterialId ( SdfPath const &  rprimId)
overridevirtual

Returns the material ID bound to the rprim rprimId.

Reimplemented from HdSceneDelegate.

◆ GetMeshTopology()

virtual HD_API HdMeshTopology GetMeshTopology ( SdfPath const &  id)
overridevirtual

Gets the topological mesh data for a given prim.

Reimplemented from HdSceneDelegate.

◆ GetPrimvarDescriptors()

virtual HD_API HdPrimvarDescriptorVector GetPrimvarDescriptors ( SdfPath const &  id,
HdInterpolation  interpolation 
)
overridevirtual

Returns descriptors for all primvars of the given interpolation type.

Reimplemented from HdSceneDelegate.

◆ GetRenderBufferDescriptor()

virtual HD_API HdRenderBufferDescriptor GetRenderBufferDescriptor ( SdfPath const &  id)
overridevirtual

Returns the allocation descriptor for a given render buffer prim.

Reimplemented from HdSceneDelegate.

◆ GetRenderTag()

virtual HD_API TfToken GetRenderTag ( SdfPath const &  id)
overridevirtual

Returns the render tag that will be used to bucket prims during render pass bucketing.

Reimplemented from HdSceneDelegate.

◆ GetReprSelector()

virtual HD_API HdReprSelector GetReprSelector ( SdfPath const &  id)
overridevirtual

Returns the authored repr (if any) for the given prim.

Reimplemented from HdSceneDelegate.

◆ GetSubdivTags()

virtual HD_API PxOsdSubdivTags GetSubdivTags ( SdfPath const &  id)
overridevirtual

Gets the subdivision surface tags (sharpness, holes, etc).

Reimplemented from HdSceneDelegate.

◆ GetTransform()

virtual HD_API GfMatrix4d GetTransform ( SdfPath const &  id)
overridevirtual

Returns the object space transform, including all parent transforms.

Reimplemented from HdSceneDelegate.

◆ GetVisible()

virtual HD_API bool GetVisible ( SdfPath const &  id)
overridevirtual

Returns the authored visible state of the prim.

Reimplemented from HdSceneDelegate.

◆ MarkRprimDirty()

HD_API void MarkRprimDirty ( SdfPath  path,
HdDirtyBits  flag 
)

Marks an rprim in the RenderIndex as dirty with the given dirty flags.

◆ RebindMaterial()

HD_API void RebindMaterial ( SdfPath const &  rprimId,
SdfPath const &  materialId 
)

Example to update a material binding on the fly.

◆ Remove()

HD_API void Remove ( SdfPath const &  id)

Remove a prim.

◆ UpdateMaterialResource()

HD_API void UpdateMaterialResource ( SdfPath const &  materialId,
VtValue  materialResource 
)

Update a material resource.

◆ UpdateTransform()

HD_API void UpdateTransform ( SdfPath const &  id,
GfMatrix4f const &  mat 
)

Transform.


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