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

#include <pickTask.h>

Public Types

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

Public Member Functions

 HdxPickTaskContextParams ()
 

Public Attributes

GfVec2i resolution
 
TfToken pickTarget
 
TfToken resolveMode
 
bool doUnpickablesOcclude
 
GfMatrix4d viewMatrix
 
GfMatrix4d projectionMatrix
 
std::vector< GfVec4d > clipPlanes
 
DepthMaskCallback depthMaskCallback
 
HdRprimCollection collection
 
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.

Definition at line 234 of file pickTask.h.

Member Typedef Documentation

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

Definition at line 236 of file pickTask.h.

Constructor & Destructor Documentation

HdxPickTaskContextParams::HdxPickTaskContextParams ( )
inline

Definition at line 238 of file pickTask.h.

Member Data Documentation

std::vector<GfVec4d> HdxPickTaskContextParams::clipPlanes

Definition at line 257 of file pickTask.h.

HdRprimCollection HdxPickTaskContextParams::collection

Definition at line 259 of file pickTask.h.

DepthMaskCallback HdxPickTaskContextParams::depthMaskCallback

Definition at line 258 of file pickTask.h.

bool HdxPickTaskContextParams::doUnpickablesOcclude

Definition at line 254 of file pickTask.h.

HdxPickHitVector* HdxPickTaskContextParams::outHits

Definition at line 260 of file pickTask.h.

TfToken HdxPickTaskContextParams::pickTarget

Definition at line 252 of file pickTask.h.

GfMatrix4d HdxPickTaskContextParams::projectionMatrix

Definition at line 256 of file pickTask.h.

GfVec2i HdxPickTaskContextParams::resolution

Definition at line 251 of file pickTask.h.

TfToken HdxPickTaskContextParams::resolveMode

Definition at line 253 of file pickTask.h.

GfMatrix4d HdxPickTaskContextParams::viewMatrix

Definition at line 255 of file pickTask.h.

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