sim3d.Editor

Interface to the Unreal Engine project

Since R2020b

Description

Use the sim3d.Editor class to interface with the Unreal^® Editor.

Note

sim3d.Editor requires Simulink^® 3D Animation™.

To develop scenes with the Unreal Editor and co-simulate with Simulink, you need the UAV Toolbox Interface for Unreal Engine Projects support package. The support package contains an Unreal Engine^® project that allows you to customize the UAV Toolbox scenes. For information about the support package, see Customize Unreal Engine Scenes for UAVs.

Creation

Syntax

sim3d.Editor(project)

Description

MATLAB^® creates an sim3d.Editor object for the Unreal Editor project specified in sim3d.Editor(project).

Input Arguments

project — Project path and name

string scalar

Project path and name.

Note

Non-ASCII space characters are not supported in the project path.

Example: "C:\Local\AutoVrtlEnv\AutoVrtlEnv.uproject"

Data Types: string

Properties

Uproject — Project path and name

string scalar

This property is read-only.

Project path and name with Unreal Engine project file extension.

Example: "C:\Local\AutoVrtlEnv\AutoVrtlEnv.uproject"

Data Types: string

Object Functions

open	Open the Unreal Editor

Examples

Open Project in Unreal Editor

Open an Unreal Engine project in the Unreal Editor.

Create an instance of the sim3d.Editor class for the Unreal Engine project located in C:\Local\AutoVrtlEnv\AutoVrtlEnv.uproject.

editor = sim3d.Editor(fullfile("C:\Local\AutoVrtlEnv\AutoVrtlEnv.uproject"))

Open the project in the Unreal Editor.

editor.open();

Version History

Introduced in R2020b

R2024a: Requires Simulink 3D Animation

sim3d.Editor requires Simulink 3D Animation.