Picking hit structure. More...

#include <pickTask.h>

Public Member Functions
bool	IsValid () const

HDX_API size_t	GetHash () const

Public Attributes
SdfPath	delegateId
	delegateID of HdSceneDelegate that provided the picked prim.

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

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

int	instanceIndex

int	elementIndex

int	edgeIndex

int	pointIndex

GfVec3d	worldSpaceHitPoint

GfVec3f	worldSpaceHitNormal

float	normalizedDepth
	normalizedDepth is in the range [0,1].

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

Member Function Documentation

◆ IsValid()

bool IsValid ( ) const

inline

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

◆ edgeIndex

int edgeIndex

Definition at line 90 of file pickTask.h.

◆ elementIndex

int elementIndex

Definition at line 89 of file pickTask.h.

◆ instanceIndex

int instanceIndex

Definition at line 88 of file pickTask.h.

◆ instancerId

SdfPath instancerId

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

Definition at line 87 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 materialTag "displayInOverlay" for simplicity.

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

◆ pointIndex

int pointIndex

Definition at line 91 of file pickTask.h.

◆ worldSpaceHitNormal

GfVec3f worldSpaceHitNormal

Definition at line 93 of file pickTask.h.

◆ worldSpaceHitPoint

GfVec3d worldSpaceHitPoint

Definition at line 92 of file pickTask.h.

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

pxr/imaging/hdx/pickTask.h

Public Member Functions

Public Attributes