Open 3D Engine LmbrCentral Gem 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 | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
LmbrCentral::EditorWrappedComponentBase< TComponent, TConfiguration > Class Template Reference

A base class for editor components that need to wrap runtime components, use a configuration object, and respond to visibility toggling. More...

#include <EditorWrappedComponentBase.h>

Inherits AzToolsFramework::Components::EditorComponentBase, and AzToolsFramework::EditorVisibilityNotificationBus::Handler.

Public Types

using WrappedComponentType = TComponent
 
using WrappedConfigType = TConfiguration
 

Public Member Functions

 AZ_RTTI ((EditorWrappedComponentBase, "{059BC2AF-B086-4D5E-8F6C-2827AB69ED16}", TComponent, TConfiguration), EditorComponentBase)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void BuildGameEntity (AZ::Entity *gameEntity) override
 
void OnEntityVisibilityChanged (bool visibility) override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 

Protected Member Functions

virtual AZ::u32 ConfigurationChanged ()
 

Static Protected Member Functions

template<typename TDerivedClass , typename TBaseClass >
static void ReflectSubClass (AZ::ReflectContext *context, unsigned int version=0, AZ::SerializeContext::VersionConverter versionConverter=nullptr)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Attributes

TComponent m_component
 
TConfiguration m_configuration
 
bool m_visible = true
 
bool m_runtimeComponentActive = false
 

Detailed Description

template<typename TComponent, typename TConfiguration>
class LmbrCentral::EditorWrappedComponentBase< TComponent, TConfiguration >

A base class for editor components that need to wrap runtime components, use a configuration object, and respond to visibility toggling.

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