Open 3D Engine AzFramework API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::Scene Class Referencefinal

Public Types

enum class  RemovalEventType { Zombified , Destroyed }
 
enum class  SubsystemEventType { Added , Removed }
 
using RemovalEvent = AZ::Event< Scene &, RemovalEventType >
 
using SubsystemEvent = AZ::Event< Scene &, SubsystemEventType, const AZ::TypeId & >
 

Public Member Functions

 AZ_TYPE_INFO (Scene, "{DB449BB3-7A95-434D-BC61-47ACBB1F3436}")
 
 AZ_CLASS_ALLOCATOR (Scene, AZ::SystemAllocator)
 
 Scene (AZStd::string name)
 
 Scene (AZStd::string name, AZStd::shared_ptr< Scene > parent)
 
const AZStd::string & GetName () const
 
const AZStd::shared_ptr< Scene > & GetParent ()
 
AZStd::shared_ptr< const SceneGetParent () const
 
bool IsAlive () const
 
void ConnectToEvents (RemovalEvent::Handler &handler)
 
void ConnectToEvents (SubsystemEvent::Handler &handler)
 
template<typename T >
bool SetSubsystem (T &&system)
 
template<typename T >
bool UnsetSubsystem ()
 
template<typename T >
bool UnsetSubsystem (const T &system)
 
AZStd::any * FindSubsystem (const AZ::TypeId &typeId)
 
const AZStd::any * FindSubsystem (const AZ::TypeId &typeId) const
 
template<typename T >
T * FindSubsystem ()
 
template<typename T >
const T * FindSubsystem () const
 
AZStd::any * FindSubsystemInScene (const AZ::TypeId &typeId)
 
const AZStd::any * FindSubsystemInScene (const AZ::TypeId &typeId) const
 
template<typename T >
T * FindSubsystemInScene ()
 
template<typename T >
const T * FindSubsystemInScene () const
 
template<typename T >
bool UnsetSubsystem ([[maybe_unused]] const T &system)
 

Static Public Attributes

constexpr static AZStd::string_view MainSceneName = "Main"
 
constexpr static AZStd::string_view EditorMainSceneName = "Editor"
 

Friends

class ISceneSystem
 

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