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, PreInsertionCb preinsertionCb, SpawnCompletedCb completedCb)=0

virtual AZ::Outcome< void, FailedResult >	ResetAllEntitiesToInitialState ()=0

virtual AZ::Outcome< AZStd::string, FailedResult >	RegisterNewSimulatedBody (const AZStd::string &proposedName, const AZ::EntityId &entityId)=0

virtual AZ::Outcome< void, FailedResult >	UnregisterSimulatedBody (const AZStd::string &name)=0

virtual AZ::Outcome< void, FailedResult >	SetEntityInfo (const AZStd::string &name, const EntityInfo &info)=0

virtual AZ::Outcome< EntityInfo, FailedResult >	GetEntityInfo (const AZStd::string &name)=0

virtual AZ::Outcome< Bounds, FailedResult >	GetEntityBounds (const AZStd::string &name)=0

virtual AZ::Outcome< AZ::EntityId, FailedResult >	GetEntityId (const AZStd::string &name)=0

virtual AZ::Outcome< AZ::EntityId, FailedResult >	GetEntityRoot (const AZStd::string &name)=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

◆ GetEntityBounds()

virtual AZ::Outcome< Bounds, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntityBounds ( const AZStd::string & name )

pure virtual

Get information about bounds of the entity with given name

Parameters

name	Name of entity to get

Returns: Returns bounds of the entity or fail if entity doesn't exist

◆ GetEntityId()

virtual AZ::Outcome< AZ::EntityId, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntityId ( const AZStd::string & name )

pure virtual

Get Entity Id of the simulated Entity, for physical prefabs it will be first physical entity, For non-physical entities prefab root will be returned

Parameters

name	Name of entity to get

Returns: Returns entityId of the entity or fail if entity doesn't exist

◆ GetEntityInfo()

virtual AZ::Outcome< EntityInfo, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntityInfo ( const AZStd::string & name )

pure virtual

Get information about spawned entity, empty object is returned if no information was set before

Parameters

name	Name of entity to get

Returns: Returns entityIf of the entity or fail if entity doesn't exist

◆ GetEntityRoot()

virtual AZ::Outcome< AZ::EntityId, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::GetEntityRoot ( const AZStd::string & name )

pure virtual

Get Entity Id of the root of the prefab spawned as simulated Entity

Parameters

name	Name of entity to get

Returns: Returns entityId of the entity or fail if entity doesn't exist

◆ 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

◆ RegisterNewSimulatedBody()

virtual AZ::Outcome< AZStd::string, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::RegisterNewSimulatedBody	(	const AZStd::string &	proposedName,
		const AZ::EntityId &	entityId
	)

pure virtual

Registers a new simulated body to the simulation interface. This method adds entity to simulation Interfaces cache with its name and initial state This method allows to register entity spawned by interface other than simulation_interfaces If given name already exists in the registry, new unique name will be created.

Parameters

proposedName	Name to register entity under
entityId	id of entity related to given name

Returns: final name which was used to register simulated body

◆ ResetAllEntitiesToInitialState()

virtual AZ::Outcome< void, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::ResetAllEntitiesToInitialState ( )

pure virtual

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

◆ SetEntityInfo()

virtual AZ::Outcome< void, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::SetEntityInfo	(	const AZStd::string &	name,
		const EntityInfo &	info
	)

pure virtual

Set informations such as category, description to spawned entity with given name

Parameters

name	name of entity to set info for
info	object with entity info

◆ 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,
		PreInsertionCb	preinsertionCb,
		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)

◆ UnregisterSimulatedBody()

virtual AZ::Outcome< void, FailedResult > SimulationInterfaces::SimulationEntityManagerRequests::UnregisterSimulatedBody ( const AZStd::string & name )

pure virtual

Unregisters simulated body from the simulation interface. This method doesn't despawn entity, it removes it from simulation_interfaces registry

Parameters

name	Name of entity to unregister

Returns: Returns failure if entity wasn't found

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

Gems/SimulationInterfaces/Code/Include/SimulationInterfaces/SimulationEntityManagerRequestBus.h

Public Member Functions

Member Function Documentation

◆ DeleteEntity()

◆ GetEntities()

Get a list of entities that match the filter.

◆ GetEntitiesStates()

◆ GetEntityBounds()

◆ GetEntityId()

◆ GetEntityInfo()

◆ GetEntityRoot()

◆ GetEntityState()

◆ GetSpawnables()

◆ RegisterNewSimulatedBody()

◆ ResetAllEntitiesToInitialState()

◆ SetEntityInfo()

◆ SetEntityState()

◆ SpawnEntity()

◆ UnregisterSimulatedBody()