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.
AzToolsFramework::EditorVisibleEntityDataCacheInterface Class Referenceabstract

#include <EditorVisibleEntityDataCache.h>

Inherited by AzToolsFramework::EditorVisibleEntityDataCache, and UnitTest::MockEditorVisibleEntityDataCacheInterface.

Public Member Functions

virtual size_t VisibleEntityDataCount () const =0
 
virtual AZ::Vector3 GetVisibleEntityPosition (size_t index) const =0
 
virtual const AZ::Transform & GetVisibleEntityTransform (size_t index) const =0
 
virtual AZ::EntityId GetVisibleEntityId (size_t index) const =0
 
virtual ComponentEntityAccentType GetVisibleEntityAccent (size_t index) const =0
 
virtual bool IsVisibleEntityLocked (size_t index) const =0
 
virtual bool IsVisibleEntityVisible (size_t index) const =0
 
virtual bool IsVisibleEntitySelected (size_t index) const =0
 
virtual bool IsVisibleEntityIconHidden (size_t index) const =0
 
virtual bool IsVisibleEntityIndividuallySelectableInViewport (size_t index) const =0
 
virtual bool IsVisibleEntityInFocusSubTree (size_t index) const =0
 
virtual AZStd::optional< size_t > GetVisibleEntityIndexFromId (AZ::EntityId entityId) const =0
 

Detailed Description

Read-only interface for EditorVisibleEntityDataCache to be used by systems that want to efficiently query the state of visible entities in the viewport.

Member Function Documentation

◆ IsVisibleEntityIndividuallySelectableInViewport()

virtual bool AzToolsFramework::EditorVisibleEntityDataCacheInterface::IsVisibleEntityIndividuallySelectableInViewport ( size_t  index) const
pure virtual

Returns true if the entity is individually selectable (none of its ancestors are a closed container entity).

Note
It may still be desirable to be able to 'click' an entity that is a descendant of a closed container to select the container itself, not the individual entity.

Implemented in AzToolsFramework::EditorVisibleEntityDataCache.

◆ VisibleEntityDataCount()

virtual size_t AzToolsFramework::EditorVisibleEntityDataCacheInterface::VisibleEntityDataCount ( ) const
pure virtual

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