Open 3D Engine Vegetation 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 | List of all members
Vegetation::AreaRequests Class Referenceabstract

#include <AreaRequestBus.h>

Inherits AZ::ComponentBus.

Public Types

using MutexType = AZStd::recursive_mutex
 allows multiple threads to call
 

Public Member Functions

virtual bool PrepareToClaim (EntityIdStack &stackIds)=0
 
virtual void ClaimPositions (EntityIdStack &stackIds, ClaimContext &context)=0
 
virtual void UnclaimPosition (const ClaimHandle handle)=0
 

Detailed Description

This bus declares the minimum interface needed for a component to serve as a vegetation area

Member Function Documentation

◆ ClaimPositions()

virtual void Vegetation::AreaRequests::ClaimPositions ( EntityIdStack &  stackIds,
ClaimContext &  context 
)
pure virtual

Claims a world position by executing a 'vegetation location operation' such as 'place' or 'clear'

◆ PrepareToClaim()

virtual bool Vegetation::AreaRequests::PrepareToClaim ( EntityIdStack &  stackIds)
pure virtual

execute any pre-claim checks or logic that's not needed per point

◆ UnclaimPosition()

virtual void Vegetation::AreaRequests::UnclaimPosition ( const ClaimHandle  handle)
pure virtual

Reverses a previous 'vegetation location operation' such as 'place' or 'clear'

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