Develop
Develop
Select your platform

Scene Actor Functionalities (deprecated)

OculusXRSceneActor Deprecation
As of v65, OculusXRSceneActor is deprecated. New features will be delivered through MR Utility Kit.
Refer to the following as guidance on which APIs to use:
New projects:
Existing projects:

Introduction

The Scene Actor exposes various functionalities that you can use either from Blueprints or native C++.

Launch Scene Capture

Launches Scene Capture. This call will suspend the Unreal application. Once you exit Scene Capture, the Unreal application will regain focus.

Blueprint

Blueprint Launch Scene Capture

Arguments

Target: The Scene Actor object reference.
Output: None.

Is Scene Populated

Checks whether the Scene Actor has been populated with scene entities from a captured Scene Model.

Blueprint

Blueprint Is Scene Populated

Arguments

Target: The Scene Actor object reference.
Output: This call returns true if the Scene Actor has been populated with scene entity actors from a captured Scene Model.

Populate Scene

Queries the Scene Model and populates the Scene Actor by spawning scene entity actors.

Blueprint

Blueprint Populate Scene

Arguments

Target: The Scene Actor object reference.
Output: None.

Clear Scene

Clears a Scene Actor if one is populated. This call will destroy all spawned scene entity actors.

Blueprint

Blueprint Clear Scene

Arguments

Target: The Scene Actor object reference.
Output: None.

Set Visibility To All Scene Anchors

Toggles the visibility of all spawned actors that are part of the Scene Actor.

Blueprint

Blueprint Set Visibility to All Scene Entities

Arguments

Target: The Scene Actor object reference.
Is Visible: Set this to true to make Scene Entity actors visible and false to hide them.
Output: None.

Set Visibility To Scene Anchors by Semantic Label

Toggles the visibility of all spawned scene entity actors with specific semantic labels that are part of the Scene Model.

Blueprint

Blueprint Set Visibility to All Scene Entities by Semantic Label

Arguments

Target: The Scene Actor object reference.
Semantic Label: String of the semantic label.
Is Visible: Set this to true to make “Semantic Label” type actors visible and false to hide them.
Output: None.

Get Actors by Semantic Label

Returns all scene entity actors that have a specific semantic label type.

Blueprint

Get Actors by Semantic Label

Arguments

Target: The Scene Actor object reference.
Semantic Label: String of the semantic label.
Output: An array of actor object references.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon