HdxPickHit Struct Reference

Picking hit structure. More...

Public Member Functions

bool IsValid () const
 
HDX_API size_t GetHash () const
 

Public Attributes

SdfPath delegateId
 delegateID of HdSceneDelegate that provided the picked prim. More...
 
SdfPath objectId
 Path computed from scenePath's in primOrigin data source of picked prim and instancers if provided by scene index. More...
 
SdfPath instancerId
 Only supported for scene delegates, see HdxPrimOriginInfo for scene indices. More...
 
int instanceIndex
 
int elementIndex
 
int edgeIndex
 
int pointIndex
 
GfVec3f worldSpaceHitPoint
 
GfVec3f worldSpaceHitNormal
 
float normalizedDepth
 normalizedDepth is in the range [0,1]. More...
 

Detailed Description

Picking hit structure.

This is output by the pick task as a record of what objects the picking query found.

Definition at line 93 of file pickTask.h.

Member Data Documentation

◆ delegateId

SdfPath delegateId

delegateID of HdSceneDelegate that provided the picked prim.

Irrelevant for scene indices.

Definition at line 97 of file pickTask.h.

◆ instancerId

SdfPath instancerId

Only supported for scene delegates, see HdxPrimOriginInfo for scene indices.

Definition at line 104 of file pickTask.h.

◆ normalizedDepth

float normalizedDepth

normalizedDepth is in the range [0,1].

Nb: the pick depth buffer won't contain items drawn with renderTag "widget" for simplicity.

Definition at line 113 of file pickTask.h.

◆ objectId

SdfPath objectId

Path computed from scenePath's in primOrigin data source of picked prim and instancers if provided by scene index.

Otherwise, path in render index.

Definition at line 101 of file pickTask.h.


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