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.
PhysX::ForceSplineFollow Class Referencefinal

#include <ForceRegionForces.h>

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

Public Member Functions

 AZ_CLASS_ALLOCATOR (ForceSplineFollow, AZ::SystemAllocator)
 
 AZ_RTTI (ForceSplineFollow, "{AB397D4C-62DA-43F0-8CF1-9BD9013129BB}", BaseForce)
 
 ForceSplineFollow (float dampingRatio, float frequency, float targetSpeed, float lookAhead)
 
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 spline follow force. Bodies in a force region with a spline follow force tend to follow the path of the spline.

Member Function Documentation

◆ Activate()

void PhysX::ForceSplineFollow::Activate ( AZ::EntityId  entityId)
overridevirtual

Connect to any buses.

Reimplemented from PhysX::BaseForce.

◆ CalculateForce()

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

Calculate the size and direction the force.

Implements PhysX::BaseForce.

◆ Deactivate()

void PhysX::ForceSplineFollow::Deactivate ( )
inlineoverridevirtual

Disconnect from any buses.

Reimplemented from PhysX::BaseForce.


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