copyExampleSim3dProject

Copy support package files and plugins to specified folders

Since R2022b

Syntax

sim3d.utils.copyExampleSim3dProject(DestFldr)
sim3d.utils.copyExampleSim3dProject(DestFldr,Name=Value)


Description

sim3d.utils.copyExampleSim3dProject(DestFldr) copies the UAV Toolbox Interface for Unreal Engine^® Projects support package project files to the destination folder, DestFldr. By default, copyExampleSim3dProject copies the plugins to your Epic Games^® installation folder.

sim3d.utils.copyExampleSim3dProject(DestFldr,Name=Value) copies support package files to the destination with additional options specified by name-value arguments. If your Epic Games installation is not saved to the default location C:\Program Files\Epic Games, specify the PluginDestination argument.

Running the sim3d.utils.copyExampleSim3dProject function configures your environment so that you can customize scenes. The support package contains these UAV Toolbox Interface for Unreal Engine Projects components.

• An Unreal^®s project, defined in AutoVrtlEnv.uproject, and its associated files. The project includes editable versions of the prebuilt 3D scenes that you can select from the Scene name parameter of the Simulation 3D Scene Configuration block.

• Two plugins: MathWorkSimulation, MathworksUAVContent, and RoadRunnerMaterials. These plugins establish the connection between MATLAB^® and the Unreal Editor and are required for co-simulation.

Input Arguments

DestFldr — Destination folder for Unreal project files

character vector

Destination folder name, specified as a character vector.

Running copyExampleSim3dProject copies the Unreal project, defined in AutoVrtlEnv.uproject, and its associated project files to the destination folder.

If the DestFldr argument is specified as "", the copyExampleSim3dProject function does not copy the project files.

Note

You must have write permission for the destination folder.

Example: C:\project

Data Types: char | string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Source — Support package source folder

character vector

Support package source folder, specified as a character vector. The folder contains the downloaded support packages files.

By default, if you do not specify the source folder, copyExampleSim3dProject copies the file from the support package installation folder, matlabshared.supportpkg.getSupportPackageRoot().

Example: Source="shared\sim3dprojects\spkg\"

Data Types: char | string

PluginDestination — Option to change the plugin destination folder

character vector

Option to change the plugin destination folder, specified as a character vector.

By default, if you do not change the plugin installation folder location, copyExampleSim3dProject tries to copy the plugins to C:\Program Files\Epic Games\UE_5.3\Engine\Plugins\Marketplace\MathWorks.

Example: PluginDestination="C:\Program Files\Epic Games\UE_5.3\Engine\Plugins\Marketplace\MathWorks"

Data Types: char | string

VerboseOutput — Option to enable verbose logging

0 or false (default) | 1 or true

Option to enable verbose logging, specified as a logical 0 (false) or 1 (true). Verbose logging displays intermediate iteration information on the MATLAB command line.

Example: VerboseOutput=true

Data Types: logical

SkipPluginCopy — Option to skip copying plugins to the Unreal Engine directory

false (default) | true

Option to skip copying plugins to the Unreal Engine directory, specified as a logical false or true.

Note

Use this option if you previously copied plugins to the Unreal Engine directory.

Example: SkipPluginCopy=true

Data Types: logical

SkipPluginEnableList — Plugin names to skip automatic enabling

"MathWorksGeoSpatial" (default) | string array

Since R2025a

Plugin names to skip for automatic enabling in the copied project specified as a string array. The copyExampleSim3dProject skips enabling the MathWorksGeoSpatial plugin by default. To enable all the plugins, set this argument as an empty array, [ ].

Example: SkipPluginEnableList=[]

Example: SkipPluginEnableList = ["MathWorksGeospatial", "MathWorksSimulation"] skips enabling MathWorksGeospatial and MathWorksSimulation plugins.

Data Types: string array

Examples

Copy Support Package Files to Destination Folder

Copy the support package files to C:\project.

sim3d.utils.copyExampleSim3dProject("C:\project");

Copy the support package files to C:\project with VerboseOutput set to true.

sim3d.utils.copyExampleSim3dProject("C:\project", VerboseOutput=true)

Copying '...\spkg\plugins\mw_aerospace\MathWorksAerospace' to '...\Marketplace\MathWorks\MathWorksAerospace'
Copying '...\spkg\plugins\mw_automotive\MathWorksAutomotiveContent' to '...\Marketplace\MathWorks\MathWorksAutomotiveContent'
Copying '...\spkg\plugins\mw_geospatial\MathWorksGeoSpatial' to '...\Marketplace\MathWorks\MathWorksGeoSpatial'
Copying '...\spkg\plugins\mw_simulation\MathWorksSimulation' to '...\Marketplace\MathWorks\MathWorksSimulation'
Copying '...\spkg\plugins\mw_uav\MathWorksUAVContent' to '...\Marketplace\MathWorks\MathWorksUAVContent'
Copying '...\spkg\plugins\rr_materials\RoadRunnerMaterials' to '...\Marketplace\MathWorks\RoadRunnerMaterials'
Copying '...\spkg\project\AutoVrtlEnv' to 'C:\project\AutoVrtlEnv'
Ensuring 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject' has write permissions
Enabling plugin 'MathWorksSimulation' in 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject'
Enabling plugin 'MathWorksUAVContent' in 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject'
Enabling plugin 'MathWorksAutomotiveContent' in 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject'
Enabling plugin 'MathWorksAerospace' in 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject'
Skipping automatic enable of plugin 'MathWorksGeoSpatial' in 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject'
Enabling plugin 'RoadRunnerMaterials' in 'C:\project\AutoVrtlEnv\AutoVrtlEnv.uproject'

Version History

Introduced in R2022b

R2025a: Skip automatic plugin enabling

Use the SkipPluginEnableList to skip enabling any MathWorks^® plugin in the copied project. By default, the copyExampleSim3dProject no longer enables MathWorksGeoSpatial.