HdGpGenerativeProcedural Class Reference

#include <generativeProcedural.h>

Public Types
enum	AsyncState { Continuing = 0, Finished, ContinuingWithNewChanges, FinishedWithNewChanges }
using	DependencyMap = TfDenseHashMap< SdfPath, HdDataSourceLocatorSet, TfHash >
using	ChildPrimTypeMap = TfDenseHashMap< SdfPath, TfToken, TfHash >

Public Member Functions
HDGP_API	HdGpGenerativeProcedural (const SdfPath &proceduralPrimPath)
virtual HDGP_API	~HdGpGenerativeProcedural ()
virtual DependencyMap	UpdateDependencies (const HdSceneIndexBaseRefPtr &inputScene)=0
virtual ChildPrimTypeMap	Update (const HdSceneIndexBaseRefPtr &inputScene, const ChildPrimTypeMap &previousResult, const DependencyMap &dirtiedDependencies, HdSceneIndexObserver::DirtiedPrimEntries *outputDirtiedPrims)=0
virtual HdSceneIndexPrim	GetChildPrim (const HdSceneIndexBaseRefPtr &inputScene, const SdfPath &childPrimPath)=0
virtual bool	AsyncBegin (bool asyncEnabled)
virtual AsyncState	AsyncUpdate (const ChildPrimTypeMap &previousResult, ChildPrimTypeMap *outputPrimTypes, HdSceneIndexObserver::DirtiedPrimEntries *outputDirtiedPrims)

Static Public Member Functions
static const HdDataSourceLocator &	GetChildNamesDependencyKey ()

Protected Member Functions
HDGP_API const SdfPath &	_GetProceduralPrimPath ()

Detailed Description

HdGpGenerativeProcedural is the base class for procedurals which have full access to an input scene in order to create and update a hierarchy of child prims within a hydra scene index.

They are registered for use via a corresponding HdGpGenerativeProceduralPlugin.

Definition at line 49 of file generativeProcedural.h.

Member Typedef Documentation

using HdGpGenerativeProcedural::ChildPrimTypeMap = TfDenseHashMap<SdfPath, TfToken, TfHash>

Definition at line 62 of file generativeProcedural.h.

using HdGpGenerativeProcedural::DependencyMap = TfDenseHashMap<SdfPath, HdDataSourceLocatorSet, TfHash>

Definition at line 59 of file generativeProcedural.h.

Member Enumeration Documentation

enum HdGpGenerativeProcedural::AsyncState

Enumerator
Continuing
Finished
ContinuingWithNewChanges
FinishedWithNewChanges

Definition at line 149 of file generativeProcedural.h.

Constructor & Destructor Documentation

HDGP_API HdGpGenerativeProcedural::HdGpGenerativeProcedural

(

const SdfPath &

proceduralPrimPath

)

virtual HDGP_API HdGpGenerativeProcedural::~HdGpGenerativeProcedural ( )

virtual

Member Function Documentation

HDGP_API const SdfPath& HdGpGenerativeProcedural::_GetProceduralPrimPath ( )

protected

virtual bool HdGpGenerativeProcedural::AsyncBegin ( bool  asyncEnabled )

virtual

virtual AsyncState HdGpGenerativeProcedural::AsyncUpdate ( const ChildPrimTypeMap &  previousResult, ChildPrimTypeMap *  outputPrimTypes, HdSceneIndexObserver::DirtiedPrimEntries *  outputDirtiedPrims  )

virtual

static const HdDataSourceLocator& HdGpGenerativeProcedural::GetChildNamesDependencyKey ( )

static

virtual HdSceneIndexPrim HdGpGenerativeProcedural::GetChildPrim ( const HdSceneIndexBaseRefPtr &  inputScene, const SdfPath &  childPrimPath  )

pure virtual

virtual ChildPrimTypeMap HdGpGenerativeProcedural::Update ( const HdSceneIndexBaseRefPtr &  inputScene, const ChildPrimTypeMap &  previousResult, const DependencyMap &  dirtiedDependencies, HdSceneIndexObserver::DirtiedPrimEntries *  outputDirtiedPrims  )

pure virtual

virtual DependencyMap HdGpGenerativeProcedural::UpdateDependencies ( const HdSceneIndexBaseRefPtr &  inputScene )

pure virtual

---

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

• pxr/imaging/hdGp/generativeProcedural.h