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.
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
Vegetation::SurfaceMaskFilterComponent Class Reference

#include <SurfaceMaskFilterComponent.h>

Inherits AZ::Component, FilterRequestBus::Handler, SurfaceMaskFilterRequestBus::Handler, and SurfaceData::SurfaceDataTagEnumeratorRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (SurfaceMaskFilterComponent, SurfaceMaskFilterComponentTypeId)
 
 SurfaceMaskFilterComponent (const SurfaceMaskFilterConfig &configuration)
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *baseConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outBaseConfig) const override
 
void GetInclusionSurfaceTags (SurfaceData::SurfaceTagVector &tags, bool &includeAll) const override
 
void GetExclusionSurfaceTags (SurfaceData::SurfaceTagVector &tags) const override
 
bool Evaluate (const InstanceData &instanceData) const override
 
FilterStage GetFilterStage () const override
 
void SetFilterStage (FilterStage filterStage) 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)
 

Protected Member Functions

bool GetAllowOverrides () const override
 
void SetAllowOverrides (bool value) override
 
size_t GetNumInclusiveTags () const override
 
AZ::Crc32 GetInclusiveTag (int tagIndex) const override
 
void RemoveInclusiveTag (int tagIndex) override
 
void AddInclusiveTag (AZStd::string tag) override
 
size_t GetNumExclusiveTags () const override
 
AZ::Crc32 GetExclusiveTag (int tagIndex) const override
 
void RemoveExclusiveTag (int tagIndex) override
 
void AddExclusiveTag (AZStd::string tag) override
 
float GetInclusiveWeightMin () const override
 
void SetInclusiveWeightMin (float value) override
 
float GetInclusiveWeightMax () const override
 
void SetInclusiveWeightMax (float value) override
 
float GetExclusiveWeightMin () const override
 
void SetExclusiveWeightMin (float value) override
 
float GetExclusiveWeightMax () const override
 
void SetExclusiveWeightMax (float value) override
 

Friends

template<typename , typename >
class LmbrCentral::EditorWrappedComponentBase
 

Detailed Description

Accepts the placement of vegetation based on surface tags and/or depth between two surface tags

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