#include <ContainerEntityInterface.h>
Inherited by AzToolsFramework::ContainerEntitySystemComponent [private]
.
ContainerEntityInterface An entity registered as Container is just like a regular entity when open. If its state is changed to closed, all descendants of the entity will be treated as part of the entity itself. Selecting any descendant will result in the container being selected, and descendants will be hidden until the container is opened.
◆ Clear()
virtual ContainerEntityOperationResult AzToolsFramework::ContainerEntityInterface::Clear |
( |
AzFramework::EntityContextId |
entityContextId | ) |
|
|
pure virtual |
Clears all open state information for Container Entities for the EntityContextId provided. Used when context is switched, for example in the case of a new root prefab being loaded in place of an old one.
- Note
- Clear is meant to be called when no container is registered for the context provided.
- Returns
- An error message if any container was registered for the context, success otherwise.
Implemented in AzToolsFramework::ContainerEntitySystemComponent.
◆ FindHighestSelectableEntity()
virtual AZ::EntityId AzToolsFramework::ContainerEntityInterface::FindHighestSelectableEntity |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
◆ IsContainer()
virtual bool AzToolsFramework::ContainerEntityInterface::IsContainer |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
◆ IsContainerOpen()
virtual bool AzToolsFramework::ContainerEntityInterface::IsContainerOpen |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
If the entity id provided is registered as a container, it returns whether it's open.
- Note
- the default value for non-containers is true, so this function can be called without verifying whether the entityId is registered as a container beforehand, since the container's open behavior is exactly the same as the one of a regular entity.
- Returns
- False if the entityId is registered as a container, and its state is closed. True otherwise.
Implemented in AzToolsFramework::ContainerEntitySystemComponent.
◆ IsUnderClosedContainerEntity()
virtual bool AzToolsFramework::ContainerEntityInterface::IsUnderClosedContainerEntity |
( |
AZ::EntityId |
entityId | ) |
const |
|
pure virtual |
◆ RefreshAllContainerEntities()
virtual void AzToolsFramework::ContainerEntityInterface::RefreshAllContainerEntities |
( |
AzFramework::EntityContextId |
entityContextId | ) |
const |
|
pure virtual |
◆ RegisterEntityAsContainer()
virtual ContainerEntityOperationResult AzToolsFramework::ContainerEntityInterface::RegisterEntityAsContainer |
( |
AZ::EntityId |
entityId | ) |
|
|
pure virtual |
◆ SetContainerOpen()
virtual ContainerEntityOperationResult AzToolsFramework::ContainerEntityInterface::SetContainerOpen |
( |
AZ::EntityId |
entityId, |
|
|
bool |
open |
|
) |
| |
|
pure virtual |
Sets the open state of the container entity provided.
- Parameters
-
entityId | The entityId whose open state will be set. |
open | True if the container should be opened, false if it should be closed. |
- Returns
- An error message if the operation was invalid, success otherwise.
Implemented in AzToolsFramework::ContainerEntitySystemComponent.
◆ UnregisterEntityAsContainer()
virtual ContainerEntityOperationResult AzToolsFramework::ContainerEntityInterface::UnregisterEntityAsContainer |
( |
AZ::EntityId |
entityId | ) |
|
|
pure virtual |
Unregisters the entity as a container. The system will retain the closed state in case the entity is registered again later, but if queried the entity will no longer behave as a container.
- Parameters
-
entityId | The entityId that will be unregistered as a container. |
Implemented in AzToolsFramework::ContainerEntitySystemComponent.
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/ContainerEntity/ContainerEntityInterface.h