AzToolsFramework::CursorEntityIdQuery Class Reference

< Represents the result of a query to find the id of the entity under the cursor (if any). More...

#include <EditorHelpers.h>

Public Member Functions
	CursorEntityIdQuery (AZ::EntityId entityId, AZ::EntityId rootEntityId)
AZ::EntityId	EntityIdUnderCursor () const
AZ::EntityId	ContainerAncestorEntityId () const
bool	HasContainerAncestorEntityId () const
	Returns true if the query has a container ancestor entity id, otherwise false.

Detailed Description

< Represents the result of a query to find the id of the entity under the cursor (if any).

Member Function Documentation

ContainerAncestorEntityId()

AZ::EntityId AzToolsFramework::CursorEntityIdQuery::ContainerAncestorEntityId

(

)

const

Returns the topmost container entity id in the hierarchy if the entity id under the cursor is inside a container entity, otherwise returns the entity id.

Note

In the case of no entity id under the cursor, an invalid entity id is returned.

EntityIdUnderCursor()

AZ::EntityId AzToolsFramework::CursorEntityIdQuery::EntityIdUnderCursor

(

)

const

Returns the entity id under the cursor (if any).

Note

In the case of no entity id under the cursor, an invalid entity id is returned.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/EditorHelpers.h