Loading...
Searching...
No Matches
Public Types | Public Attributes | List of all members
HdxPickTaskContextParams Struct Reference

Pick task context params. More...

#include <pickTask.h>

Public Types

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

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

Member Typedef Documentation

◆ DepthMaskCallback

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

Definition at line 260 of file pickTask.h.

Constructor & Destructor Documentation

◆ HdxPickTaskContextParams()

HdxPickTaskContextParams ( )
inline

Definition at line 262 of file pickTask.h.

Member Data Documentation

◆ alphaThreshold

float alphaThreshold

Definition at line 287 of file pickTask.h.

◆ clipPlanes

std::vector<GfVec4d> clipPlanes

Definition at line 284 of file pickTask.h.

◆ collection

HdRprimCollection collection

Definition at line 286 of file pickTask.h.

◆ depthMaskCallback

DepthMaskCallback depthMaskCallback

Definition at line 285 of file pickTask.h.

◆ doUnpickablesOcclude

bool doUnpickablesOcclude

Definition at line 281 of file pickTask.h.

◆ maxNumDeepEntries

int maxNumDeepEntries

Definition at line 278 of file pickTask.h.

◆ outHits

HdxPickHitVector* outHits

Definition at line 288 of file pickTask.h.

◆ pickTarget

TfToken pickTarget

Definition at line 279 of file pickTask.h.

◆ projectionMatrix

GfMatrix4d projectionMatrix

Definition at line 283 of file pickTask.h.

◆ resolution

GfVec2i resolution

Definition at line 277 of file pickTask.h.

◆ resolveMode

TfToken resolveMode

Definition at line 280 of file pickTask.h.

◆ viewMatrix

GfMatrix4d viewMatrix

Definition at line 282 of file pickTask.h.

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