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::Prefab::InstanceDomGenerator Class Reference

Inherits AzToolsFramework::Prefab::InstanceDomGeneratorInterface.

Public Member Functions

 AZ_RTTI (InstanceDomGenerator, "{07E23525-1D91-41AA-B85F-136360BD1938}", InstanceDomGeneratorInterface)
 
 AZ_CLASS_ALLOCATOR (InstanceDomGenerator, AZ::SystemAllocator)
 
void RegisterInstanceDomGeneratorInterface ()
 
void UnregisterInstanceDomGeneratorInterface ()
 
void GetInstanceDomFromTemplate (PrefabDom &instanceDom, const Instance &instance) const override
 
void GetEntityDomFromTemplate (PrefabDom &entityDom, const AZ::Entity &entity) const override
 
- Public Member Functions inherited from AzToolsFramework::Prefab::InstanceDomGeneratorInterface
 AZ_RTTI (InstanceDomGeneratorInterface, "{269DE807-64B2-4157-93B0-BEDA4133C9A0}")
 
virtual void GetInstanceDomFromTemplate (PrefabDom &instanceDom, const Instance &instance) const =0
 
virtual void GetEntityDomFromTemplate (PrefabDom &entityDom, const AZ::Entity &entity) const =0
 

Member Function Documentation

◆ GetEntityDomFromTemplate()

void AzToolsFramework::Prefab::InstanceDomGenerator::GetEntityDomFromTemplate ( PrefabDom &  entityDom,
const AZ::Entity &  entity 
) const
overridevirtual

Gets a copy of entity DOM for a given entity object from template based on the currently focused instance. If the owning instance of the given entity is descendant of the focused instance, entity DOM stored in focused template DOM is used; otherwise, the entity DOM stored in the root template DOM is used.

Parameters
[out]entityDomThe output entity DOM that will be modified. It must be empty so that it can be filled.
entityThe given entity object.

Implements AzToolsFramework::Prefab::InstanceDomGeneratorInterface.

◆ GetInstanceDomFromTemplate()

void AzToolsFramework::Prefab::InstanceDomGenerator::GetInstanceDomFromTemplate ( PrefabDom &  instanceDom,
const Instance instance 
) const
overridevirtual

Gets a copy of instance DOM for a given instance object from template based on the currently focused instance. If the given instance is descendant of the focused instance, instance DOM stored in focused template DOM is used; otherwise, the instance DOM stored in the root template DOM is used. Note: Link id would be valid in the generated DOM only if the given instance is a proper descendant of the focused or root instance.

Parameters
[out]instanceDomThe output instance DOM that will be modified. It must be empty so that it can be filled.
instanceThe given instance object.

Implements AzToolsFramework::Prefab::InstanceDomGeneratorInterface.


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