#include <PhysicsWorldModule.h>

Inheritance diagram for ezPhysicsWorldModuleInterface:

[legend]

Classes
struct	FixedJointConfig

struct	JointConfig

Public Member Functions
virtual ezUInt32	GetCollisionLayerByName (ezStringView sName) const =0
	Searches for a collision layer with the given name and returns its index.

virtual ezUInt8	GetWeightCategoryByName (ezStringView sName) const =0
	Searches for a weight category with the given name and returns its key.

virtual ezUInt8	GetImpulseTypeByName (ezStringView sName) const =0
	Searches for an impulse type with the given name and returns its key.

virtual bool	Raycast (ezPhysicsCastResult &out_result, const ezVec3 &vStart, const ezVec3 &vDir, float fDistance, const ezPhysicsQueryParameters &params, ezPhysicsHitCollection collection=ezPhysicsHitCollection::Closest) const =0

virtual bool	RaycastAll (ezPhysicsCastResultArray &out_results, const ezVec3 &vStart, const ezVec3 &vDir, float fDistance, const ezPhysicsQueryParameters &params) const =0

virtual bool	SweepTestSphere (ezPhysicsCastResult &out_result, float fSphereRadius, const ezVec3 &vStart, const ezVec3 &vDir, float fDistance, const ezPhysicsQueryParameters &params, ezPhysicsHitCollection collection=ezPhysicsHitCollection::Closest) const =0

virtual bool	SweepTestBox (ezPhysicsCastResult &out_result, const ezVec3 &vBoxExtents, const ezTransform &transform, const ezVec3 &vDir, float fDistance, const ezPhysicsQueryParameters &params, ezPhysicsHitCollection collection=ezPhysicsHitCollection::Closest) const =0

virtual bool	SweepTestCapsule (ezPhysicsCastResult &out_result, float fCapsuleRadius, float fCapsuleHeight, const ezTransform &transform, const ezVec3 &vDir, float fDistance, const ezPhysicsQueryParameters &params, ezPhysicsHitCollection collection=ezPhysicsHitCollection::Closest) const =0

virtual bool	SweepTestCylinder (ezPhysicsCastResult &out_result, float fCylinderRadius, float fCylinderHeight, const ezTransform &transform, const ezVec3 &vDir, float fDistance, const ezPhysicsQueryParameters &params, ezPhysicsHitCollection collection=ezPhysicsHitCollection::Closest) const =0

virtual bool	OverlapTestSphere (float fSphereRadius, const ezVec3 &vPosition, const ezPhysicsQueryParameters &params) const =0

virtual bool	OverlapTestBox (const ezVec3 &vBoxExtents, const ezVec3 &vPosition, const ezTransform &transform, const ezPhysicsQueryParameters &params) const =0

virtual bool	OverlapTestCapsule (float fCapsuleRadius, float fCapsuleHeight, const ezTransform &transform, const ezPhysicsQueryParameters &params) const =0

virtual bool	OverlapTestCylinder (float fCylinderRadius, float fCylinderHeight, const ezTransform &transform, const ezPhysicsQueryParameters &params) const =0

virtual void	QueryShapesInSphere (ezPhysicsOverlapResultArray &out_results, float fSphereRadius, const ezVec3 &vPosition, const ezPhysicsQueryParameters &params) const =0

virtual void	QueryShapesInBox (ezPhysicsOverlapResultArray &out_results, const ezVec3 &vBoxExtents, const ezTransform &transform, const ezPhysicsQueryParameters &params) const =0

virtual void	QueryShapesInCapsule (ezPhysicsOverlapResultArray &out_results, float fCapsuleRadius, float fCapsuleHeight, const ezTransform &transform, const ezPhysicsQueryParameters &params) const =0

virtual void	QueryShapesInCylinder (ezPhysicsOverlapResultArray &out_results, float fCylinderRadius, float fCylinderHeight, const ezTransform &transform, const ezPhysicsQueryParameters &params) const =0

virtual ezVec3	GetGravity () const =0

virtual void	AddStaticCollisionBox (ezGameObject *pOwner, ezVec3 vBoxSize)
	Adds a static actor with a box shape to pOwner.

virtual void	AddFixedJointComponent (ezGameObject *pOwner, const ezPhysicsWorldModuleInterface::FixedJointConfig &cfg)
	Adds a fixed joint to pOwner.

virtual ezBoundingBoxSphere	GetWorldSpaceBounds (ezGameObject *pOwner, ezUInt32 uiCollisionLayer, ezBitflags< ezPhysicsShapeType > shapeTypes, bool bIncludeChildObjects) const
	Gets world space bounds of a physics object if its shape type is included in shapeTypes and its collision layer interacts with uiCollisionLayer.

