Open 3D Engine Vegetation 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 Member Functions | Static Public Member Functions | Friends | List of all members
Vegetation::AreaSystemComponent Class Reference

#include <AreaSystemComponent.h>

Inherits AZ::Component, AZ::TickBus::Handler, AreaSystemRequestBus::Handler, GradientSignal::SectorDataRequestBus::Handler, SystemConfigurationRequestBus::Handler, CrySystemEventBus::Handler, ISystemEventListener, SurfaceData::SurfaceDataSystemNotificationBus::Handler, and AzFramework::Terrain::TerrainDataNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (AreaSystemComponent, "{7CE8E791-6BC6-4C88-8727-A476DE00F9A1}")
 
 AreaSystemComponent (const AreaSystemConfig &configuration)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *baseConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outBaseConfig) const override
 
void RegisterArea (AZ::EntityId areaId, AZ::u32 layer, AZ::u32 priority, const AZ::Aabb &bounds) override
 
void UnregisterArea (AZ::EntityId areaId) override
 
void RefreshArea (AZ::EntityId areaId, AZ::u32 layer, AZ::u32 priority, const AZ::Aabb &bounds) override
 
void RefreshAllAreas () override
 
void ClearAllAreas () override
 
void MuteArea (AZ::EntityId areaId) override
 
void UnmuteArea (AZ::EntityId areaId) override
 
void EnumerateInstancesInOverlappingSectors (const AZ::Aabb &bounds, AreaSystemEnumerateCallback callback) const override
 
void EnumerateInstancesInAabb (const AZ::Aabb &bounds, AreaSystemEnumerateCallback callback) const override
 
AZStd::size_t GetInstanceCountInAabb (const AZ::Aabb &bounds) const override
 
AZStd::vector< Vegetation::InstanceData > GetInstancesInAabb (const AZ::Aabb &bounds) const override
 
void GetPointsPerMeter (float &value) const override
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
void UpdateSystemConfig (const AZ::ComponentConfig *config) override
 
void GetSystemConfig (AZ::ComponentConfig *config) const override
 
void OnSurfaceChanged (const AZ::EntityId &entityId, const AZ::Aabb &oldBounds, const AZ::Aabb &newBounds, const SurfaceData::SurfaceTagSet &changedSurfaceTags) override
 
void OnCrySystemInitialized (ISystem &system, const SSystemInitParams &systemInitParams) override
 
void OnCrySystemShutdown (ISystem &system) override
 
void OnCryEditorBeginLevelExport () override
 
void OnCryEditorEndLevelExport (bool) override
 
void OnCryEditorCloseScene () override
 
void OnSystemEvent (ESystemEvent event, UINT_PTR wparam, UINT_PTR lparam) override
 
void OnTerrainDataCreateBegin () override
 
void OnTerrainDataDestroyBegin () override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void Reflect (AZ::ReflectContext *context)
 

Friends

class EditorAreaSystemComponent
 

Detailed Description

Manages an sectors and claims while the camera scrolls through the 3D world

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