sim3d.World
Description
Use the sim3d.World
object to create and define virtual worlds
and run the cosimulation using Unreal Engine®.
Add or remove custom actors to or from the world. Only the actors added to the world object are displayed.
Store the virtual world scene, the root
sim3d.Actor
object, and the hierarchical structure of all actors in the scene.Optionally control the simulation logic by specifying custom functions. The output function passes data to the Unreal Engine to change actor properties in the engine.
Control the cosimulation between MATLAB® and the Unreal Engine.
Define the virtual world global coordinate system.
Control scene environment settings.
Control virtual world timing.
Creation
Syntax
Description
launches the default
Unreal Engine executable in a new window with a default name.world
= sim3d.World()
launches the Unreal Engine executable in a new window with the name specified.world
= sim3d.World('Name'
,name
)
runs the cosimulation while running the Unreal Engine executable in the background.world
= sim3d.World('RenderOffScreen'
,true
)
modifies the cosimulation by executing world
= sim3d.World('Setup'
,@setupFcn
)@setupFcn
before setup. This
custom function can be used to import additional data which required during simulation
runtime.
modifies the cosimulation by executing world
= sim3d.World('Update'
,@updateFcn
)@updateFcn
at each simulation
step. This custom function can be used to read data from the Unreal Engine.
modifies the cosimulation by executing world
= sim3d.World('Output'
,@outputFcn
)@outputFcn
at each simulation
step. This custom function can be used to send data about the specified sim3d.Actor
object
to the Unreal Engine.
modifies the cosimulation by executing world
= sim3d.World('Release'
,@releaseFcn
)@releaseFcn
at each simulation
step. This function can be used to delete additional data you may import during
setup.
Input Arguments
Properties
Object Functions
createViewport | Create viewport for world |
add | Add actor to virtual world |
run | Run cosimulation in virtual reality world |
remove | Remove actor added to world or remove all actors in world |