All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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
GfVec3f 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 94 of file pickTask.h.

Member Function Documentation

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

Definition at line 116 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 98 of file pickTask.h.

int HdxPickHit::edgeIndex

Definition at line 108 of file pickTask.h.

int HdxPickHit::elementIndex

Definition at line 107 of file pickTask.h.

int HdxPickHit::instanceIndex

Definition at line 106 of file pickTask.h.

SdfPath HdxPickHit::instancerId

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

Definition at line 105 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 renderTag "widget" for simplicity.

Definition at line 114 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 102 of file pickTask.h.

int HdxPickHit::pointIndex

Definition at line 109 of file pickTask.h.

GfVec3f HdxPickHit::worldSpaceHitNormal

Definition at line 111 of file pickTask.h.

GfVec3f HdxPickHit::worldSpaceHitPoint

Definition at line 110 of file pickTask.h.

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