Open 3D Engine EMotionFX 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.
Classes | Public Types | Public Member Functions | List of all members
EMotionFX::Integration::IRaycastRequests Class Referenceabstract

#include <AnimationBus.h>

Inherited by EMotionFX::Integration::SystemComponent [private].

Classes

struct  RaycastRequest
 
struct  RaycastResult
 

Public Types

enum class  UsecaseHint : AZ::u32 { Generic , FootPlant }
 

Public Member Functions

 AZ_TYPE_INFO (IRaycastRequests, "{DDA90B91-6F1D-4C83-A0E1-9DE1540B0968}")
 
virtual RaycastResult Raycast (AZ::EntityId entityId, const RaycastRequest &rayRequest)=0
 
virtual void EnableRayRequests ()
 
virtual void DisableRayRequests ()
 

Detailed Description

The raycast request interface, which EMotion FX calls in order to perform ray cast tests. This allows you to perform custom filtering.

Member Enumeration Documentation

◆ UsecaseHint

enum class EMotionFX::Integration::IRaycastRequests::UsecaseHint : AZ::u32
strong
Enumerator
Generic 

A generic raycast, so a non-specific use case.

FootPlant 

We are using this for foot planting.

Member Function Documentation

◆ Raycast()

virtual RaycastResult EMotionFX::Integration::IRaycastRequests::Raycast ( AZ::EntityId  entityId,
const RaycastRequest &  rayRequest 
)
pure virtual

Perform a raycast to try to find the intersecion point with the world. Your game should implement this.

Parameters
entityIdThe entity that is requesting this raycast. This entity will have an Actor component on it.
rayRequestThe ray information, containing the start point, direction and length of the ray.
Returns
The resulting intersection, if there is any. If there is none the m_intersected member of the RaycastResult object returned will be set to false.
The documentation for this class was generated from the following file: