24#ifndef PXR_IMAGING_HD_SCENE_DELEGATE_H
25#define PXR_IMAGING_HD_SCENE_DELEGATE_H
28#include "pxr/imaging/hd/api.h"
29#include "pxr/imaging/hd/version.h"
31#include "pxr/imaging/hd/aov.h"
32#include "pxr/imaging/hd/basisCurvesTopology.h"
33#include "pxr/imaging/hd/enums.h"
34#include "pxr/imaging/hd/meshTopology.h"
35#include "pxr/imaging/hd/renderIndex.h"
36#include "pxr/imaging/hd/repr.h"
37#include "pxr/imaging/hd/timeSampleArray.h"
43#include "pxr/base/vt/value.h"
45#include "pxr/usd/sdf/path.h"
53PXR_NAMESPACE_OPEN_SCOPE
58typedef std::shared_ptr<SdfPathVector> HdIdVectorSharedPtr;
61typedef std::vector<std::pair<SdfPath, int>> HdInstancerContext;
74 std::vector<HdDirtyBits> dirtyBits;
131 bool flatShading =
false,
132 bool displacement =
true,
133 bool occludedSelectionShowsThrough_ =
false,
134 bool pointsShadingEnabled_ =
false,
135 bool materialIsFinal_ =
false)
143 if (refineLevel_ < 0) {
145 }
else if (refineLevel_ > 8) {
163 return !(*
this == rhs);
185 ,
role(HdPrimvarRoleTokens->none)
189 HdInterpolation interp_,
190 TfToken const& role_=HdPrimvarRoleTokens->none,
199 return !(*
this == rhs);
203typedef std::vector<HdPrimvarDescriptor> HdPrimvarDescriptorVector;
237 : drawMode(HdModelDrawModeTokens->inherited)
238 , applyDrawMode(
false)
240 , cardGeometry(HdModelDrawModeTokens->cross)
245 bool applyDrawMode_=
false,
247 TfToken const& cardGeometry_=HdModelDrawModeTokens->cross,
254 : drawMode(drawMode_), applyDrawMode(applyDrawMode_),
255 drawModeColor(drawModeColor_), cardGeometry(cardGeometry_),
256 cardTextureXPos(cardTextureXPos_), cardTextureYPos(cardTextureYPos_),
257 cardTextureZPos(cardTextureZPos_), cardTextureXNeg(cardTextureXNeg_),
258 cardTextureYNeg(cardTextureYNeg_), cardTextureZNeg(cardTextureZNeg_)
262 return drawMode == rhs.drawMode &&
263 applyDrawMode == rhs.applyDrawMode &&
264 drawModeColor == rhs.drawModeColor &&
265 cardGeometry == rhs.cardGeometry &&
266 cardTextureXPos == rhs.cardTextureXPos &&
267 cardTextureYPos == rhs.cardTextureYPos &&
268 cardTextureZPos == rhs.cardTextureZPos &&
269 cardTextureXNeg == rhs.cardTextureXNeg &&
270 cardTextureYNeg == rhs.cardTextureYNeg &&
271 cardTextureZNeg == rhs.cardTextureZNeg;
274 return !(*
this == rhs);
289 TfToken sourceComputationOutputName;
295 HdInterpolation interp_,
297 SdfPath const & sourceComputationId_,
298 TfToken const & sourceComputationOutputName_,
301 , sourceComputationId(sourceComputationId_)
302 , sourceComputationOutputName(sourceComputationOutputName_)
303 , valueType(valueType_)
306 return HdPrimvarDescriptor::operator==(rhs) &&
307 sourceComputationId == rhs.sourceComputationId &&
308 sourceComputationOutputName == rhs.sourceComputationOutputName &&
309 valueType == rhs.valueType;
312 return !(*
this == rhs);
316typedef std::vector<HdExtComputationPrimvarDescriptor>
317 HdExtComputationPrimvarDescriptorVector;
330 TfToken sourceComputationOutputName;
335 SdfPath const & sourceComputationId_,
336 TfToken const & sourceComputationOutputName_)
337 : name(name_), sourceComputationId(sourceComputationId_)
338 , sourceComputationOutputName(sourceComputationOutputName_)
342 return name == rhs.name &&
343 sourceComputationId == rhs.sourceComputationId &&
344 sourceComputationOutputName == rhs.sourceComputationOutputName;
347 return !(*
this == rhs);
351typedef std::vector<HdExtComputationInputDescriptor>
352 HdExtComputationInputDescriptorVector;
368 : name(name_), valueType(valueType_)
372 return name == rhs.name &&
373 valueType == rhs.valueType;
376 return !(*
this == rhs);
380typedef std::vector<HdExtComputationOutputDescriptor>
381 HdExtComputationOutputDescriptorVector;
395 TfToken const & fieldPrimType_,
397 : fieldName(fieldName_), fieldPrimType(fieldPrimType_), fieldId(fieldId_)
401typedef std::vector<HdVolumeFieldDescriptor>
402 HdVolumeFieldDescriptorVector;
510 VtIntArray *outIndices);
527 virtual std::vector<VtArray<TfToken>>
552 size_t maxSampleCount,
559 template <
unsigned int CAPACITY>
563 size_t authoredSamples =
565 if (authoredSamples > CAPACITY) {
566 sa->
Resize(authoredSamples);
567 size_t authoredSamplesSecondAttempt =
575 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
577 sa->count = authoredSamples;
590 size_t maxSampleCount,
598 template <
unsigned int CAPACITY>
602 size_t authoredSamples =
608 if (authoredSamples > CAPACITY) {
609 sa->
Resize(authoredSamples);
610 size_t authoredSamplesSecondAttempt =
618 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
620 sa->count = authoredSamples;
644 size_t maxSampleCount,
651 template <
unsigned int CAPACITY>
666 size_t maxSampleCount,
669 VtIntArray *sampleIndices);
674 template <
unsigned int CAPACITY>
726 HdInstancerContext *instancerContext =
nullptr);
735 std::vector<int> instanceIndices,
736 std::vector<HdInstancerContext> *instancerContexts =
nullptr);
783 virtual HdVolumeFieldDescriptorVector
784 GetVolumeFieldDescriptors(
SdfPath const &volumeId);
807 virtual HdExtComputationInputDescriptorVector
815 virtual HdExtComputationOutputDescriptorVector
827 virtual HdExtComputationPrimvarDescriptorVector
829 HdInterpolation interpolationMode);
847 size_t maxSampleCount,
855 template <
unsigned int CAPACITY>
860 computationId, input, CAPACITY,
861 sa->times.
data(), sa->values.
data());
863 if (authoredSamples > CAPACITY) {
864 sa->
Resize(authoredSamples);
866 computationId, input, authoredSamples,
867 sa->times.
data(), sa->values.
data());
870 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
872 sa->count = authoredSamples;
901 virtual HdPrimvarDescriptorVector
919template <
unsigned int CAPACITY>
924 size_t authoredSamples =
931 if (authoredSamples > CAPACITY) {
932 sa->
Resize(authoredSamples);
933 size_t authoredSamplesSecondAttempt =
942 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
944 sa->count = authoredSamples;
947template <
unsigned int CAPACITY>
952 size_t authoredSamples =
960 if (authoredSamples > CAPACITY) {
961 sa->
Resize(authoredSamples);
962 size_t authoredSamplesSecondAttempt =
972 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
974 sa->count = authoredSamples;
977PXR_NAMESPACE_CLOSE_SCOPE
Stores a 4x4 matrix of double elements.
Basic type: 3-dimensional floating point range.
Basic type for a vector of 3 float components.
Topology data for basisCurves.
Interface class that defines the execution environment for the client to run a computation.
Topology data for meshes.
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Describes one or more authored display representations for an rprim.
Adapter class providing data exchange with the client scene graph.
virtual HD_API HdRenderBufferDescriptor GetRenderBufferDescriptor(SdfPath const &id)
Returns the allocation descriptor for a given render buffer prim.
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.
virtual HD_API TfToken GetRenderTag(SdfPath const &id)
Returns the render tag that will be used to bucket prims during render pass bucketing.
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.
void SampleInstancerTransform(SdfPath const &instancerId, HdTimeSampleArray< GfMatrix4d, CAPACITY > *sa)
Convenience form of SampleInstancerTransform() that takes an HdTimeSampleArray.
virtual HD_API SdfPath GetInstancerId(SdfPath const &primId)
Returns the parent instancer of the given rprim or instancer.
void SampleExtComputationInput(SdfPath const &computationId, TfToken const &input, HdTimeSampleArray< VtValue, CAPACITY > *sa)
Convenience form of SampleExtComputationInput() that takes an HdTimeSampleArray.
virtual HD_API GfMatrix4d GetTransform(SdfPath const &id)
Returns the object space transform, including all parent transforms.
virtual HD_API HdExtComputationOutputDescriptorVector GetExtComputationOutputDescriptors(SdfPath const &computationId)
For the given computation id, returns a list of computation output descriptors.
virtual HD_API HdPrimvarDescriptorVector GetPrimvarDescriptors(SdfPath const &id, HdInterpolation interpolation)
Returns descriptors for all primvars of the given interpolation type.
virtual HD_API HdDisplayStyle GetDisplayStyle(SdfPath const &id)
Returns the refinement level for the given prim in the range [0,8].
virtual HD_API VtValue GetShadingStyle(SdfPath const &id)
Returns the shading style for the given prim.
virtual HD_API bool IsEnabled(TfToken const &option) const
Returns true if the named option is enabled by the delegate.
virtual HD_API SdfPathVector GetInstancerPrototypes(SdfPath const &instancerId)
Returns a list of prototypes of this instancer.
virtual HD_API VtIntArray GetInstanceIndices(SdfPath const &instancerId, SdfPath const &prototypeId)
Gets the extracted indices array of the prototype id used in the instancer.
virtual HD_API VtValue GetCameraParamValue(SdfPath const &cameraId, TfToken const ¶mName)
Returns a single value for a given camera and parameter.
virtual HD_API SdfPath GetMaterialId(SdfPath const &rprimId)
Returns the material ID bound to the rprim rprimId.
virtual HD_API GfRange3d GetExtent(SdfPath const &id)
Gets the axis aligned bounds of a prim.
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.
HD_API HdSceneDelegate(HdRenderIndex *parentIndex, SdfPath const &delegateID)
Constructor used for nested delegate objects which share a RenderIndex.
virtual HD_API GfMatrix4d GetInstancerTransform(SdfPath const &instancerId)
Returns the instancer transform.
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 delegat...
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 calculati...
virtual HD_API void PostSyncCleanup()
Opportunity for the delegate to clean itself up after performing parallel work during sync phase.
virtual HD_API size_t SampleTransform(SdfPath const &id, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
Store up to maxSampleCount transform samples in *sampleValues.
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...
SdfPath const & GetDelegateID() const
Returns the ID of this delegate, which is used as a prefix for all objects it creates in the RenderIn...
virtual HD_API bool GetDoubleSided(SdfPath const &id)
Returns the doubleSided state for the given prim.
virtual HD_API VtArray< TfToken > GetCategories(SdfPath const &id)
Returns the prim categories.
virtual HD_API void Sync(HdSyncRequestVector *request)
Synchronizes the delegate state for the given request vector.
virtual HD_API HdIdVectorSharedPtr GetCoordSysBindings(SdfPath const &id)
Returns the coordinate system bindings, or a nullptr if none are bound.
virtual HD_API VtValue GetExtComputationInput(SdfPath const &computationId, TfToken const &input)
Returns a single value for a given computation id and input token.
virtual HD_API size_t SampleInstancerTransform(SdfPath const &instancerId, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
Store up to maxSampleCount transform samples in *sampleValues.
HdRenderIndex & GetRenderIndex()
Returns the RenderIndex owned by this delegate.
virtual HD_API void InvokeExtComputation(SdfPath const &computationId, HdExtComputationContext *context)
Requests the scene delegate run the ExtComputation with the given id.
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.
virtual HD_API VtValue Get(SdfPath const &id, TfToken const &key)
Returns a named value.
virtual HD_API VtValue GetIndexedPrimvar(SdfPath const &id, TfToken const &key, VtIntArray *outIndices)
Returns a named primvar value.
virtual HD_API HdExtComputationInputDescriptorVector GetExtComputationInputDescriptors(SdfPath const &computationId)
For the given computation id, returns a list of computation input descriptors.
void SampleTransform(SdfPath const &id, HdTimeSampleArray< GfMatrix4d, CAPACITY > *sa)
Convenience form of SampleTransform() that takes an HdTimeSampleArray.
virtual HD_API HdMeshTopology GetMeshTopology(SdfPath const &id)
Gets the topological mesh data for a given prim.
virtual HD_API HdReprSelector GetReprSelector(SdfPath const &id)
Returns the authored repr (if any) for the given prim.
virtual HD_API PxOsdSubdivTags GetSubdivTags(SdfPath const &id)
Gets the subdivision surface tags (sharpness, holes, etc).
virtual HD_API HdModelDrawMode GetModelDrawMode(SdfPath const &id)
Returns the model draw mode object for the given prim.
virtual HD_API HdBasisCurvesTopology GetBasisCurvesTopology(SdfPath const &id)
Gets the topological curve data for a given prim.
virtual HD_API bool GetVisible(SdfPath const &id)
Returns the authored visible state of the prim.
virtual HD_API std::string GetExtComputationKernel(SdfPath const &computationId)
Returns the kernel source assigned to the computation at the path id.
virtual HD_API std::vector< VtArray< TfToken > > GetInstanceCategories(SdfPath const &instancerId)
Returns the categories for all instances in the instancer.
virtual HD_API HdCullStyle GetCullStyle(SdfPath const &id)
Returns the cullstyle for the given prim.
Contains an asset path and an optional resolved path.
A path value used to locate objects in layers or scenegraphs.
value_type * data()
Direct access to the underlying array.
Token for efficient comparison, assignment, and hashing of known strings.
Represents an arbitrary dimensional rectangular container class.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
#define TF_CODING_ERROR(fmt, args)
Issue an internal programming error, but continue execution.
#define TF_VERIFY(cond, format,...)
Checks a condition and reports an error if it evaluates false.
Describes how the geometry of a prim should be displayed.
bool flatShadingEnabled
Is the prim flat shaded.
bool displacementEnabled
Is the prim displacement shaded.
bool pointsShadingEnabled
Should the prim's points get shaded like surfaces, as opposed to constant shaded?
HdDisplayStyle()
Creates a default DisplayStyle.
bool materialIsFinal
Is this prim exempt from having its material disabled or overridden, for example, when a renderer cho...
HdDisplayStyle(int refineLevel_, bool flatShading=false, bool displacement=true, bool occludedSelectionShowsThrough_=false, bool pointsShadingEnabled_=false, bool materialIsFinal_=false)
Creates a DisplayStyle.
int refineLevel
The prim refine level, in the range [0, 8].
bool occludedSelectionShowsThrough
Does the prim act "transparent" to allow occluded selection to show through?
Describes an output of an ExtComputation.
Extends HdPrimvarDescriptor to describe a primvar that takes data from the output of an ExtComputatio...
An array of a value and its indices sampled over time, in struct-of-arrays layout.
void Resize(unsigned int newSize) override
Resize the internal buffers.
Describes optional alternative imaging behavior for prims.
bool indexed
Optional bool, true if primvar is indexed.
HdInterpolation interpolation
Interpolation (data-sampling rate) of the primvar.
TfToken role
Optional "role" indicating a desired interpretation – for example, to distinguish color/vector/point/...
TfToken name
Name of the primvar.
Describes the allocation structure of a render buffer bprim.
The SceneDelegate is requested to synchronize prims as the result of executing a specific render pass...
An array of a value sampled over time, in struct-of-arrays layout.
virtual void Resize(unsigned int newSize)
Resize the internal buffers.
HdTupleType represents zero, one, or more values of the same HdType.
Description of a single field related to a volume primitive.
std::vector< TfToken > TfTokenVector
Convenience types.