Open 3D Engine AzToolsFramework 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
AzToolsFramework::EditorEntityInfoRequests Class Referenceabstract

#include <EditorEntityInfoBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityId
 

Public Member Functions

virtual AZ::EntityId GetParent () const =0
 
virtual EntityIdList GetChildren () const =0
 
virtual AZ::EntityId GetChild (AZStd::size_t index) const =0
 
virtual AZStd::size_t GetChildCount () const =0
 
virtual AZ::u64 GetChildIndex (AZ::EntityId childId) const =0
 
virtual AZStd::string GetName () const =0
 
virtual AZStd::string GetSliceAssetName () const =0
 
virtual bool IsSliceEntity () const =0
 
virtual bool IsSubsliceEntity () const =0
 
virtual bool IsSliceRoot () const =0
 
virtual bool IsSubsliceRoot () const =0
 
virtual bool HasSliceEntityAnyChildrenAddedOrDeleted () const =0
 
virtual bool HasSliceEntityPropertyOverridesInTopLevel () const =0
 
virtual bool HasSliceEntityOverrides () const =0
 
virtual bool HasSliceChildrenOverrides () const =0
 
virtual bool HasSliceAnyOverrides () const =0
 
virtual bool HasCyclicDependency () const =0
 
virtual void AddToCyclicDependencyList (const AZ::EntityId &entityId)=0
 
virtual void RemoveFromCyclicDependencyList (const AZ::EntityId &entityId)=0
 
virtual AzToolsFramework::EntityIdList GetCyclicDependencyList () const =0
 
virtual AZ::u64 GetIndexForSorting () const =0
 
virtual bool IsSelected () const =0
 
virtual bool IsVisible () const =0
 
virtual bool IsHidden () const =0
 
virtual bool IsLocked () const =0
 
virtual EditorEntityStartStatus GetStartStatus () const =0
 
virtual bool IsJustThisEntityLocked () const =0
 
virtual bool IsComponentExpanded (AZ::ComponentId id) const =0
 
virtual void SetComponentExpanded (AZ::ComponentId id, bool expanded)=0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

This bus can be used to query any Entity in the EditorEntityContext It contains a hierarchy derived from the transform hierarchy but also provides entity sort information at each level The results returned here are cached and very efficient compared to listening and deriving the data from existing events

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