Open 3D Engine SurfaceData 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
SurfaceData::SurfaceDataProviderRequests Class Referenceabstract

#include <SurfaceDataProviderRequestBus.h>

Inherits AZ::EBusSharedDispatchTraits< SurfaceDataProviderRequests >.

Public Types

typedef AZ::u32 BusIdType
 

Public Member Functions

virtual void GetSurfacePoints (const AZ::Vector3 &inPosition, SurfacePointList &surfacePointList) const =0
 
virtual void GetSurfacePointsFromList (AZStd::span< const AZ::Vector3 > inPositions, SurfacePointList &surfacePointList) const
 

Static Public Attributes

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

Detailed Description

The EBus is used to request information about a surface. 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

◆ GetSurfacePoints()

virtual void SurfaceData::SurfaceDataProviderRequests::GetSurfacePoints ( const AZ::Vector3 &  inPosition,
SurfacePointList &  surfacePointList 
) const
pure virtual

Get all of the surface points that this provider has at the given input position.

Parameters
inPosition- The input position to query. Only XY are guaranteed to be valid, Z should be ignored.
surfacePointList- The input/output SurfacePointList to add any generated surface points to.

◆ GetSurfacePointsFromList()

virtual void SurfaceData::SurfaceDataProviderRequests::GetSurfacePointsFromList ( AZStd::span< const AZ::Vector3 >  inPositions,
SurfacePointList &  surfacePointList 
) const
inlinevirtual

Get all of the surface points that this provider has at the given input positions.

Parameters
inPositions- The input positions to query. Only XY are guaranteed to be valid, Z should be ignored.
surfacePointList- The input/output SurfacePointList to add any generated surface points to.
The documentation for this class was generated from the following file: