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::EditorMeshBlockerComponent Class Reference

Inherits Vegetation::EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >, and AzFramework::EntityDebugDisplayEventBus::Handler.

Public Types

using DerivedClassType = EditorMeshBlockerComponent
 
using BaseClassType = EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >
 
- Public Types inherited from Vegetation::EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >
using BaseClassType = EditorVegetationComponentBase< MeshBlockerComponent, MeshBlockerConfig >
 
using WrappedComponentType = MeshBlockerComponent
 
using WrappedConfigType = MeshBlockerConfig
 
- Public Types inherited from Vegetation::EditorVegetationComponentBase< TComponent, TConfiguration >
using BaseClassType = LmbrCentral::EditorWrappedComponentBase< TComponent, TConfiguration >
 
using WrappedComponentType = TComponent
 
using WrappedConfigType = TConfiguration
 

Public Member Functions

 AZ_EDITOR_COMPONENT (EditorMeshBlockerComponent, EditorMeshBlockerComponentTypeId, BaseClassType)
 
void Activate () override
 
void Deactivate () override
 
void DisplayEntityViewport (const AzFramework::ViewportInfo &viewportInfo, AzFramework::DebugDisplayRequests &debugDisplay) override
 
- Public Member Functions inherited from Vegetation::EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >
 AZ_RTTI ((EditorAreaComponentBase, "{403D99B0-68E9-4FA2-B7AE-D2B6DDD9130E}", MeshBlockerComponent, MeshBlockerConfig), BaseClassType)
 
void Activate () override
 
void Deactivate () override
 
- Public Member Functions inherited from Vegetation::EditorVegetationComponentBase< TComponent, TConfiguration >
 AZ_RTTI ((EditorVegetationComponentBase, "{4A00AE4F-3D10-4B9F-914A-FAA7D2579035}", TComponent, TConfiguration), BaseClassType)
 
void Activate () override
 
void Deactivate () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from Vegetation::EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from Vegetation::EditorVegetationComponentBase< TComponent, TConfiguration >
static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static constexpr const char *const s_categoryName = "Vegetation"
 
static constexpr const char *const s_componentName = "Vegetation Layer Blocker (Mesh)"
 
static constexpr const char *const s_componentDescription = "Prevents vegetation from being placed in the mesh"
 
static constexpr const char *const s_icon = "Editor/Icons/Components/Vegetation.svg"
 
static constexpr const char *const s_viewportIcon = "Editor/Icons/Components/Viewport/Vegetation.svg"
 
static constexpr const char *const s_helpUrl = "https://www.o3de.org/docs/user-guide/components/reference/vegetation/vegetation-layer-blocker-mesh/"
 

Additional Inherited Members

- Protected Member Functions inherited from Vegetation::EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >
void OnCompositionChanged () override
 
AZ::EntityId GetPreviewEntity () const override
 
AZ::Aabb GetPreviewBounds () const override
 
bool GetConstrainToShape () const override
 
GradientSignal::GradientPreviewContextPriority GetPreviewContextPriority () const override
 
void OnSelected () override
 
void OnDeselected () override
 
AZ::u32 ConfigurationChanged () override
 
- Protected Member Functions inherited from Vegetation::EditorVegetationComponentBase< TComponent, TConfiguration >
AZ::u32 ConfigurationChanged () override
 
- Static Protected Member Functions inherited from Vegetation::EditorAreaComponentBase< MeshBlockerComponent, MeshBlockerConfig >
static bool VersionConverter (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement)
 

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