AHUD::GetActorsInSelectionRectangle

Returns the array of actors inside a selection rectangle, with a class filter.

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/HUD.h

Include

#include "GameFramework/HUD.h"

Syntax

template<typename ClassFilter>
bool GetActorsInSelectionRectangle
(
    const FVector2D & FirstPoint,
    const FVector2D & SecondPoint,
    TArray< ClassFilter * > & OutActors,
    bool bIncludeNonCollidingComponents,
    bool bActorMustBeFullyEnclosed
)

Remarks

Returns the array of actors inside a selection rectangle, with a class filter.

Sample usage: TArray ActorsInSelectionRect; GetActorsInSelectionRectangle(FirstPoint,SecondPoint,ActorsInSelectionRect);

returns false if selection could not occur. Make sure template class is extending AActor.

Returns

OutActors The actors that are within the selection box according to selection rule

Parameters

Parameter

Description

FirstPoint

The first point, or anchor of the marquee box. Where the dragging of the marquee started in screen space.

SecondPoint

The second point, where the mouse cursor currently is / the other point of the box selection, in screen space.

bIncludeNonCollidingComponents

Whether to include even non-colliding components of the actor when determining its bounds

bActorMustBeFullyEnclosed

The Selection rule: whether the selection box can partially intersect Actor, or must fully enclose the Actor.