HdVolume Class Reference

Hd schema for a renderable volume primitive. More...

+ Inheritance diagram for HdVolume:

Public Member Functions

HD_API HdVolume (SdfPath const &id)
 
HD_API TfTokenVector const & GetBuiltinPrimvarNames () const override
 Returns the names of built-in primvars, i.e. More...
 
- Public Member Functions inherited from HdRprim
HD_API HdRprim (SdfPath const &id)
 
HD_API const HdRepr::DrawItemUniquePtrVector & GetDrawItems (TfToken const &reprToken) const
 Returns the draw items for the requested repr token, if any. More...
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 Finalizes object resources. More...
 
SdfPath const & GetId () const
 Returns the identifier of this Rprim. More...
 
int32_t GetPrimId () const
 Return the unique instance id. More...
 
HD_API void SetPrimId (int32_t primId)
 Set the unique instance id. More...
 
SdfPath const & GetInstancerId () const
 Returns the identifier of the instancer (if any) for this Rprim. More...
 
SdfPath const & GetMaterialId () const
 Returns the path of the material to which this Rprim is bound. More...
 
HD_API void SetMaterialId (SdfPath const &materialId)
 Sets a new material binding to be used by this rprim. More...
 
HdReprSelector const & GetReprSelector () const
 
TfToken const & GetRenderTag () const
 
TfToken GetRenderTag (HdSceneDelegate *delegate) const
 Returns the render tag associated to this rprim. More...
 
GfRange3d GetExtent (HdSceneDelegate *delegate) const
 Returns the bounds of the rprim in local, untransformed space. More...
 
HdPrimvarDescriptorVector GetPrimvarDescriptors (HdSceneDelegate *delegate, HdInterpolation interpolation) const
 Primvar Query. More...
 
VtValue GetPrimvar (HdSceneDelegate *delegate, const TfToken &name) const
 
VtValue GetIndexedPrimvar (HdSceneDelegate *delegate, const TfToken &name, VtIntArray *indices) const
 
HD_API VtMatrix4dArray GetInstancerTransforms (HdSceneDelegate *delegate)
 
HD_API bool IsDirty (HdChangeTracker &changeTracker) const
 Returns true if any dirty flags are set for this rprim. More...
 
bool IsVisible () const
 Is the prim itself visible. More...
 
HD_API void UpdateReprSelector (HdSceneDelegate *delegate, HdDirtyBits *dirtyBits)
 
virtual HD_API void UpdateRenderTag (HdSceneDelegate *delegate, HdRenderParam *renderParam)
 
virtual HdDirtyBits GetInitialDirtyBitsMask () const =0
 Returns the set of dirty bits that should be added to the change tracker for this prim, when this prim is inserted. More...
 
HD_API bool CanSkipDirtyBitPropagationAndSync (HdDirtyBits bits) const
 This function gives an Rprim the chance to "early exit" from dirty bit propagation, delegate sync and rprim sync altogether. More...
 
HD_API HdDirtyBits PropagateRprimDirtyBits (HdDirtyBits bits)
 This function gives an Rprim the chance to set additional dirty bits based on those set in the change tracker, before passing the dirty bits to the scene delegate. More...
 
HD_API void InitRepr (HdSceneDelegate *delegate, TfToken const &reprToken, HdDirtyBits *dirtyBits)
 Initialize the representation of this Rprim by calling _InitRepr. More...
 
virtual void Sync (HdSceneDelegate *delegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits, TfToken const &reprToken)=0
 Pull invalidated scene data and prepare/update the renderable representation. More...
 

Additional Inherited Members

- Protected Types inherited from HdRprim
using _ReprVector = std::vector< std::pair< TfToken, HdReprSharedPtr > >
 
- Protected Member Functions inherited from HdRprim
virtual HdDirtyBits _PropagateDirtyBits (HdDirtyBits bits) const =0
 This callback from Rprim gives the prim an opportunity to set additional dirty bits based on those already set. More...
 
virtual void _InitRepr (TfToken const &reprToken, HdDirtyBits *dirtyBits)=0
 Initialize the given representation of this Rprim. More...
 
HD_API HdReprSharedPtr const & _GetRepr (TfToken const &reprToken) const
 
HD_API void _UpdateVisibility (HdSceneDelegate *sceneDelegate, HdDirtyBits *dirtyBits)
 
HD_API void _UpdateInstancer (HdSceneDelegate *sceneDelegate, HdDirtyBits *dirtyBits)
 
- Protected Attributes inherited from HdRprim
HdRprimSharedData _sharedData
 
HdReprSelector _authoredReprSelector
 
TfToken _renderTag
 
_ReprVector _reprs
 

Detailed Description

Hd schema for a renderable volume primitive.

Definition at line 42 of file volume.h.

Member Function Documentation

◆ GetBuiltinPrimvarNames()

HD_API TfTokenVector const& GetBuiltinPrimvarNames ( ) const
overridevirtual

Returns the names of built-in primvars, i.e.

primvars that are part of the core geometric schema for this prim.

Implements HdRprim.


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