Open 3D Engine SimulationInterfaces Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
SimulationInterfaces::SimulationEntityManagerRequests Class Referenceabstract

Public Member Functions

 AZ_RTTI (SimulationEntityManagerRequests, SimulationInterfacesRequestsTypeId)
 
virtual AZ::Outcome< EntityNameList, FailedResult > GetEntities (const EntityFilters &filter)=0
 
virtual AZ::Outcome< EntityState, FailedResult > GetEntityState (const AZStd::string &name)=0
 
virtual AZ::Outcome< MultipleEntitiesStates, FailedResult > GetEntitiesStates (const EntityFilters &filter)=0
 
virtual AZ::Outcome< void, FailedResult > SetEntityState (const AZStd::string &name, const EntityState &state)=0
 
virtual void DeleteEntity (const AZStd::string &name, DeletionCompletedCb completedCb)=0
 
virtual void DeleteAllEntities (DeletionCompletedCb completedCb)=0
 Remove all previously spawned entities from the simulation.
 
virtual AZ::Outcome< SpawnableList, FailedResult > GetSpawnables ()=0
 
virtual void SpawnEntity (const AZStd::string &name, const AZStd::string &uri, const AZStd::string &entityNamespace, const AZ::Transform &initialPose, const bool allowRename, SpawnCompletedCb completedCb)=0
 
virtual void ResetAllEntitiesToInitialState ()=0
 

Member Function Documentation

◆ DeleteEntity()

virtual void SimulationInterfaces::SimulationEntityManagerRequests::DeleteEntity ( const AZStd::string &  name,
DeletionCompletedCb  completedCb 
)
pure virtual

Remove previously spawned entity from the simulation.

See also
DeleteEntity.srv

◆ GetEntities()

virtual AZ::Outcome< EntityNameList, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntities ( const EntityFilters &  filter)
pure virtual

Get a list of entities that match the filter.

Supported filters:

  • name : a posix regular expression to match against entity names
  • bounds : a shape to use for filtering entities, null means no bounds filtering
    See also
    GetEntities.srv

◆ GetEntitiesStates()

virtual AZ::Outcome< MultipleEntitiesStates, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntitiesStates ( const EntityFilters &  filter)
pure virtual

Get the state of all entities that match the filter.

See also
GetEntitiesStates.srv

◆ GetEntityState()

virtual AZ::Outcome< EntityState, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntityState ( const AZStd::string &  name)
pure virtual

Get the state of an entity.

See also
GetEntityState.srv

◆ GetSpawnables()

virtual AZ::Outcome< SpawnableList, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetSpawnables ( )
pure virtual

Get a list of spawnable entities.

See also
GetSpawnables.srv

◆ ResetAllEntitiesToInitialState()

virtual void SimulationInterfaces::SimulationEntityManagerRequests::ResetAllEntitiesToInitialState ( )
pure virtual

Reset the simulation to begin. This will revert the entire simulation to the initial state.

◆ SetEntityState()

virtual AZ::Outcome< void, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::SetEntityState ( const AZStd::string &  name,
const EntityState &  state 
)
pure virtual

Set the state of an entity.

See also
SetEntityState.srv

◆ SpawnEntity()

virtual void SimulationInterfaces::SimulationEntityManagerRequests::SpawnEntity ( const AZStd::string &  name,
const AZStd::string &  uri,
const AZStd::string &  entityNamespace,
const AZ::Transform &  initialPose,
const bool  allowRename,
SpawnCompletedCb  completedCb 
)
pure virtual

Callback for when an entity has been spawned and registered. The string is the name of the entity in the simulation interface. Note: The names are empty, if the entity could not be registered (e.g. prefab has no simulated entities)

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