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::System Class Referenceabstract

Physics system global requests. More...

#include <SystemBus.h>

Public Member Functions

 System (System &&)=delete
 
Systemoperator= (System &&)=delete
 
virtual AZStd::shared_ptr< ShapeCreateShape (const ColliderConfiguration &colliderConfiguration, const ShapeConfiguration &configuration)=0
 
virtual void ReleaseNativeHeightfieldObject (void *nativeHeightfieldObject)=0
 
virtual void ReleaseNativeMeshObject (void *nativeMeshObject)=0
 
virtual bool CookConvexMeshToFile (const AZStd::string &filePath, const AZ::Vector3 *vertices, AZ::u32 vertexCount)=0
 
virtual bool CookConvexMeshToMemory (const AZ::Vector3 *vertices, AZ::u32 vertexCount, AZStd::vector< AZ::u8 > &result)=0
 
virtual bool CookTriangleMeshToFile (const AZStd::string &filePath, const AZ::Vector3 *vertices, AZ::u32 vertexCount, const AZ::u32 *indices, AZ::u32 indexCount)=0
 
virtual bool CookTriangleMeshToMemory (const AZ::Vector3 *vertices, AZ::u32 vertexCount, const AZ::u32 *indices, AZ::u32 indexCount, AZStd::vector< AZ::u8 > &result)=0
 

Detailed Description

Physics system global requests.

Member Function Documentation

◆ CookConvexMeshToFile()

virtual bool Physics::System::CookConvexMeshToFile ( const AZStd::string &  filePath,
const AZ::Vector3 *  vertices,
AZ::u32  vertexCount 
)
pure virtual

Cooks a convex mesh and writes it to a file.

Parameters
filePathPath to the output file.
verticesPointer to beginning of vertex data.
vertexCountNumber of vertices in the mesh.
Returns
Succeeded cooking.

◆ CookConvexMeshToMemory()

virtual bool Physics::System::CookConvexMeshToMemory ( const AZ::Vector3 *  vertices,
AZ::u32  vertexCount,
AZStd::vector< AZ::u8 > &  result 
)
pure virtual

Cooks a convex mesh to a memory buffer.

Parameters
verticesPointer to beginning of vertex data.
vertexCountNumber of vertices in the mesh.
resultThe resulting memory buffer.
Returns
Succeeded cooking.

◆ CookTriangleMeshToFile()

virtual bool Physics::System::CookTriangleMeshToFile ( const AZStd::string &  filePath,
const AZ::Vector3 *  vertices,
AZ::u32  vertexCount,
const AZ::u32 *  indices,
AZ::u32  indexCount 
)
pure virtual

Cooks a triangular mesh and writes it to a file.

Parameters
filePathPath to the output file.
verticesPointer to beginning of vertex data.
vertexCountNumber of vertices in the mesh.
indicesPointer to beginning of index data.
indexCountNumber of indices in the mesh.
Returns
Succeeded cooking.

◆ CookTriangleMeshToMemory()

virtual bool Physics::System::CookTriangleMeshToMemory ( const AZ::Vector3 *  vertices,
AZ::u32  vertexCount,
const AZ::u32 *  indices,
AZ::u32  indexCount,
AZStd::vector< AZ::u8 > &  result 
)
pure virtual

Cook a triangular mesh to a memory buffer.

Parameters
verticesPointer to beginning of vertex data.
vertexCountNumber of vertices in the mesh.
indicesPointer to beginning of index data.
indexCountNumber of indices in the mesh.
resultThe resulting memory buffer.
Returns
Succeeded cooking.

◆ ReleaseNativeHeightfieldObject()

virtual void Physics::System::ReleaseNativeHeightfieldObject ( void *  nativeHeightfieldObject)
pure virtual

Releases the height field object created by the physics backend.

Parameters
nativeHeightfieldObjectPointer to the height field object.

◆ ReleaseNativeMeshObject()

virtual void Physics::System::ReleaseNativeMeshObject ( void *  nativeMeshObject)
pure virtual

Releases the mesh object created by the physics backend.

Parameters
nativeMeshObjectPointer to the mesh object.

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