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

Class storing the match conditions for an editor entity search. More...

#include <EditorEntitySearchBus.h>

Public Types

using ComponentProperties = AZStd::unordered_map< AZStd::string, AZStd::any >
 
using ComponentProperty = AZStd::pair< AZStd::string, AZStd::any >
 
using Components = AZStd::unordered_map< AZ::Uuid, ComponentProperties >
 

Public Attributes

AZStd::vector< AZStd::string > m_names
 List of names (matches if any match); can contain wildcards in the name.
 
bool m_namesCaseSensitive = false
 Determines if the name matching should be case sensitive.
 
Components m_components
 
bool m_mustMatchAllComponents = false
 Determines if the filter should match all component type ids (AND).
 
AZStd::vector< AZ::EntityId > m_roots
 Specifies the entities that act as roots of the search.
 
bool m_namesAreRootBased = false
 Determines if the names are relative to the root or should be searched in children too.
 
AZ::Aabb m_aabb = AZ::Aabb::CreateNull()
 Determines if entities' position is inside the given valid AABB.
 

Detailed Description

Class storing the match conditions for an editor entity search.

Member Data Documentation

◆ m_components

Components AzToolsFramework::EntitySearchFilter::m_components

Map of component type ids with values as their properties if needed. Matches if any component's property values match. If no property value given, matches if any component types match.


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