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.
Vegetation::MeshBlockerComponent Class Reference

Inherits Vegetation::AreaComponentBase, AZ::Render::MeshComponentNotificationBus::Handler, AZ::TickBus::Handler, MeshBlockerRequestBus::Handler, and SurfaceData::SurfaceDataSystemNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (MeshBlockerComponent, MeshBlockerComponentTypeId, AreaComponentBase)
 
 MeshBlockerComponent (const MeshBlockerConfig &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
 
void OnCompositionChanged () override
 
void OnModelReady (const AZ::Data::Asset< AZ::RPI::ModelAsset > &modelAsset, const AZ::Data::Instance< AZ::RPI::Model > &model) override
 
void OnSurfaceChanged (const AZ::EntityId &entityId, const AZ::Aabb &oldBounds, const AZ::Aabb &newBounds, const SurfaceData::SurfaceTagSet &changedSurfaceTags) override
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) 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 type) override
 
AZ::u32 GetAreaProductCount () const override
 
bool GetInheritBehavior () const override
 
void SetInheritBehavior (bool value) override
 
float GetMeshHeightPercentMin () const override
 
void SetMeshHeightPercentMin (float meshHeightPercentMin) override
 
float GetMeshHeightPercentMax () const override
 
void SetMeshHeightPercentMax (float meshHeightPercentMax) override
 
bool GetBlockWhenInvisible () const override
 
void SetBlockWhenInvisible (bool value) override
 
- Protected Member Functions inherited from Vegetation::AreaComponentBase
virtual void OnRegisterArea ()
 
virtual void OnUnregisterArea ()
 

Friends

class EditorMeshBlockerComponent
 
template<typename , typename >
class LmbrCentral::EditorWrappedComponentBase
 

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