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 | List of all members
AzToolsFramework::ComponentModeCollectionInterface Class Referenceabstract

The AZ::Interface for component mode collection queries. More...

#include <ComponentModeCollectionInterface.h>

Inherited by AzToolsFramework::ComponentModeFramework::ComponentModeCollection.

Public Types

using ActiveComponentModeCB = AZStd::function< void(const AZ::EntityComponentIdPair &, const AZ::Uuid &)>
 Calls the handler function for each component mode that is currently active.
 

Public Member Functions

 AZ_RTTI (ComponentModeCollectionInterface, "{DFAA4450-BBCD-47C0-9B91-FEA2DBD9B152}")
 
virtual AZStd::vector< AZ::Uuid > GetComponentTypes () const =0
 
virtual void EnumerateActiveComponents (const ActiveComponentModeCB &callBack) const =0
 

Detailed Description

The AZ::Interface for component mode collection queries.

Member Function Documentation

◆ GetComponentTypes()

virtual AZStd::vector< AZ::Uuid > AzToolsFramework::ComponentModeCollectionInterface::GetComponentTypes ( ) const
pure virtual

Retrieves the list of all component types (usually one).

Note
If called outside of component mode, an empty vector will be returned.

Implemented in AzToolsFramework::ComponentModeFramework::ComponentModeCollection.

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