All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStVolume Class Referencefinal

#include <volume.h>

+ Inheritance diagram for HdStVolume:

Public Member Functions

HDST_API HdStVolume (SdfPath const &id, SdfPath const &instancerId=SdfPath())
HDST_API ~HdStVolume () override
HDST_API HdDirtyBits GetInitialDirtyBitsMask () const override
HDST_API void Sync (HdSceneDelegate *delegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits, TfToken const &reprToken) override
- Public Member Functions inherited from HdVolume
HD_API HdVolume (SdfPath const &id, SdfPath const &instancerId=SdfPath())
virtual HD_API ~HdVolume ()
HD_API TfTokenVector constGetBuiltinPrimvarNames () const override
- Public Member Functions inherited from HdRprim
HD_API HdRprim (SdfPath const &id, SdfPath const &instancerId)
virtual HD_API ~HdRprim ()
HD_API const
GetDrawItems (TfToken const &reprToken) const
virtual HD_API void Finalize (HdRenderParam *renderParam)
SdfPath constGetId () const
int32_t GetPrimId () const
 Return the unique instance id. More...
HD_API void SetPrimId (int32_t primId)
 Set the unique instance id. More...
SdfPath constGetInstancerId () const
SdfPath constGetMaterialId () const
TfToken constGetMaterialTag () const
HdReprSelector constGetReprSelector () 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
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)
HD_API bool CanSkipDirtyBitPropagationAndSync (HdDirtyBits bits) const
HD_API HdDirtyBits PropagateRprimDirtyBits (HdDirtyBits bits)
HD_API void InitRepr (HdSceneDelegate *delegate, TfToken const &reprToken, HdDirtyBits *dirtyBits)

Static Public Attributes

static const float defaultStepSize
 Default step size used for raymarching. More...
static const float defaultStepSizeLighting
 Default step size used for raymarching for lighting computation. More...

Protected Member Functions

void _InitRepr (TfToken const &reprToken, HdDirtyBits *dirtyBits) override
HdDirtyBits _PropagateDirtyBits (HdDirtyBits bits) const override
void _UpdateRepr (HdSceneDelegate *sceneDelegate, TfToken const &reprToken, HdDirtyBits *dirtyBitsState)
- Protected Member Functions inherited from HdRprim
HD_API HdReprSharedPtr const_GetRepr (TfToken const &reprToken) const
 Sets a new material binding to be used by this rprim. More...
HD_API void _UpdateVisibility (HdSceneDelegate *sceneDelegate, HdDirtyBits *dirtyBits)
 Sets a new material binding to be used by this rprim. More...
HD_API void _SetMaterialId (HdChangeTracker &changeTracker, SdfPath const &materialId)
 Sets a new material binding to be used by this rprim. More...
HD_API uint64_t _ComputeSharedPrimvarId (uint64_t baseId, HdBufferSourceSharedPtrVector const &sources, HdComputationSharedPtrVector const &computations) const
 Sets a new material binding to be used by this rprim. More...

Detailed Description

Represents a Volume Prim.

Definition at line 38 of file volume.h.

Constructor & Destructor Documentation

HDST_API HdStVolume::HdStVolume ( SdfPath const id,
SdfPath const instancerId = SdfPath() 
HDST_API HdStVolume::~HdStVolume ( )

Member Function Documentation

void HdStVolume::_InitRepr ( TfToken const reprToken,
HdDirtyBits dirtyBits 

Initialize the given representation of this Rprim. This is called prior to syncing the prim, the first time the repr is used.

reprToken is the name of the representation to initalize.

dirtyBits is an in/out value. It is initialized to the dirty bits from the change tracker. InitRepr can then set additional dirty bits if additional data is required from the scene delegate when this repr is synced. InitRepr occurs before dirty bit propagation.

See HdRprim::InitRepr()

Implements HdRprim.

HdDirtyBits HdStVolume::_PropagateDirtyBits ( HdDirtyBits  bits) const

This callback from Rprim gives the prim an opportunity to set additional dirty bits based on those already set. This is done before the dirty bits are passed to the scene delegate, so can be used to communicate that extra information is needed by the prim to process the changes.

The return value is the new set of dirty bits, which replaces the bits passed in.

See HdRprim::PropagateRprimDirtyBits()

Implements HdRprim.

void HdStVolume::_UpdateRepr ( HdSceneDelegate sceneDelegate,
TfToken const reprToken,
HdDirtyBits dirtyBitsState 
HDST_API HdDirtyBits HdStVolume::GetInitialDirtyBitsMask ( ) const

Returns the set of dirty bits that should be added to the change tracker for this prim, when this prim is inserted.

Implements HdRprim.

HDST_API void HdStVolume::Sync ( HdSceneDelegate delegate,
HdRenderParam renderParam,
HdDirtyBits dirtyBits,
TfToken const reprToken 

Pull invalidated scene data and prepare/update the renderable representation.

This function is told which scene data to pull through the dirtyBits parameter. The first time it's called, dirtyBits comes from _GetInitialDirtyBits(), which provides initial dirty state, but after that it's driven by invalidation tracking in the scene delegate.

The contract for this function is that the prim can only pull on scene delegate buffers that are marked dirty. Scene delegates can and do implement just-in-time data schemes that mean that pulling on clean data will be at best incorrect, and at worst a crash.

This function is called in parallel from worker threads, so it needs to be threadsafe; calls into HdSceneDelegate are ok.

sceneDelegateThe data source for this geometry item.
renderParamA render delegate object that holds rendering parameters that scene geometry may use.
dirtyBitsA specifier for which scene data has changed.
reprTokenThe representation that needs to be updated. This is useful for backends that support multiple display representations for an rprim. A given representation may choose to pull on a subset of the dirty state.
dirtyBitsOn input specifies which state is dirty and can be pulled from the scene delegate. On output specifies which bits are still dirty and were not cleaned by the sync.

Implements HdRprim.

Member Data Documentation

const float HdStVolume::defaultStepSize

Default step size used for raymarching.

Definition at line 55 of file volume.h.

const float HdStVolume::defaultStepSizeLighting

Default step size used for raymarching for lighting computation.

Definition at line 58 of file volume.h.

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