HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdxPickResult Class Reference

A utility class for resolving ID buffers into hits. More...

#include <pickTask.h>

Public Member Functions

HDX_API HdxPickResult (int const *primIds, int const *instanceIds, int const *elementIds, int const *edgeIds, int const *pointIds, int const *neyes, float const *depths, HdRenderIndex const *index, TfToken const &pickTarget, GfMatrix4d const &viewMatrix, GfMatrix4d const &projectionMatrix, GfVec2f const &depthRange, GfVec2i const &bufferSize, GfVec4i const &subRect)
 
HDX_API ~HdxPickResult ()
 
HDX_API HdxPickResult (HdxPickResult &&)
 
HDX_API HdxPickResultoperator= (HdxPickResult &&)
 
HDX_API bool IsValid () const
 Return whether the result was given well-formed parameters. More...
 
HDX_API void ResolveNearestToCamera (HdxPickHitVector *allHits) const
 
HDX_API void ResolveNearestToCenter (HdxPickHitVector *allHits) const
 
HDX_API void ResolveAll (HdxPickHitVector *allHits) const
 
HDX_API void ResolveUnique (HdxPickHitVector *allHits) const
 

Detailed Description

A utility class for resolving ID buffers into hits.

Definition at line 237 of file pickTask.h.

Constructor & Destructor Documentation

HDX_API HdxPickResult::HdxPickResult ( int const primIds,
int const instanceIds,
int const elementIds,
int const edgeIds,
int const pointIds,
int const neyes,
float const depths,
HdRenderIndex const index,
TfToken const pickTarget,
GfMatrix4d const viewMatrix,
GfMatrix4d const projectionMatrix,
GfVec2f const depthRange,
GfVec2i const bufferSize,
GfVec4i const subRect 
)
HDX_API HdxPickResult::~HdxPickResult ( )
HDX_API HdxPickResult::HdxPickResult ( HdxPickResult &&  )

Member Function Documentation

HDX_API bool HdxPickResult::IsValid ( ) const

Return whether the result was given well-formed parameters.

HDX_API HdxPickResult& HdxPickResult::operator= ( HdxPickResult &&  )
HDX_API void HdxPickResult::ResolveAll ( HdxPickHitVector allHits) const

Return all hit points. Note that this may contain redundant objects, however it allows access to all depth values for a given object.

HDX_API void HdxPickResult::ResolveNearestToCamera ( HdxPickHitVector allHits) const

Return the nearest single hit point. Note that this method may be considerably more efficient, as it only needs to construct a single Hit object.

HDX_API void HdxPickResult::ResolveNearestToCenter ( HdxPickHitVector allHits) const

Return the nearest single hit point from the center of the viewport. Note that this method may be considerably more efficient, as it only needs to construct a single Hit object.

HDX_API void HdxPickResult::ResolveUnique ( HdxPickHitVector allHits) const

Return the set of unique hit points, keeping only the nearest depth value.


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