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

Inherits AzToolsFramework::Components::EditorComponentBase, AzToolsFramework::EditorVisibilityNotificationBus::Handler, LmbrCentral::DependencyNotificationBus::Handler, AzFramework::PaintBrushNotificationBus::Handler, and TerrainMacroMaterialNotificationBus::Handler.

Public Member Functions

 AZ_EDITOR_COMPONENT_INTRUSIVE_DESCRIPTOR_TYPE (EditorTerrainMacroMaterialComponent)
 
 AZ_COMPONENT_BASE (EditorTerrainMacroMaterialComponent)
 
 AZ_CLASS_ALLOCATOR (EditorTerrainMacroMaterialComponent, AZ::ComponentAllocator)
 
 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
void Init () override
 Component overrides ...
 
void Activate () override
 
void Deactivate () override
 
void BuildGameEntity (AZ::Entity *gameEntity) override
 
void OnEntityVisibilityChanged (bool visibility) override
 
void OnCompositionChanged () override
 
void OnCompositionRegionChanged (const AZ::Aabb &dirtyRegion) override
 

Static Public Member Functions

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

Static Public Attributes

static constexpr const char *const s_categoryName = "Terrain"
 
static constexpr const char *const s_componentName = "Terrain Macro Material"
 
static constexpr const char *const s_componentDescription = "Provides a macro material for a region to the terrain renderer"
 
static constexpr const char *const s_icon = "Editor/Icons/Components/TerrainMacroMaterial.svg"
 
static constexpr const char *const s_viewportIcon = "Editor/Icons/Components/Viewport/TerrainMacroMaterial.svg"
 
static constexpr const char *const s_helpUrl = ""
 

Protected Member Functions

void OnTerrainMacroMaterialCreated (AZ::EntityId macroMaterialEntity, const MacroMaterialData &macroMaterial) override
 
void OnTerrainMacroMaterialChanged (AZ::EntityId macroMaterialEntity, const MacroMaterialData &macroMaterial) override
 
void OnTerrainMacroMaterialDestroyed (AZ::EntityId macroMaterialEntity) override
 
bool SavePaintedData ()
 
void OnPaintModeBegin () override
 
void OnPaintModeEnd () override
 
void OnBrushStrokeBegin (const AZ::Color &color) override
 
void OnBrushStrokeEnd () override
 
void OnPaint (const AZ::Color &color, const AZ::Aabb &dirtyArea, ValueLookupFn &valueLookupFn, BlendFn &blendFn) override
 
void OnSmooth (const AZ::Color &color, const AZ::Aabb &dirtyArea, ValueLookupFn &valueLookupFn, AZStd::span< const AZ::Vector3 > valuePointOffsets, SmoothFn &smoothFn) override
 
AZ::Color OnGetColor (const AZ::Vector3 &brushCenter) const override
 
AZStd::vector< uint8_t > ConvertLinearToSrgbGamma (AZStd::span< const uint32_t > pixelBuffer) const
 
void RefreshPaintableAssetStatus ()
 
AZ::u32 ConfigurationChanged ()
 
The documentation for this class was generated from the following file: