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

This bus provides retrieval of information from Terrain Surfaces. More...

#include <TerrainGradientSurfaceListBus.h>

Inherits AZ::EBusSharedDispatchTraits< TerrainAreaSurfaceRequests >, and AZ::ComponentBus.

Public Types

typedef AZ::EntityId BusIdType
 
using MutexType = AZStd::recursive_mutex
 

Public Member Functions

virtual void GetSurfaceWeights (const AZ::Vector3 &inPosition, AzFramework::SurfaceData::SurfaceTagWeightList &outSurfaceWeights) const =0
 Get the surfaces and weights from a gradient at a given position.
 
virtual void GetSurfaceWeightsFromList (AZStd::span< const AZ::Vector3 > inPositionList, AZStd::span< AzFramework::SurfaceData::SurfaceTagWeightList > outSurfaceWeightsList) const =0
 Get the surfaces and weights from a gradient at a given list of positions.
 
virtual void GetSurfaceWeights (const AZ::Vector3 &inPosition, SurfaceData::SurfaceTagWeightMap &surfaceWeights) const =0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

This bus provides retrieval of information from Terrain Surfaces.

This bus provides retrieval of information from Terrain Surfaces. This bus uses shared dispatches, which means that all requests on the bus can run in parallel, but will NOT run in parallel with bus connections / disconnections.

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