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.
Physics::DebugDrawSettings Struct Reference

Settings structure provided to DebugDrawPhysics to drive debug drawing behavior. More...

#include <SystemBus.h>

Public Types

using DebugDrawLineCallback = AZStd::function< void(const DebugDrawVertex &from, const DebugDrawVertex &to, const AZStd::shared_ptr< AzPhysics::SimulatedBody > &body, float thickness, void *udata)>
 
using DebugDrawTriangleCallback = AZStd::function< void(const DebugDrawVertex &a, const DebugDrawVertex &b, const DebugDrawVertex &c, const AZStd::shared_ptr< AzPhysics::SimulatedBody > &body, void *udata)>
 
using DebugDrawTriangleBatchCallback = AZStd::function< void(const DebugDrawVertex *verts, AZ::u32 numVerts, const AZ::u32 *indices, AZ::u32 numIndices, const AZStd::shared_ptr< AzPhysics::SimulatedBody > &body, void *udata)>
 

Public Member Functions

void DrawLine (const DebugDrawVertex &from, const DebugDrawVertex &to, const AZStd::shared_ptr< AzPhysics::SimulatedBody > &body, float thickness=1.0f)
 
void DrawTriangleBatch (const DebugDrawVertex *verts, AZ::u32 numVerts, const AZ::u32 *indices, AZ::u32 numIndices, const AZStd::shared_ptr< AzPhysics::SimulatedBody > &body)
 

Public Attributes

DebugDrawLineCallback m_drawLineCB
 Required user callback for line drawing.
 
DebugDrawTriangleBatchCallback m_drawTriBatchCB
 User callback for triangle batch drawing. Required if m_isWireframe is false.
 
bool m_isWireframe = false
 Specifies whether or not physics shapes should be draw as wireframe (lines only) or solid triangles.
 
AZ::u32 m_objectLayers = static_cast<AZ::u32>(~0)
 Mask specifying which AzFramework::Physics::StandardObjectLayers should be drawn.
 
AZ::Vector3 m_cameraPos = AZ::Vector3::CreateZero()
 Camera position, for limiting objects based on m_drawDistance.
 
float m_drawDistance = 500.f
 Distance from m_cameraPos within which objects will be drawn.
 
bool m_drawBodyTransforms = false
 If enabled, draws transform axes for each body.
 
void * m_udata = nullptr
 Platform specific and/or gem specific optional user data pointer.
 

Detailed Description

Settings structure provided to DebugDrawPhysics to drive debug drawing behavior.


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