7#ifndef PXR_IMAGING_HD_SCENE_DELEGATE_H
8#define PXR_IMAGING_HD_SCENE_DELEGATE_H
11#include "pxr/imaging/hd/api.h"
12#include "pxr/imaging/hd/version.h"
14#include "pxr/imaging/hd/aov.h"
15#include "pxr/imaging/hd/basisCurvesTopology.h"
16#include "pxr/imaging/hd/enums.h"
17#include "pxr/imaging/hd/meshTopology.h"
18#include "pxr/imaging/hd/renderIndex.h"
19#include "pxr/imaging/hd/repr.h"
20#include "pxr/imaging/hd/timeSampleArray.h"
26#include "pxr/base/vt/value.h"
28#include "pxr/usd/sdf/path.h"
36PXR_NAMESPACE_OPEN_SCOPE
41typedef std::shared_ptr<SdfPathVector> HdIdVectorSharedPtr;
44typedef std::vector<std::pair<SdfPath, int>> HdInstancerContext;
57 std::vector<HdDirtyBits> dirtyBits;
123 bool flatShading =
false,
124 bool displacement =
true,
125 bool displayInOverlay_ =
false,
126 bool occludedSelectionShowsThrough_ =
false,
127 bool pointsShadingEnabled_ =
false,
128 bool materialIsFinal_ =
false)
137 if (refineLevel_ < 0) {
139 }
else if (refineLevel_ > 8) {
158 return !(*
this == rhs);
180 ,
role(HdPrimvarRoleTokens->none)
184 HdInterpolation interp_,
185 TfToken const& role_=HdPrimvarRoleTokens->none,
194 return !(*
this == rhs);
198typedef std::vector<HdPrimvarDescriptor> HdPrimvarDescriptorVector;
232 : drawMode(HdModelDrawModeTokens->inherited)
233 , applyDrawMode(
false)
235 , cardGeometry(HdModelDrawModeTokens->cross)
241 bool applyDrawMode_=
false,
243 TfToken const& cardGeometry_=HdModelDrawModeTokens->cross,
250 : drawMode(drawMode_), applyDrawMode(applyDrawMode_),
251 drawModeColor(drawModeColor_), cardGeometry(cardGeometry_),
252 cardTextureXPos(cardTextureXPos_), cardTextureYPos(cardTextureYPos_),
253 cardTextureZPos(cardTextureZPos_), cardTextureXNeg(cardTextureXNeg_),
254 cardTextureYNeg(cardTextureYNeg_), cardTextureZNeg(cardTextureZNeg_)
258 return drawMode == rhs.drawMode &&
259 applyDrawMode == rhs.applyDrawMode &&
260 drawModeColor == rhs.drawModeColor &&
261 cardGeometry == rhs.cardGeometry &&
262 cardTextureXPos == rhs.cardTextureXPos &&
263 cardTextureYPos == rhs.cardTextureYPos &&
264 cardTextureZPos == rhs.cardTextureZPos &&
265 cardTextureXNeg == rhs.cardTextureXNeg &&
266 cardTextureYNeg == rhs.cardTextureYNeg &&
267 cardTextureZNeg == rhs.cardTextureZNeg;
270 return !(*
this == rhs);
285 TfToken sourceComputationOutputName;
291 HdInterpolation interp_,
293 SdfPath const & sourceComputationId_,
294 TfToken const & sourceComputationOutputName_,
297 , sourceComputationId(sourceComputationId_)
298 , sourceComputationOutputName(sourceComputationOutputName_)
299 , valueType(valueType_)
302 return HdPrimvarDescriptor::operator==(rhs) &&
303 sourceComputationId == rhs.sourceComputationId &&
304 sourceComputationOutputName == rhs.sourceComputationOutputName &&
305 valueType == rhs.valueType;
308 return !(*
this == rhs);
312typedef std::vector<HdExtComputationPrimvarDescriptor>
313 HdExtComputationPrimvarDescriptorVector;
326 TfToken sourceComputationOutputName;
331 SdfPath const & sourceComputationId_,
332 TfToken const & sourceComputationOutputName_)
333 : name(name_), sourceComputationId(sourceComputationId_)
334 , sourceComputationOutputName(sourceComputationOutputName_)
338 return name == rhs.name &&
339 sourceComputationId == rhs.sourceComputationId &&
340 sourceComputationOutputName == rhs.sourceComputationOutputName;
343 return !(*
this == rhs);
347typedef std::vector<HdExtComputationInputDescriptor>
348 HdExtComputationInputDescriptorVector;
364 : name(name_), valueType(valueType_)
368 return name == rhs.name &&
369 valueType == rhs.valueType;
372 return !(*
this == rhs);
376typedef std::vector<HdExtComputationOutputDescriptor>
377 HdExtComputationOutputDescriptorVector;
391 TfToken const & fieldPrimType_,
393 : fieldName(fieldName_), fieldPrimType(fieldPrimType_), fieldId(fieldId_)
397typedef std::vector<HdVolumeFieldDescriptor>
398 HdVolumeFieldDescriptorVector;
503 VtIntArray *outIndices);
521 virtual std::vector<VtArray<TfToken>>
554 size_t maxSampleCount,
566 size_t maxSampleCount,
573 template <
unsigned int CAPACITY>
582 template <
unsigned int CAPACITY>
607 size_t maxSampleCount,
619 size_t maxSampleCount,
627 template <
unsigned int CAPACITY>
636 template <
unsigned int CAPACITY>
639 float startTime,
float endTime,
670 size_t maxSampleCount,
683 size_t maxSampleCount,
690 template <
unsigned int CAPACITY>
700 template <
unsigned int CAPACITY>
717 size_t maxSampleCount,
720 VtIntArray *sampleIndices);
731 size_t maxSampleCount,
734 VtIntArray *sampleIndices);
740 template <
unsigned int CAPACITY>
750 template <
unsigned int CAPACITY>
804 HdInstancerContext *instancerContext =
nullptr);
813 std::vector<int> instanceIndices,
814 std::vector<HdInstancerContext> *instancerContexts =
nullptr);
866 virtual HdVolumeFieldDescriptorVector
867 GetVolumeFieldDescriptors(
SdfPath const &volumeId);
890 virtual HdExtComputationInputDescriptorVector
898 virtual HdExtComputationOutputDescriptorVector
910 virtual HdExtComputationPrimvarDescriptorVector
912 HdInterpolation interpolationMode);
930 size_t maxSampleCount,
942 size_t maxSampleCount,
950 template <
unsigned int CAPACITY>
959 template <
unsigned int CAPACITY>
992 virtual HdPrimvarDescriptorVector
1010template <
unsigned int CAPACITY>
1014 size_t authoredSamples =
1016 if (authoredSamples > CAPACITY) {
1017 sa->
Resize(authoredSamples);
1018 size_t authoredSamplesSecondAttempt =
1026 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1028 sa->count = authoredSamples;
1031template <
unsigned int CAPACITY>
1037 size_t authoredSamples =
1039 sa->times.
data(), sa->values.
data());
1040 if (authoredSamples > CAPACITY) {
1041 sa->
Resize(authoredSamples);
1042 size_t authoredSamplesSecondAttempt =
1052 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1054 sa->count = authoredSamples;
1057template <
unsigned int CAPACITY>
1062 size_t authoredSamples =
1068 if (authoredSamples > CAPACITY) {
1069 sa->
Resize(authoredSamples);
1070 size_t authoredSamplesSecondAttempt =
1078 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1080 sa->count = authoredSamples;
1083template <
unsigned int CAPACITY>
1087 float startTime,
float endTime,
1089 size_t authoredSamples =
1097 if (authoredSamples > CAPACITY) {
1098 sa->
Resize(authoredSamples);
1099 size_t authoredSamplesSecondAttempt =
1109 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1111 sa->count = authoredSamples;
1114template <
unsigned int CAPACITY>
1119 size_t authoredSamples =
1126 if (authoredSamples > CAPACITY) {
1127 sa->
Resize(authoredSamples);
1128 size_t authoredSamplesSecondAttempt =
1137 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1139 sa->count = authoredSamples;
1142template <
unsigned int CAPACITY>
1149 size_t authoredSamples =
1158 if (authoredSamples > CAPACITY) {
1159 sa->
Resize(authoredSamples);
1160 size_t authoredSamplesSecondAttempt =
1171 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1173 sa->count = authoredSamples;
1176template <
unsigned int CAPACITY>
1181 size_t authoredSamples =
1188 sa->indices.
data());
1189 if (authoredSamples > CAPACITY) {
1190 sa->
Resize(authoredSamples);
1191 size_t authoredSamplesSecondAttempt =
1198 sa->indices.
data());
1201 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1203 sa->count = authoredSamples;
1206template <
unsigned int CAPACITY>
1213 size_t authoredSamples =
1222 sa->indices.
data());
1223 if (authoredSamples > CAPACITY) {
1224 sa->
Resize(authoredSamples);
1225 size_t authoredSamplesSecondAttempt =
1234 sa->indices.
data());
1237 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1239 sa->count = authoredSamples;
1242template <
unsigned int CAPACITY>
1249 computationId, input, CAPACITY,
1250 sa->times.
data(), sa->values.
data());
1252 if (authoredSamples > CAPACITY) {
1253 sa->
Resize(authoredSamples);
1255 computationId, input, authoredSamples,
1256 sa->times.
data(), sa->values.
data());
1259 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1261 sa->count = authoredSamples;
1264template <
unsigned int CAPACITY>
1273 computationId, input, startTime, endTime, CAPACITY,
1274 sa->times.
data(), sa->values.
data());
1276 if (authoredSamples > CAPACITY) {
1277 sa->
Resize(authoredSamples);
1279 computationId, input, startTime, endTime, authoredSamples,
1280 sa->times.
data(), sa->values.
data());
1283 TF_VERIFY(authoredSamples == authoredSamplesSecondAttempt);
1285 sa->count = authoredSamples;
1288PXR_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.
virtual HD_API SdfPath GetInstancerId(SdfPath const &primId)
Returns the parent instancer of the given rprim or instancer.
virtual HD_API size_t SamplePrimvar(SdfPath const &id, TfToken const &key, float startTime, float endTime, size_t maxSampleCount, float *sampleTimes, VtValue *sampleValues)
An overload of SamplePrimvar that takes frame-relative startTime and endTime, rather than relying on ...
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 display style for the given prim.
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 size_t SampleTransform(SdfPath const &id, float startTime, float endTime, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
An overload of SampleTransform that takes frame-relative startTime and endTime, rather than relying o...
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 size_t SampleInstancerTransform(SdfPath const &instancerId, float startTime, float endTime, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
An overload of SampleInstancerTransform that takes frame-relative startTime and endTime,...
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 SampleIndexedPrimvar(SdfPath const &id, TfToken const &key, float startTime, float endTime, size_t maxSampleCount, float *sampleTimes, VtValue *sampleValues, VtIntArray *sampleIndices)
An overload of SampleIndexedPrimvar that takes frame-relative startTime and endTime,...
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.
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 each of the instances in the instancer.
virtual HD_API HdCullStyle GetCullStyle(SdfPath const &id)
Returns the cullstyle for the given prim.
Contains an asset path and optional evaluated and resolved paths.
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.
HdDisplayStyle(int refineLevel_, bool flatShading=false, bool displacement=true, bool displayInOverlay_=false, bool occludedSelectionShowsThrough_=false, bool pointsShadingEnabled_=false, bool materialIsFinal_=false)
Creates a DisplayStyle.
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...
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?
bool displayInOverlay
Is the prim overlayed on top of other prims.
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.
HdModelDrawMode(TfToken const &drawMode_, bool applyDrawMode_=false, GfVec3f drawModeColor_=GfVec3f(0.18), TfToken const &cardGeometry_=HdModelDrawModeTokens->cross, SdfAssetPath cardTextureXPos_=SdfAssetPath(), SdfAssetPath cardTextureYPos_=SdfAssetPath(), SdfAssetPath cardTextureZPos_=SdfAssetPath(), SdfAssetPath cardTextureXNeg_=SdfAssetPath(), SdfAssetPath cardTextureYNeg_=SdfAssetPath(), SdfAssetPath cardTextureZNeg_=SdfAssetPath())
DrawModeColor is specified in the rendering color space.
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.