Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzPhysics::OverlapRequest Struct Referencefinal

Searches a region enclosed by a specified shape for any overlapping objects in the scene. More...

#include <PhysicsSceneQueries.h>

Inherits AzPhysics::SceneQueryRequest.

Public Member Functions

 AZ_RTTI (OverlapRequest, "{3DC986C2-316B-4C54-A0A6-8ABBB8ABCC4A}", SceneQueryRequest)
 
- Public Member Functions inherited from AzPhysics::SceneQueryRequest
 AZ_RTTI (SceneQueryRequest, "{76ECAB7D-42BA-461F-82E6-DCED8E1BDCB9}")
 
 SceneQueryRequest (RequestType requestType)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from AzPhysics::SceneQueryRequest
static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

 AZ_CLASS_ALLOCATOR_DECL
 
AZ::Transform m_pose = AZ::Transform::CreateIdentity()
 Initial shape pose.
 
AZStd::shared_ptr< Physics::ShapeConfigurationm_shapeConfiguration
 Shape information.
 
SceneQuery::OverlapFilterCallback m_filterCallback = nullptr
 Hit filtering function.
 
SceneQuery::UnboundedOverlapHitCallback m_unboundedOverlapHitCallback = nullptr
 When not nullptr the request will perform an unbounded overlap query.
 
- Public Attributes inherited from AzPhysics::SceneQueryRequest
 AZ_CLASS_ALLOCATOR_DECL
 
RequestType m_requestType = RequestType::Undefined
 
AZ::u32 m_maxResults = 32
 The Maximum results for this request to return, this is limited by the value set in the SceneConfiguration.
 
CollisionGroup m_collisionGroup = CollisionGroup::All
 Collision filter for the query.
 
SceneQuery::QueryType m_queryType = SceneQuery::QueryType::StaticAndDynamic
 Object types to include in the query.
 

Additional Inherited Members

- Public Types inherited from AzPhysics::SceneQueryRequest
enum class  RequestType : AZ::u8 { Undefined = 0 , Raycast , Shapecast , Overlap }
 

Detailed Description

Searches a region enclosed by a specified shape for any overlapping objects in the scene.


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