HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
HdxPickHit Struct Reference

#include <pickTask.h>

Public Member Functions

bool IsValid () const
 
HDX_API size_t GetHash () const
 

Public Attributes

SdfPath delegateId
 
SdfPath objectId
 
SdfPath instancerId
 
int instanceIndex
 
int elementIndex
 
int edgeIndex
 
int pointIndex
 
GfVec3d worldSpaceHitPoint
 
GfVec3f worldSpaceHitNormal
 
float normalizedDepth
 

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 78 of file pickTask.h.

Member Function Documentation

HDX_API size_t HdxPickHit::GetHash ( ) const
bool HdxPickHit::IsValid ( ) const
inline

Definition at line 100 of file pickTask.h.

Member Data Documentation

SdfPath HdxPickHit::delegateId

delegateID of HdSceneDelegate that provided the picked prim. Irrelevant for scene indices.

Definition at line 82 of file pickTask.h.

int HdxPickHit::edgeIndex

Definition at line 92 of file pickTask.h.

int HdxPickHit::elementIndex

Definition at line 91 of file pickTask.h.

int HdxPickHit::instanceIndex

Definition at line 90 of file pickTask.h.

SdfPath HdxPickHit::instancerId

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

Definition at line 89 of file pickTask.h.

float HdxPickHit::normalizedDepth

normalizedDepth is in the range [0,1]. Nb: the pick depth buffer won't contain items drawn with materialTag "displayInOverlay" for simplicity.

Definition at line 98 of file pickTask.h.

SdfPath HdxPickHit::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 86 of file pickTask.h.

int HdxPickHit::pointIndex

Definition at line 93 of file pickTask.h.

GfVec3f HdxPickHit::worldSpaceHitNormal

Definition at line 95 of file pickTask.h.

GfVec3d HdxPickHit::worldSpaceHitPoint

Definition at line 94 of file pickTask.h.

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