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. More...

#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 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 52 of file generativeProcedural.h.

Member Typedef Documentation

◆ ChildPrimTypeMap

using ChildPrimTypeMap = TfDenseHashMap<SdfPath, TfToken, TfHash>

Definition at line 64 of file generativeProcedural.h.

◆ DependencyMap

using DependencyMap = TfDenseHashMap<SdfPath, HdDataSourceLocatorSet, TfHash>

Definition at line 61 of file generativeProcedural.h.

Member Enumeration Documentation

◆ AsyncState

enum AsyncState

Definition at line 152 of file generativeProcedural.h.

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

pxr/imaging/hdGp/generativeProcedural.h

Public Types

Public Member Functions