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::EditorVisibleEntityDataCache Class Reference

#include <EditorVisibleEntityDataCache.h>

Inherits AzToolsFramework::EditorVisibleEntityDataCacheInterface, EditorEntityVisibilityNotificationBus::Router, EditorEntityLockComponentNotificationBus::Router, AZ::TransformNotificationBus::Router, EditorComponentSelectionNotificationsBus::Router, EntitySelectionEvents::Bus::Router, EditorEntityIconComponentNotificationBus::Router, ToolsApplicationNotificationBus::Handler, ContainerEntityNotificationBus::Handler, and FocusModeNotificationBus::Handler.

Public Types

using ComponentEntityAccentType = Components::EditorSelectionAccentSystemComponent::ComponentEntityAccentType
 

Public Member Functions

 EditorVisibleEntityDataCache (const EditorVisibleEntityDataCache &)=delete
 
EditorVisibleEntityDataCacheoperator= (const EditorVisibleEntityDataCache &)=delete
 
 EditorVisibleEntityDataCache (EditorVisibleEntityDataCache &&)
 
EditorVisibleEntityDataCacheoperator= (EditorVisibleEntityDataCache &&)
 
void CalculateVisibleEntityDatas (const AzFramework::ViewportInfo &viewportInfo)
 
size_t VisibleEntityDataCount () const override
 EditorVisibleEntityDataCacheInterface overrides ...
 
AZ::Vector3 GetVisibleEntityPosition (size_t index) const override
 
const AZ::Transform & GetVisibleEntityTransform (size_t index) const override
 
AZ::EntityId GetVisibleEntityId (size_t index) const override
 
ComponentEntityAccentType GetVisibleEntityAccent (size_t index) const override
 
bool IsVisibleEntityLocked (size_t index) const override
 
bool IsVisibleEntityVisible (size_t index) const override
 
bool IsVisibleEntitySelected (size_t index) const override
 
bool IsVisibleEntityIconHidden (size_t index) const override
 
bool IsVisibleEntityIndividuallySelectableInViewport (size_t index) const override
 
bool IsVisibleEntityInFocusSubTree (size_t index) const override
 
AZStd::optional< size_t > GetVisibleEntityIndexFromId (AZ::EntityId entityId) const override
 
void AddEntityIds (const EntityIdList &entityIds)
 
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

A cache of packed EntityData that can be iterated over efficiently without the need to make individual EBus calls

Member Function Documentation

◆ GetVisibleEntityAccent()

ComponentEntityAccentType AzToolsFramework::EditorVisibleEntityDataCache::GetVisibleEntityAccent ( size_t  index) const
overridevirtual

◆ GetVisibleEntityId()

AZ::EntityId AzToolsFramework::EditorVisibleEntityDataCache::GetVisibleEntityId ( size_t  index) const
overridevirtual

◆ GetVisibleEntityIndexFromId()

AZStd::optional< size_t > AzToolsFramework::EditorVisibleEntityDataCache::GetVisibleEntityIndexFromId ( AZ::EntityId  entityId) const
overridevirtual

◆ GetVisibleEntityPosition()

AZ::Vector3 AzToolsFramework::EditorVisibleEntityDataCache::GetVisibleEntityPosition ( size_t  index) const
overridevirtual

◆ GetVisibleEntityTransform()

const AZ::Transform & AzToolsFramework::EditorVisibleEntityDataCache::GetVisibleEntityTransform ( size_t  index) const
overridevirtual

◆ IsVisibleEntityIconHidden()

bool AzToolsFramework::EditorVisibleEntityDataCache::IsVisibleEntityIconHidden ( size_t  index) const
overridevirtual

◆ IsVisibleEntityIndividuallySelectableInViewport()

bool AzToolsFramework::EditorVisibleEntityDataCache::IsVisibleEntityIndividuallySelectableInViewport ( size_t  index) const
overridevirtual

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.

Implements AzToolsFramework::EditorVisibleEntityDataCacheInterface.

◆ IsVisibleEntityInFocusSubTree()

bool AzToolsFramework::EditorVisibleEntityDataCache::IsVisibleEntityInFocusSubTree ( size_t  index) const
overridevirtual

◆ IsVisibleEntityLocked()

bool AzToolsFramework::EditorVisibleEntityDataCache::IsVisibleEntityLocked ( size_t  index) const
overridevirtual

◆ IsVisibleEntitySelected()

bool AzToolsFramework::EditorVisibleEntityDataCache::IsVisibleEntitySelected ( size_t  index) const
overridevirtual

◆ IsVisibleEntityVisible()

bool AzToolsFramework::EditorVisibleEntityDataCache::IsVisibleEntityVisible ( size_t  index) const
overridevirtual

◆ VisibleEntityDataCount()

size_t AzToolsFramework::EditorVisibleEntityDataCache::VisibleEntityDataCount ( ) const
overridevirtual

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