Class SceneQuery

Helper class to perform scene actions and queries

Inheritance

SceneQuery

Assembly: FlaxEngine.dll

File: Engine/Level/SceneQuery.h

Syntax

public class SceneQuery

Methods

GetAllActors(Actor* root, Array<Actor* >& actors)

Gets all actors from the actor into linear list. Appends them (without the given actor).

Declaration

public static void GetAllActors(Actor* root, Array<Actor* >& actors)

Parameters

Actor root The root actor.

Array<Actor > actors The actors output.

GetAllActors(Array<Actor* >& actors)

Gets all actors from the loaded scenes into linear list (without scene actors).

Declaration

public static void GetAllActors(Array<Actor* >& actors)

Parameters

Array<Actor > actors The actors output.

GetAllSceneObjects(Actor* root, Array<SceneObject* >& objects)

Gets all scene objects from the actor into linear list. Appends them (without the given actor).

Declaration

public static void GetAllSceneObjects(Actor* root, Array<SceneObject* >& objects)

Parameters

Actor root The root actor.

Array<SceneObject > objects The objects output.

GetAllSerializableSceneObjects(Actor* root, Array<SceneObject* >& objects)

Gets all scene objects (for serialization) from the actor into linear list. Appends them (including the given actor).

Declaration

public static void GetAllSerializableSceneObjects(Actor* root, Array<SceneObject* >& objects)

Parameters

Actor root The root actor.

Array<SceneObject > objects The objects output.

RaycastScene(const Ray& ray)

Try to find actor hit by the given ray.

Declaration

public static Actor* RaycastScene(const Ray& ray)

Parameters

Ray ray Ray to test

Returns

Actor Hit actor or nothing

TreeExecute(Function<bool(Actor* , Params...)>& action, Params... args)

Execute custom action on actors tree.

Declaration

public static void TreeExecute(Function<bool(Actor* , Params...)>& action, Params... args)

Parameters

Function<bool(Actor , Params...)> action Actor to call on every actor in the tree. Returns true if keep calling deeper.

Params... args Custom arguments for the function

Type Parameters

Params