HdxPickTaskContextParams Struct Reference

#include <pickTask.h>

Public Types
using	DepthMaskCallback = std::function< void(void)>

Public Member Functions
	HdxPickTaskContextParams ()

Public Attributes
GfVec2i	resolution
int	maxNumDeepEntries
TfToken	pickTarget
TfToken	resolveMode
bool	doUnpickablesOcclude
GfMatrix4d	viewMatrix
GfMatrix4d	projectionMatrix
std::vector< GfVec4d >	clipPlanes
DepthMaskCallback	depthMaskCallback
HdRprimCollection	collection
float	alphaThreshold
HdxPickHitVector *	outHits

Detailed Description

Pick task context params. This contains task params that can't come from the scene delegate (like resolution mode and pick location, that might be resolved late), as well as the picking collection and the output hit vector. 'pickTarget': The target of the pick operation, which may influence the data filled in the HdxPickHit(s). The available options are: HdxPickTokens->pickPrimsAndInstances HdxPickTokens->pickFaces HdxPickTokens->pickEdges HdxPickTokens->pickPoints HdxPickTokens->pickPointsAndInstances

'resolveMode': Dictates the resolution of which hit(s) are returned in 'outHits'. The available options are:

1. HdxPickTokens->resolveNearestToCamera : Returns the hit whose position is nearest to the camera
2. HdxPickTokens->resolveNearestToCenter : Returns the hit whose position is nearest to center of the pick location/region.
3. HdxPickTokens->resolveUnique : Returns the unique hits, by hashing the relevant member fields of HdxPickHit. The 'pickTarget' influences this operation. For e.g., the subprim indices are ignored when the pickTarget is pickPrimsAndInstances.
4. HdxPickTokens->resolveAll: Returns all the hits for the pick location or region. The number of hits returned depends on the resolution used and may have duplicates.
5. HdxPickTokens->resolveDeep: Returns the unique hits not only of visible geometry but also of all the geometry hiding behind. The 'pickTarget' influences this operation. For e.g., the subprim indices are ignored when the pickTarget is pickPrimsAndInstances.

Definition at line 242 of file pickTask.h.

Member Typedef Documentation

using HdxPickTaskContextParams::DepthMaskCallback = std::function<void(void)>

Definition at line 244 of file pickTask.h.

Constructor & Destructor Documentation

HdxPickTaskContextParams::HdxPickTaskContextParams ( )

inline

Definition at line 246 of file pickTask.h.

Member Data Documentation

float HdxPickTaskContextParams::alphaThreshold

Definition at line 271 of file pickTask.h.

std::vector<GfVec4d> HdxPickTaskContextParams::clipPlanes

Definition at line 268 of file pickTask.h.

HdRprimCollection HdxPickTaskContextParams::collection

Definition at line 270 of file pickTask.h.

DepthMaskCallback HdxPickTaskContextParams::depthMaskCallback

Definition at line 269 of file pickTask.h.

bool HdxPickTaskContextParams::doUnpickablesOcclude

Definition at line 265 of file pickTask.h.

int HdxPickTaskContextParams::maxNumDeepEntries

Definition at line 262 of file pickTask.h.

HdxPickHitVector* HdxPickTaskContextParams::outHits

Definition at line 272 of file pickTask.h.

TfToken HdxPickTaskContextParams::pickTarget

Definition at line 263 of file pickTask.h.

GfMatrix4d HdxPickTaskContextParams::projectionMatrix

Definition at line 267 of file pickTask.h.

GfVec2i HdxPickTaskContextParams::resolution

Definition at line 261 of file pickTask.h.

TfToken HdxPickTaskContextParams::resolveMode

Definition at line 264 of file pickTask.h.

GfMatrix4d HdxPickTaskContextParams::viewMatrix

Definition at line 266 of file pickTask.h.

---

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

• pxr/imaging/hdx/pickTask.h