Loading...
Searching...
No Matches
HdxFreeCameraSceneDelegate Class Reference

A simple scene delegate adding a camera prim to the given render index. More...

#include <freeCameraSceneDelegate.h>

+ Inheritance diagram for HdxFreeCameraSceneDelegate:

Public Member Functions

HDX_API HdxFreeCameraSceneDelegate (HdRenderIndex *renderIndex, SdfPath const &delegateId)
 Constructs delegate and adds camera to render index if cameras are supported by render delegate.
 
const SdfPathGetCameraId () const
 Path of added camera (in render index).
 
HDX_API void SetCamera (const GfCamera &camera)
 Set state of camera from GfCamera.
 
HDX_API void SetWindowPolicy (CameraUtilConformWindowPolicy policy)
 Set window policy of camera.
 
HDX_API void SetMatrices (GfMatrix4d const &viewMatrix, GfMatrix4d const &projMatrix)
 For transition, set camera state from OpenGL-style view and projection matrix.
 
HDX_API void SetClipPlanes (std::vector< GfVec4f > const &clipPlanes)
 For transition, set clip planes for camera. GfCamera is preferred.
 
HDX_API GfMatrix4d GetTransform (SdfPath const &id) override
 Returns the object space transform, including all parent transforms.
 
HDX_API VtValue GetCameraParamValue (SdfPath const &id, TfToken const &key) override
 Returns a single value for a given camera and parameter.
 
- Public Member Functions inherited from HdSceneDelegate
HD_API HdSceneDelegate (HdRenderIndex *parentIndex, SdfPath const &delegateID)
 Constructor used for nested delegate objects which share a RenderIndex.
 
HdRenderIndexGetRenderIndex ()
 Returns the RenderIndex owned by this delegate.
 
SdfPath const & GetDelegateID () const
 Returns the ID of this delegate, which is used as a prefix for all objects it creates in the RenderIndex.
 
virtual HD_API void Sync (HdSyncRequestVector *request)
 Synchronizes the delegate state for the given request vector.
 
virtual HD_API void PostSyncCleanup ()
 Opportunity for the delegate to clean itself up after performing parallel work during sync phase.
 
virtual HD_API bool IsEnabled (TfToken const &option) const
 Returns true if the named option is enabled by the delegate.
 
virtual HD_API HdMeshTopology GetMeshTopology (SdfPath const &id)
 Gets the topological mesh data for a given prim.
 
virtual HD_API HdBasisCurvesTopology GetBasisCurvesTopology (SdfPath const &id)
 Gets the topological curve data for a given prim.
 
virtual HD_API PxOsdSubdivTags GetSubdivTags (SdfPath const &id)
 Gets the subdivision surface tags (sharpness, holes, etc).
 
virtual HD_API GfRange3d GetExtent (SdfPath const &id)
 Gets the axis aligned bounds of a prim.
 
virtual HD_API bool GetVisible (SdfPath const &id)
 Returns the authored visible state of the prim.
 
virtual HD_API bool GetDoubleSided (SdfPath const &id)
 Returns the doubleSided state for the given prim.
 
virtual HD_API HdCullStyle GetCullStyle (SdfPath const &id)
 Returns the cullstyle for the given prim.
 
virtual HD_API VtValue GetShadingStyle (SdfPath const &id)
 Returns the shading style for the given prim.
 
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 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 HdReprSelector GetReprSelector (SdfPath const &id)
 Returns the authored repr (if any) for the given prim.
 
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 VtArray< TfTokenGetCategories (SdfPath const &id)
 Returns the prim categories.
 
virtual HD_API std::vector< VtArray< TfToken > > GetInstanceCategories (SdfPath const &instancerId)
 Returns the categories for all instances in the instancer.
 
virtual HD_API HdIdVectorSharedPtr GetCoordSysBindings (SdfPath const &id)
 Returns the coordinate system bindings, or a nullptr if none are bound.
 
virtual HD_API HdModelDrawMode GetModelDrawMode (SdfPath const &id)
 Returns the model draw mode object for the given prim.
 
