Open 3D Engine LmbrCentral Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
LmbrCentral::AudioAreaEnvironmentComponent Class Reference

#include <AudioAreaEnvironmentComponent.h>

Inherits AZ::Component, Physics::RigidBodyNotificationBus::Handler, and AZ::TransformNotificationBus::MultiHandler.

Public Member Functions

 AZ_COMPONENT (AudioAreaEnvironmentComponent, "{52300012-FFCD-4559-9479-20F463940320}")
 
void Activate () override
 
void Deactivate () override
 
void OnTransformChanged (const AZ::Transform &, const AZ::Transform &) override
 

Protected Member Functions

void OnPhysicsEnabled (const AZ::EntityId &entityId) override
 
void OnPhysicsDisabled (const AZ::EntityId &entityId) override
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void Reflect (AZ::ReflectContext *context)
 

Friends

class EditorAudioAreaEnvironmentComponent
 

Detailed Description

AudioAreaEnvironmentComponent This component contains an Entity reference which should link to an Entity that has a TriggerAreaComponent or PhysX Collider with Trigger enabled. That Trigger Area (and shape) will act as the broad-phase trigger. Once Entities go inside, this component will track their movement until they leave the Trigger Area. The AudioAreaEnvironmentComponent's Entity requires it's own Shape that defines where the Environment is fully applied. This shape should be placed interior to the Trigger Area. Entities that are between the two shapes will 'fade' the environment amount based on the Environment fade distance property.

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioAreaEnvironmentComponent::AZ_COMPONENT ( AudioAreaEnvironmentComponent  ,
"{52300012-FFCD-4559-9479-20F463940320}"   
)

AZ::Component

◆ OnTransformChanged()

void LmbrCentral::AudioAreaEnvironmentComponent::OnTransformChanged ( const AZ::Transform &  ,
const AZ::Transform &   
)
override

AZ::TransformNotificationBus::MultiHandler

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