Open 3D Engine PhysX Gem 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.
Public Member Functions | Static Public Member Functions | List of all members
PhysX::ForcePoint Class Referencefinal

#include <ForceRegionForces.h>

Inherits PhysX::BaseForce, and ForcePointRequestBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ForcePoint, AZ::SystemAllocator)
 
 AZ_RTTI (ForcePoint, "{3F8ABEAC-6972-4845-A131-EA9831029E68}", BaseForce)
 
 ForcePoint (float magnitude)
 
AZ::Vector3 CalculateForce (const EntityParams &entity, const RegionParams &region) const override
 Calculate the size and direction the force.
 
void Activate (AZ::EntityId entityId) override
 Connect to any buses.
 
void Deactivate () override
 Disconnect from any buses.
 
- Public Member Functions inherited from PhysX::BaseForce
 AZ_CLASS_ALLOCATOR (BaseForce, AZ::SystemAllocator)
 
 AZ_RTTI (BaseForce, "{0D1DFFE1-16C1-425B-972B-DC70FDC61B56}")
 
virtual void Activate (AZ::EntityId entityId)
 Connect to any buses.
 
virtual void Deactivate ()
 Disconnect from any buses.
 
virtual AZ::Vector3 CalculateForce (const EntityParams &entityParams, const RegionParams &volumeParams) const =0
 Calculate the size and direction the force.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from PhysX::BaseForce
static void Reflect (AZ::SerializeContext &context)
 

Additional Inherited Members

- Protected Member Functions inherited from PhysX::BaseForce
void NotifyChanged ()
 
- Protected Attributes inherited from PhysX::BaseForce
AZ::EntityId m_entityId
 

Detailed Description

Class for a point force exerted on bodies in a force region. Bodies in a force region with a point force are repelled away from the center of the force region.

Member Function Documentation

◆ Activate()

void PhysX::ForcePoint::Activate ( AZ::EntityId  entityId)
inlineoverridevirtual

Connect to any buses.

Reimplemented from PhysX::BaseForce.

◆ CalculateForce()

AZ::Vector3 PhysX::ForcePoint::CalculateForce ( const EntityParams &  entityParams,
const RegionParams &  volumeParams 
) const
overridevirtual

Calculate the size and direction the force.

Implements PhysX::BaseForce.

◆ Deactivate()

void PhysX::ForcePoint::Deactivate ( )
inlineoverridevirtual

Disconnect from any buses.

Reimplemented from PhysX::BaseForce.

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