AZ::SliceMetadataInfoRequests Class Reference

#include <SliceMetadataInfoBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual bool	IsAssociated (EntityId entityId)=0
virtual void	GetAssociatedEntities (AZStd::set< EntityId > &)=0
virtual EntityId	GetParentId ()=0
virtual void	GetChildIDs (AZStd::unordered_set< EntityId > &)=0
virtual size_t	GetAssociationCount ()=0
Public Member Functions inherited from AZ::ComponentBus
virtual	~ComponentBus ()=default

Additional Inherited Members
Public Types inherited from AZ::ComponentBus
typedef EntityId	BusIdType
Public Types inherited from AZ::EBusTraits
using	AllocatorType = AZ::Internal::EBusEnvironmentAllocator
using	BusIdType = NullBusId
using	BusIdOrderCompare = NullBusIdCompare
using	BusHandlerOrderCompare = BusHandlerCompareDefault
using	MutexType = NullMutex
using	EventQueueMutexType = NullMutex
template<class Bus >
using	ConnectionPolicy = EBusConnectionPolicy< Bus >
template<class Context >
using	StoragePolicy = EBusEnvironmentStoragePolicy< Context >
template<class Bus >
using	RouterPolicy = EBusRouterPolicy< Bus >
using	EventProcessingPolicy = EBusEventProcessingPolicy
template<typename DispatchMutex , bool IsLocklessDispatch>
using	DispatchLockGuard = AZStd::conditional_t< IsLocklessDispatch, AZ::Internal::NullLockGuard< DispatchMutex >, AZStd::scoped_lock< DispatchMutex > >
template<typename ContextMutex >
using	ConnectLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
template<typename ContextMutex >
using	BindLockGuard = AZStd::scoped_lock< ContextMutex >
template<typename ContextMutex >
using	CallstackTrackerLockGuard = AZStd::conditional_t< AZStd::is_same_v< ContextMutex, AZ::NullMutex >, AZ::Internal::NullLockGuard< ContextMutex >, AZStd::unique_lock< ContextMutex > >
Static Public Attributes inherited from AZ::ComponentBus
static const EBusAddressPolicy	AddressPolicy = EBusAddressPolicy::ById
Static Public Attributes inherited from AZ::EBusTraits
static constexpr EBusHandlerPolicy	HandlerPolicy = EBusHandlerPolicy::Multiple
static constexpr EBusAddressPolicy	AddressPolicy = EBusAddressPolicy::Single
static constexpr bool	EnableEventQueue = false
static constexpr bool	EventQueueingActiveByDefault = true
static constexpr bool	EnableQueuedReferences = false
static constexpr bool	LocklessDispatch = false
Protected Member Functions inherited from AZ::EBusTraits
	~EBusTraits ()=default

Detailed Description

Bus for making requests to the slice metadata context component.

Member Function Documentation

GetAssociatedEntities()

virtual void AZ::SliceMetadataInfoRequests::GetAssociatedEntities ( AZStd::set< EntityId > &  )

pure virtual

Fills out the provided container with all of the IDs of entities associated with this metadata entity.

GetAssociationCount()

virtual size_t AZ::SliceMetadataInfoRequests::GetAssociationCount ( )

pure virtual

Returns the total number of associated entities and children.

GetChildIDs()

virtual void AZ::SliceMetadataInfoRequests::GetChildIDs ( AZStd::unordered_set< EntityId > &  )

pure virtual

Fills out the provided container with all of the IDs of the metadata entities under this one in the slice hierarchy.

GetParentId()

virtual EntityId AZ::SliceMetadataInfoRequests::GetParentId ( )

pure virtual

Retrieve the Id of the parent

IsAssociated()

virtual bool AZ::SliceMetadataInfoRequests::IsAssociated ( EntityId  entityId )

pure virtual

True if the entity ID is associated with the metadata entity.

---

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

• Code/Framework/AzCore/AzCore/Slice/SliceMetadataInfoBus.h