Open 3D Engine AzFramework 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 | List of all members
AzFramework::IEntityBoundsUnion Class Referenceabstract

#include <EntityBoundsUnionBus.h>

Public Member Functions

 AZ_RTTI (IEntityBoundsUnion, "{106968DD-43C0-478E-8045-523E0BF5D0F5}")
 
virtual void RefreshEntityLocalBoundsUnion (AZ::EntityId entityId)=0
 
virtual AZ::Aabb GetEntityLocalBoundsUnion (AZ::EntityId entityId) const =0
 Returns the cached union of all component Aabbs in local entity space.
 
virtual AZ::Aabb GetEntityWorldBoundsUnion (AZ::EntityId entityId) const =0
 Returns the cached union of all component Aabbs in world space.
 
virtual void ProcessEntityBoundsUnionRequests ()=0
 
virtual void OnTransformUpdated (AZ::Entity *entity)=0
 

Detailed Description

Provides an interface to retrieve and update the union of all Aabbs on a single Entity.

Note
This will be the combination/union of all individual Component Aabbs.

Member Function Documentation

◆ OnTransformUpdated()

virtual void AzFramework::IEntityBoundsUnion::OnTransformUpdated ( AZ::Entity *  entity)
pure virtual

Notifies the EntityBoundsUnion system that an entities transform has been modified.

Parameters
entitythe entity whose transform has been modified.

◆ ProcessEntityBoundsUnionRequests()

virtual void AzFramework::IEntityBoundsUnion::ProcessEntityBoundsUnionRequests ( )
pure virtual

Writes the current changes made to all entities (transforms and bounds) to the visibility system.

Note
During normal operation this is called every frame in OnTick but can also be called explicitly (e.g. For testing purposes).

◆ RefreshEntityLocalBoundsUnion()

virtual void AzFramework::IEntityBoundsUnion::RefreshEntityLocalBoundsUnion ( AZ::EntityId  entityId)
pure virtual

Requests the cached union of component Aabbs to be recalculated as one may have changed.

Note
This is used to drive event driven updates to the visibility system.
The documentation for this class was generated from the following file: