AzToolsFramework::Prefab::InstanceUpdateExecutorInterface Class Reference

Interface to handle instance update in template propagation. More...

#include <InstanceUpdateExecutorInterface.h>

Inherited by AzToolsFramework::Prefab::InstanceUpdateExecutor.

Public Member Functions
	AZ_RTTI (InstanceUpdateExecutorInterface, "{26BB4ACF-6EA5-4668-84E7-AB75B90BA449}")
virtual void	AddInstanceToQueue (InstanceOptionalReference instance)=0
virtual void	AddTemplateInstancesToQueue (TemplateId instanceTemplateId, InstanceOptionalConstReference instanceToExclude=AZStd::nullopt)=0
virtual bool	UpdateTemplateInstancesInQueue ()=0
virtual void	RemoveTemplateInstanceFromQueue (Instance *instance)=0
virtual void	QueueRootPrefabLoadedNotificationForNextPropagation ()=0
virtual void	SetShouldPauseInstancePropagation (bool shouldPausePropagation)=0

Detailed Description

Interface to handle instance update in template propagation.

Member Function Documentation

AddInstanceToQueue()

virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::AddInstanceToQueue ( InstanceOptionalReference  instance )

pure virtual

Adds an instance into queue for updating it later.

Parameters

instance

The instance to be added to queue.

Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.

AddTemplateInstancesToQueue()

virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::AddTemplateInstancesToQueue ( TemplateId  instanceTemplateId, InstanceOptionalConstReference  instanceToExclude = AZStd::nullopt  )

pure virtual

Adds all instances of template with given id into queue for updating them later.

Parameters

instanceTemplateId	The template id used to retrieve all instances.
instanceToExclude	The instance to be excluded. It is nullopt by default.

Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.

QueueRootPrefabLoadedNotificationForNextPropagation()

virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::QueueRootPrefabLoadedNotificationForNextPropagation ( )

pure virtual

Sets the flag that tells whether root prefab instance is loaded to false. A notification OnRootPrefabInstanceLoaded will fire during the propagation if root prefab instance is loaded for the first time after this function is called.

Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.

RemoveTemplateInstanceFromQueue()

virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::RemoveTemplateInstanceFromQueue ( Instance *  instance )

pure virtual

Removes an instance from the waiting queue.

Parameters

instance

The instance to be removed from queue.

Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.

SetShouldPauseInstancePropagation()

virtual void AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::SetShouldPauseInstancePropagation ( bool  shouldPausePropagation )

pure virtual

Sets whether to pause instance propagation or not. When making property changes in the entity editor, pausing propagation during editing will prevent the user from losing control of the properties they are editing.

Parameters

shouldPausePropagation

Flag that decides whether to pause propagation.

Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.

UpdateTemplateInstancesInQueue()

virtual bool AzToolsFramework::Prefab::InstanceUpdateExecutorInterface::UpdateTemplateInstancesInQueue ( )

pure virtual

Updates instances in the waiting queue.

Returns

bool on whether the operation succeeds.

Implemented in AzToolsFramework::Prefab::InstanceUpdateExecutor.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/Prefab/Instance/InstanceUpdateExecutorInterface.h