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 | Protected Member Functions | Protected Attributes | List of all members
PhysX::BaseForce Class Referenceabstract

Requests serviced by all forces used by force regions. More...

#include <ForceRegionForces.h>

Inherited by PhysX::ForceLinearDamping, PhysX::ForceLocalSpace, PhysX::ForcePoint, PhysX::ForceSimpleDrag, PhysX::ForceSplineFollow, and PhysX::ForceWorldSpace.

Public Member Functions

 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::SerializeContext &context)
 

Protected Member Functions

void NotifyChanged ()
 

Protected Attributes

AZ::EntityId m_entityId
 

Detailed Description

Requests serviced by all forces used by force regions.

Member Function Documentation

◆ Activate()

virtual void PhysX::BaseForce::Activate ( AZ::EntityId  entityId)
inlinevirtual

Connect to any buses.

Reimplemented in PhysX::ForceWorldSpace, PhysX::ForceLocalSpace, PhysX::ForcePoint, PhysX::ForceSplineFollow, PhysX::ForceSimpleDrag, and PhysX::ForceLinearDamping.

◆ CalculateForce()

virtual AZ::Vector3 PhysX::BaseForce::CalculateForce ( const EntityParams &  entityParams,
const RegionParams &  volumeParams 
) const
pure virtual

Calculate the size and direction the force.

Implemented in PhysX::ForceWorldSpace, PhysX::ForceLocalSpace, PhysX::ForcePoint, PhysX::ForceSplineFollow, PhysX::ForceSimpleDrag, and PhysX::ForceLinearDamping.

◆ Deactivate()

virtual void PhysX::BaseForce::Deactivate ( )
inlinevirtual

Disconnect from any buses.

Reimplemented in PhysX::ForceWorldSpace, PhysX::ForceLocalSpace, PhysX::ForcePoint, PhysX::ForceSplineFollow, PhysX::ForceSimpleDrag, and PhysX::ForceLinearDamping.

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