virtual HD_API size_t SampleTransform (SdfPath const &id, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
 Store up to maxSampleCount transform samples in *sampleValues.
 
template<unsigned int CAPACITY>
void SampleTransform (SdfPath const &id, HdTimeSampleArray< GfMatrix4d, CAPACITY > *sa)
 Convenience form of SampleTransform() that takes an HdTimeSampleArray.
 
virtual HD_API size_t SampleInstancerTransform (SdfPath const &instancerId, size_t maxSampleCount, float *sampleTimes, GfMatrix4d *sampleValues)
 Store up to maxSampleCount transform samples in *sampleValues.
 
template<unsigned int CAPACITY>
void SampleInstancerTransform (SdfPath const &instancerId, HdTimeSampleArray< GfMatrix4d, CAPACITY > *sa)
 Convenience form of SampleInstancerTransform() that takes an HdTimeSampleArray.
 
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.
 
template<unsigned int CAPACITY>
void SamplePrimvar (SdfPath const &id, TfToken const &key, HdTimeSampleArray< VtValue, CAPACITY > *sa)
 Convenience form of SamplePrimvar() that takes an HdTimeSampleArray.
 
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.
 
template<unsigned int CAPACITY>
void SampleIndexedPrimvar (SdfPath const &id, TfToken const &key, HdIndexedTimeSampleArray< VtValue, CAPACITY > *sa)
 Convenience form of SampleIndexedPrimvar() that takes HdTimeSampleArrays.
 
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 GfMatrix4d GetInstancerTransform (SdfPath const &instancerId)
 Returns the instancer transform.
 
virtual HD_API SdfPath GetInstancerId (SdfPath const &primId)
 Returns the parent instancer of the given rprim or instancer.
 
virtual HD_API SdfPathVector GetInstancerPrototypes (SdfPath const &instancerId)
 Returns a list of prototypes of this instancer.
 
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 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 calculations across a number of path evaluations in a single call.
 
virtual HD_API SdfPath GetMaterialId (SdfPath const &rprimId)
 Returns the material ID bound to the rprim rprimId.
 
virtual HD_API VtValue GetMaterialResource (SdfPath const &materialId)
 
virtual HD_API HdRenderBufferDescriptor GetRenderBufferDescriptor (SdfPath const &id)
 Returns the allocation descriptor for a given render buffer prim.
 
virtual HD_API VtValue GetLightParamValue (SdfPath const &id, TfToken const &paramName)
 
virtual HD_API HdVolumeFieldDescriptorVector GetVolumeFieldDescriptors (SdfPath const &volumeId)
 
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 delegate using the Get() method.
 
virtual HD_API HdExtComputationInputDescriptorVector GetExtComputationInputDescriptors (SdfPath const &computationId)
 For the given computation id, returns a list of computation input descriptors.
 
virtual HD_API HdExtComputationOutputDescriptorVector GetExtComputationOutputDescriptors (SdfPath const &computationId)
 For the given computation id, returns a list of computation output descriptors.
 
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 the given prim id and interpolation mode.
 
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 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.
 
template<unsigned int CAPACITY>
void SampleExtComputationInput (SdfPath const &computationId, TfToken const &input, HdTimeSampleArray< VtValue, CAPACITY > *sa)
 Convenience form of SampleExtComputationInput() that takes an HdTimeSampleArray.
 
virtual HD_API std::string GetExtComputationKernel (SdfPath const &computationId)
 Returns the kernel source assigned to the computation at the path id.
 
virtual HD_API void InvokeExtComputation (SdfPath const &computationId, HdExtComputationContext *context)
 Requests the scene delegate run the ExtComputation with the given id.
 
virtual HD_API HdPrimvarDescriptorVector GetPrimvarDescriptors (SdfPath const &id, HdInterpolation interpolation)
 Returns descriptors for all primvars of the given interpolation type.
 
virtual HD_API TfTokenVector GetTaskRenderTags (SdfPath const &taskId)
 

Detailed Description

A simple scene delegate adding a camera prim to the given render index.

Definition at line 42 of file freeCameraSceneDelegate.h.

Constructor & Destructor Documentation

◆ HdxFreeCameraSceneDelegate()

HDX_API HdxFreeCameraSceneDelegate ( HdRenderIndex renderIndex,
SdfPath const &  delegateId 
)

Constructs delegate and adds camera to render index if cameras are supported by render delegate.

Member Function Documentation

◆ GetCameraId()

const SdfPath & GetCameraId ( ) const
inline

Path of added camera (in render index).

Empty if cameras are not supported by render delegate.

Definition at line 56 of file freeCameraSceneDelegate.h.

◆ GetCameraParamValue()

HDX_API VtValue GetCameraParamValue ( SdfPath const &  cameraId,
TfToken const &  paramName 
)
overridevirtual

Returns a single value for a given camera and parameter.

See HdCameraTokens for the list of paramters.

Reimplemented from HdSceneDelegate.

◆ GetTransform()

HDX_API GfMatrix4d GetTransform ( SdfPath const &  id)
overridevirtual

Returns the object space transform, including all parent transforms.

Reimplemented from HdSceneDelegate.

◆ SetCamera()

HDX_API void SetCamera ( const GfCamera camera)

Set state of camera from GfCamera.

◆ SetClipPlanes()

HDX_API void SetClipPlanes ( std::vector< GfVec4f > const &  clipPlanes)

For transition, set clip planes for camera. GfCamera is preferred.

◆ SetMatrices()

HDX_API void SetMatrices ( GfMatrix4d const &  viewMatrix,
GfMatrix4d const &  projMatrix 
)

For transition, set camera state from OpenGL-style view and projection matrix.

GfCamera is preferred.

◆ SetWindowPolicy()

HDX_API void SetWindowPolicy ( CameraUtilConformWindowPolicy  policy)

Set window policy of camera.


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