UiSliceManager Class Reference

Inherits UiEditorEntityContextNotificationBus::Handler.

Public Member Functions
	UiSliceManager (AzFramework::EntityContextId entityContextId)
void	OnSliceInstantiationFailed (const AZ::Data::AssetId &sliceAssetId, const AzFramework::SliceInstantiationTicket &ticket) override
void	InstantiateSlice (const AZ::Data::AssetId &assetId, AZ::Vector2 viewportPosition, int childIndex=-1)
	Instantiate an existing slice asset into the UI canvas.
void	InstantiateSliceUsingBrowser (HierarchyWidget *hierarchy, AZ::Vector2 viewportPosition)
	Instantiate an existing slice asset into the UI canvas using a file browser.
void	MakeSliceFromSelectedItems (HierarchyWidget *hierarchy, bool inheritSlices)
AZ::SliceComponent *	GetRootSlice () const
AzToolsFramework::EntityIdSet	GatherEntitiesAndAllDescendents (const AzToolsFramework::EntityIdList &inputEntities)
	Given a set of entities return a set that contains these entities plus all of their descendants.
void	PushEntitiesModal (const AzToolsFramework::EntityIdList &entities, AZ::SerializeContext *serializeContext=nullptr)
	Brings up the Push to Slice (advanced) dialog.
void	DetachSliceEntities (const AzToolsFramework::EntityIdList &entities)
	Detach the given entities from the slice instance(s) that they are part of.
void	DetachSliceInstances (const AzToolsFramework::EntityIdList &entities)
	Detach all entities in the slice instances that the give entities are part of from their slice instances.
bool	IsRootEntity (const AZ::Entity &entity) const
	Returns true if the entity has a null parent pointer.
void	SetEntityContextId (AzFramework::EntityContextId entityContextId)
	Set the entity context that this UI slice manager is operating on.
AzFramework::EntityContextId	GetEntityContextId () const
	Get the entity context that this UI slice manager is operating on.
AZ::Outcome< void, AZStd::string >	PushEntitiesBackToSlice (const AzToolsFramework::EntityIdList &entityIdList, const AZ::Data::Asset< AZ::SliceAsset > &sliceAsset)
AZ::Outcome< void, AZStd::string >	QuickPushSliceInstance (const AZ::SliceComponent::SliceInstanceAddress &sliceAddress, const AzToolsFramework::EntityIdList &entityIdList)
	Push the given set of entities to the given slice instance (handles adds and removes).

Member Function Documentation

MakeSliceFromSelectedItems()

void UiSliceManager::MakeSliceFromSelectedItems	(	HierarchyWidget *	hierarchy,
		bool	inheritSlices
	)

Create a new slice from the selected items and replace the selected items with an instance of the slice

PushEntitiesBackToSlice()

AZ::Outcome<void, AZStd::string> UiSliceManager::PushEntitiesBackToSlice	(	const AzToolsFramework::EntityIdList &	entityIdList,
		const AZ::Data::Asset< AZ::SliceAsset > &	sliceAsset
	)

Push the given entities back to the given slice asset (they must be part of an instance of that slice) No adds or removes are performed by this operation

---

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

• Gems/LyShine/Code/Editor/UiSliceManager.h