PhysX SDK 3.2 API Reference: Scenequery

PhysX SDK 3.2 API

Scenequery


Classes

class  PxBatchQuery
 Batched queries object. This is used to perform several queries at the same time. More...
struct  PxSceneQueryFilterFlag
 Filtering flags for scene queries. More...
struct  PxSceneQueryHitType
 Classification of scene query hits. More...
struct  PxSceneQueryFilterData
 Scene query filtering data. More...
class  PxSceneQueryFilterCallback
 Scene query filtering callbacks. More...
struct  PxSceneQueryFlag
 Scene query specification. More...
struct  PxSceneQueryHit
 Scene query hit information. More...
struct  PxSceneQueryImpactHit
 Scene query hit information for queries with impacts. More...
struct  PxSweepHit
 This structure captures results for a single sweep query. More...
struct  PxRaycastHit
 Raycast hit information. More...
struct  PxSceneQueryReportResult
 Specifies the behaviour after a query result. More...
class  PxSweepCache

Typedefs

typedef PxFlags
< PxSceneQueryFilterFlag::Enum,
PxU16
PxSceneQueryFilterFlags
 Collection of set bits defined in PxSceneQueryFilterFlag.
typedef PxSceneQueryHitType::Enum(* PxBatchQueryPreFilterShader )(PxFilterData filterData0, PxFilterData filterData1, const void *constantBlock, PxU32 constantBlockSize, PxSceneQueryFilterFlags &filterFlags)
 Batched query prefiltering shader.
typedef PxSceneQueryHitType::Enum(* PxBatchQueryPostFilterShader )(PxFilterData filterData0, PxFilterData filterData1, const void *constantBlock, PxU32 constantBlockSize, const PxSceneQueryHit &hit)
 Batched query postfiltering shader.
typedef PxFlags
< PxSceneQueryFlag::Enum
PxSceneQueryFlags
 collection of set bits defined in PxSceneQueryFlag.

Functions

 PX_COMPILE_TIME_ASSERT (PxSceneQueryFilterFlag::eSTATIC==(1<< 0))
 PX_COMPILE_TIME_ASSERT (PxSceneQueryFilterFlag::eDYNAMIC==(1<< 1))
 PX_FLAGS_OPERATORS (PxSceneQueryFilterFlag::Enum, PxU16)
 PX_FLAGS_OPERATORS (PxSceneQueryFlag::Enum, PxU32)
 PX_COMPILE_TIME_ASSERT (0==(sizeof(PxRaycastHit)&0x0f))

Typedef Documentation

typedef PxSceneQueryHitType::Enum(* PxBatchQueryPostFilterShader)(PxFilterData filterData0, PxFilterData filterData1, const void *constantBlock, PxU32 constantBlockSize, const PxSceneQueryHit &hit)

Batched query postfiltering shader.

Custom filtering logic for batched query intersection candidates. If an intersection candidate object passes the data based filter (see PxSceneQueryFilterData), the filtering shader run on request (see PxSceneQueryFilterData.flags)

Filtering shaders are not in order along the query direction, rather they are processed in the order in which candidate shapes for testing are found by PhysX' scene traversal algorithms.

See also:
PxBatchQueryDesc.postFilterShader PxSceneQueryFilterCallback.postFilter PxBatchQueryPreFilterShader
Parameters:
[in] filterData0 The custom filter data of the query
[in] filterData1 The custom filter data of the shape
[in] constantBlock The constant global filter data (see PxBatchQuery)
[in] constantBlockSize Size of the global filter data (see PxBatchQuery)
[in] hit declaration.
See also:
PxBatchQueryPreFilterShader

typedef PxSceneQueryHitType::Enum(* PxBatchQueryPreFilterShader)(PxFilterData filterData0, PxFilterData filterData1, const void *constantBlock, PxU32 constantBlockSize, PxSceneQueryFilterFlags &filterFlags)

Batched query prefiltering shader.

Custom filtering logic for batched query intersection candidates. If an intersection candidate object passes the data based filter (see PxSceneQueryFilterData), the filtering shader run on request (see PxSceneQueryFilterData.flags)

The PxBatchQueryPreFilterShader may overwrite the copy of filterFlags passed in, in order to specify PxSceneQueryFilterFlag::eBACKFACE and PxSceneQueryFilterFlag::eMESH_MULTIPLE on a per-shap basis. Changes apply only to the shape being filtered, and changes to other flags are ignored.

Filtering shaders are not in order along the query direction, rather they are processed in the order in which candidate shapes for testing are found by PhysX' scene traversal algorithms.

See also:
PxBatchQueryDesc.preFilterShader PxSceneQueryFilterCallback.preFilter PxBatchQueryPostFilterShader
Parameters:
[in] filterData0 The custom filter data of the query
[in] filterData1 The custom filter data of the second object
[in] constantBlock The constant global filter data (see PxBatchQuery)
[in] constantBlockSize Size of the global filter data (see PxBatchQuery)
[out] filterFlags Flags giving additional information on how an accepted pair should get processed
Returns:
Hit declaration.
See also:
PxBatchQueryPostFilterShader

Collection of set bits defined in PxSceneQueryFilterFlag.

See also:
PxSceneQueryFilter

collection of set bits defined in PxSceneQueryFlag.

See also:
PxSceneQueryFlag


Function Documentation

PX_COMPILE_TIME_ASSERT ( = =(sizeof(PxRaycastHit)&0x0f)  ) 

PX_COMPILE_TIME_ASSERT ( PxSceneQueryFilterFlag::eDYNAMIC  = =(1<< 1)  ) 

PX_COMPILE_TIME_ASSERT ( PxSceneQueryFilterFlag::eSTATIC  = =(1<< 0)  ) 

PX_FLAGS_OPERATORS ( PxSceneQueryFlag::Enum  ,
PxU32   
)

PX_FLAGS_OPERATORS ( PxSceneQueryFilterFlag::Enum  ,
PxU16   
)



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com