Public Member Functions inherited from ezWorldModule
ezWorld *	GetWorld ()
	Returns the corresponding world to this module.

const ezWorld *	GetWorld () const
	Returns the corresponding world to this module.

ezUInt32	GetWorldIndex () const
	Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Protected Member Functions
	ezPhysicsWorldModuleInterface (ezWorld *pWorld)

Protected Member Functions inherited from ezWorldModule
	ezWorldModule (ezWorld *pWorld)

void	RegisterUpdateFunction (const UpdateFunctionDesc &desc)
	Registers the given update function at the world.

void	DeregisterUpdateFunction (const UpdateFunctionDesc &desc)
	De-registers the given update function from the world. Note that only the m_Function and the m_Phase of the description have to be valid for de-registration.

ezAllocator *	GetAllocator ()
	Returns the allocator used by the world.

ezInternal::WorldLargeBlockAllocator *	GetBlockAllocator ()
	Returns the block allocator used by the world.

bool	GetWorldSimulationEnabled () const
	Returns whether the world simulation is enabled.

virtual void	Initialize ()
	This method is called after the constructor. A derived type can override this method to do initialization work. Typically this is the method where updates function are registered.

virtual void	Deinitialize ()
	This method is called before the destructor. A derived type can override this method to do deinitialization work.

virtual void	OnSimulationStarted ()
	This method is called at the start of the next world update when the world is simulated. This method will be called after the initialization method.

virtual void	WorldClear ()
	Called by ezWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Protected Types inherited from ezWorldModule
using	UpdateFunction = ezDelegate< void(const UpdateContext &)>
	Update function delegate.

Protected Attributes inherited from ezWorldModule
ezWorld *	m_pWorld

Detailed Description

Interface for physics world modules that provide physics simulation and queries.

Physics world modules implement physics functionality for a world, including collision detection, raycasting, and shape queries. Different physics engines can provide their own implementations of this interface.

Member Function Documentation

◆ AddFixedJointComponent()

virtual void ezPhysicsWorldModuleInterface::AddFixedJointComponent	(	ezGameObject *	pOwner,
		const ezPhysicsWorldModuleInterface::FixedJointConfig &	cfg
	)

inlinevirtual

Adds a fixed joint to pOwner.

Reimplemented in ezJoltWorldModule.

◆ AddStaticCollisionBox()

virtual void ezPhysicsWorldModuleInterface::AddStaticCollisionBox	(	ezGameObject *	pOwner,
		ezVec3	vBoxSize
	)

inlinevirtual

Adds a static actor with a box shape to pOwner.

Reimplemented in ezJoltWorldModule.

◆ GetCollisionLayerByName()

virtual ezUInt32 ezPhysicsWorldModuleInterface::GetCollisionLayerByName ( ezStringView sName ) const

pure virtual

Searches for a collision layer with the given name and returns its index.

Returns ezInvalidIndex if no such collision layer exists.

Implemented in ezJoltWorldModule.

◆ GetImpulseTypeByName()

virtual ezUInt8 ezPhysicsWorldModuleInterface::GetImpulseTypeByName ( ezStringView sName ) const

pure virtual

Searches for an impulse type with the given name and returns its key.

Returns ezImpulseTypeConfig::InvalidKey if no such category exists.

Implemented in ezJoltWorldModule.

◆ GetWeightCategoryByName()

virtual ezUInt8 ezPhysicsWorldModuleInterface::GetWeightCategoryByName ( ezStringView sName ) const

pure virtual

Searches for a weight category with the given name and returns its key.

Returns ezWeightCategoryConfig::InvalidKey if no such category exists.

Implemented in ezJoltWorldModule.

◆ GetWorldSpaceBounds()

virtual ezBoundingBoxSphere ezPhysicsWorldModuleInterface::GetWorldSpaceBounds	(	ezGameObject *	pOwner,
		ezUInt32	uiCollisionLayer,
		ezBitflags< ezPhysicsShapeType >	shapeTypes,
		bool	bIncludeChildObjects
	)		const

inlinevirtual

Gets world space bounds of a physics object if its shape type is included in shapeTypes and its collision layer interacts with uiCollisionLayer.

Reimplemented in ezJoltWorldModule.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Interfaces/PhysicsWorldModule.h

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddFixedJointComponent()

◆ AddStaticCollisionBox()

◆ GetCollisionLayerByName()

◆ GetImpulseTypeByName()

◆ GetWeightCategoryByName()

◆ GetWorldSpaceBounds()