SCR_HoverEditableEntityFilter Class Reference

Inheritance diagram for SCR_HoverEditableEntityFilter:

Protected Member Functions
void	UpdateEntityUnderCursor ()
void	SetEntityUnderCursor (SCR_EditableEntityComponent entity, bool isDelegate=false)
SCR_EditableEntityComponent	GetEntityUnderCursor (out bool isDelegate=false)
SCR_EditableEntityComponent	GetInteractiveEntityUnderCursor ()
SCR_EditableEntityComponent	GetEntityUnderCursorCandidate (out bool isDelegate=false)
void	SetEntityUnderCursorEnabled (bool enabled)
bool	GetEntityUnderCursorEnabled ()
bool	IsDelegate ()
override void	EOnEditorFrame (float timeSlice)
override void	EOnEditorActivate ()

Detailed Description

Definition at line 6 of file SCR_HoverEditableEntityFilter.c.

Member Function Documentation

EOnEditorActivate()

override void SCR_HoverEditableEntityFilter::EOnEditorActivate ( )

inlineprotected

Definition at line 137 of file SCR_HoverEditableEntityFilter.c.

EOnEditorFrame()

override void SCR_HoverEditableEntityFilter::EOnEditorFrame ( float timeSlice )

inlineprotected

Definition at line 133 of file SCR_HoverEditableEntityFilter.c.

GetEntityUnderCursor()

SCR_EditableEntityComponent SCR_HoverEditableEntityFilter::GetEntityUnderCursor ( out bool isDelegate = false )

inlineprotected

Get entity under cursor.

Parameters

[out]

isDelegate

True if the entity under cursor is represented by a delegate (e.g., icon)

Returns

Editable entity

Definition at line 61 of file SCR_HoverEditableEntityFilter.c.

GetEntityUnderCursorCandidate()

SCR_EditableEntityComponent SCR_HoverEditableEntityFilter::GetEntityUnderCursorCandidate ( out bool isDelegate = false )

inlineprotected

Get candidate entity under cursor. Multiple systems can set entity under cursor each frame, and the final one is assigned at the end of the frame. This is useful for checking of a candidate already exists, so low priority candidate would be ignored.

Parameters

[out]

isDelegate

True if the entity under cursor candidate is represented by a delegate (e.g., icon)

Returns

Editable entity

Definition at line 83 of file SCR_HoverEditableEntityFilter.c.

GetEntityUnderCursorEnabled()

bool SCR_HoverEditableEntityFilter::GetEntityUnderCursorEnabled ( )

inlineprotected

Get if the entity under cursor can be assigned.

Returns

True to enable asisgning (default: true)

Definition at line 120 of file SCR_HoverEditableEntityFilter.c.

GetInteractiveEntityUnderCursor()

SCR_EditableEntityComponent SCR_HoverEditableEntityFilter::GetInteractiveEntityUnderCursor ( )

inlineprotected

Get interactive entity under cursor (e.g., one which can be selected)

Returns

Editable entity

Definition at line 70 of file SCR_HoverEditableEntityFilter.c.

IsDelegate()

bool SCR_HoverEditableEntityFilter::IsDelegate ( )

inlineprotected

Check if the entity under cursor is represented by a delegate (e.g., icon)

Returns

True when delegate

Definition at line 128 of file SCR_HoverEditableEntityFilter.c.

SetEntityUnderCursor()

void SCR_HoverEditableEntityFilter::SetEntityUnderCursor ( SCR_EditableEntityComponent entity, bool isDelegate = false )

inlineprotected

Set which entity is under cursor.

Parameters

entity	Editable entity
isDelegate	True if the entity under cursor is represented by a delegate (e.g., icon), not a geometry. Delegates have higher priority, for example for camera snapping.

Definition at line 49 of file SCR_HoverEditableEntityFilter.c.

SetEntityUnderCursorEnabled()

void SCR_HoverEditableEntityFilter::SetEntityUnderCursorEnabled ( bool enabled )

inlineprotected

Set if the entity under cursor can be assigned. Important for systems that could collide with entity under cursor (e.g., selection frame).

Parameters

enable

True to enable asisgning (default: true)

Definition at line 93 of file SCR_HoverEditableEntityFilter.c.

UpdateEntityUnderCursor()

void SCR_HoverEditableEntityFilter::UpdateEntityUnderCursor ( )

inlineprotected

Definition at line 17 of file SCR_HoverEditableEntityFilter.c.

---

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

• scripts/Game/Editor/Containers/EditableEntityFilters/SCR_HoverEditableEntityFilter.c