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

#include <AreaBlenderComponent.h>

Inherits Vegetation::AreaComponentBase, and AreaBlenderRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (AreaBlenderComponent, AreaBlenderComponentTypeId, AreaComponentBase)
 
 AreaBlenderComponent (const AreaBlenderConfig &configuration)
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *baseConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outBaseConfig) const override
 
bool PrepareToClaim (EntityIdStack &stackIds) override
 
void ClaimPositions (EntityIdStack &stackIds, ClaimContext &context) override
 
void UnclaimPosition (const ClaimHandle handle) override
 
AZ::Aabb GetEncompassingAabb () const override
 
AZ::u32 GetProductCount () const override
 
- Public Member Functions inherited from Vegetation::AreaComponentBase
 AZ_RTTI (AreaComponentBase, "{A50180C3-C14C-4292-BDBA-D7215F2EA7AB}", AZ::Component)
 
 AreaComponentBase (const AreaConfig &configuration)
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *baseConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outBaseConfig) const override
 
AZ::u32 GetLayer () const override
 
AZ::u32 GetPriority () const override
 
AZ::u32 GetChangeIndex () const override
 
void OnCompositionChanged () override
 
void OnAreaConnect () override
 
void OnAreaDisconnect () override
 
void OnAreaRefreshed () override
 
void OnTransformChanged (const AZ::Transform &local, const AZ::Transform &world) override
 
void OnShapeChanged (ShapeComponentNotifications::ShapeChangeReasons reasons) 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)
 
- Static Public Member Functions inherited from Vegetation::AreaComponentBase
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)
 

Protected Member Functions

AZ::u32 GetAreaPriority () const override
 
void SetAreaPriority (AZ::u32 priority) override
 
AZ::u32 GetAreaLayer () const override
 
void SetAreaLayer (AZ::u32 layer) override
 
AZ::u32 GetAreaProductCount () const override
 
bool GetInheritBehavior () const override
 
void SetInheritBehavior (bool value) override
 
bool GetPropagateBehavior () const override
 
void SetPropagateBehavior (bool value) override
 
size_t GetNumAreas () const override
 
AZ::EntityId GetAreaEntityId (int index) const override
 
void RemoveAreaEntityId (int index) override
 
void AddAreaEntityId (AZ::EntityId entityId) override
 
- Protected Member Functions inherited from Vegetation::AreaComponentBase
virtual void OnRegisterArea ()
 
virtual void OnUnregisterArea ()
 

Friends

template<typename , typename >
class LmbrCentral::EditorWrappedComponentBase
 

Detailed Description

Placement logic for combined vegetation areas

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