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::TerrainAreaHeightRequests Class Referenceabstract

#include <TerrainSystemBus.h>

Inherits AZ::EBusSharedDispatchTraits< TerrainAreaHeightRequests >.

Public Types

typedef AZ::EntityId BusIdType
 

Public Member Functions

virtual void GetHeight (const AZ::Vector3 &inPosition, AZ::Vector3 &outPosition, bool &terrainExists)=0
 
virtual void GetHeights (AZStd::span< AZ::Vector3 > inOutPositionList, AZStd::span< bool > terrainExistsList)=0
 

Static Public Attributes

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

Detailed Description

A bus to signal the life times of terrain areas. 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.

Member Function Documentation

◆ GetHeight()

virtual void Terrain::TerrainAreaHeightRequests::GetHeight ( const AZ::Vector3 &  inPosition,
AZ::Vector3 &  outPosition,
bool &  terrainExists 
)
pure virtual

Synchronous single input location. @inPosition is the input position to query. @outPosition will have the same XY as inPosition, but with the Z adjusted to the proper height. @terrainExists is true if the output position is valid terrain.

◆ GetHeights()

virtual void Terrain::TerrainAreaHeightRequests::GetHeights ( AZStd::span< AZ::Vector3 >  inOutPositionList,
AZStd::span< bool >  terrainExistsList 
)
pure virtual

Synchronous multiple input locations. @inOutPositionList takes a list of Vector3s as input and returns the Vector3s with Z filled out. @terrainExistsList outputs flags for whether or not each output position is valid terrain.

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