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.
Terrain::TerrainAreaMaterialNotifications Class Reference

Notifications for when the surface -> material mapping changes.. More...

#include <TerrainAreaMaterialRequestBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OnTerrainDefaultSurfaceMaterialCreated ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] AZ::Data::Instance< AZ::RPI::Material > material)
 The default surface material has been assigned and loaded.
 
virtual void OnTerrainDefaultSurfaceMaterialDestroyed ([[maybe_unused]] AZ::EntityId entityId)
 The default surface material has been unassigned.
 
virtual void OnTerrainDefaultSurfaceMaterialChanged ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] AZ::Data::Instance< AZ::RPI::Material > newMaterial)
 The default surface material has been changed to a different material.
 
virtual void OnTerrainSurfaceMaterialMappingCreated ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] SurfaceData::SurfaceTag surface, [[maybe_unused]] AZ::Data::Instance< AZ::RPI::Material > material)
 A loaded material mapped to a valid surface tag has been created.
 
virtual void OnTerrainSurfaceMaterialMappingDestroyed ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] SurfaceData::SurfaceTag surface)
 Either the material or surface tag was unassigned, making this mapping invalid.
 
virtual void OnTerrainSurfaceMaterialMappingTagChanged ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] SurfaceData::SurfaceTag oldSurface, [[maybe_unused]] SurfaceData::SurfaceTag newSurface)
 The surface tag has changed to tag for an existing material.
 
virtual void OnTerrainSurfaceMaterialMappingMaterialChanged ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] SurfaceData::SurfaceTag surface, [[maybe_unused]] AZ::Data::Instance< AZ::RPI::Material > material)
 The material has changed for an existing surface tag.
 
virtual void OnTerrainSurfaceMaterialMappingRegionCreated ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] const AZ::Aabb &region)
 A set of surface material mappings has been created.
 
virtual void OnTerrainSurfaceMaterialMappingRegionDestroyed ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] const AZ::Aabb &oldRegion)
 A set of surface material mappings has been destroyed.
 
virtual void OnTerrainSurfaceMaterialMappingRegionChanged ([[maybe_unused]] AZ::EntityId entityId, [[maybe_unused]] const AZ::Aabb &oldRegion, [[maybe_unused]] const AZ::Aabb &newRegion)
 The bounds of this set of surface material mappings has changed.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Detailed Description

Notifications for when the surface -> material mapping changes..


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