vrfigure Class

Superclasses:

(To be removed) Create virtual reality figure

vrfigure will be removed in a future release. For more information, see Version History.

Description

Creates a virtual reality figure.

To access vrfigure properties, use the vrfigure/get method. To change properties, use the vrfigure/set method.

If you create a vrfigure object by specifying a virtual world, the virtual figure displays in the viewer specified in the vrsetpref DefaultViewer property.

Construction

virtual_figure = vrfigure(world) creates a virtual reality figure showing the specified virtual world.

virtual_figure = vrfigure(world,position) creates a virtual reality figure at the specified position.

virtual_figure = vrfigure([]) returns an empty vrfigure object that does not have a visual representation.

virtual_figure = vrfigure returns an empty vector of type vrfigure.

Input Arguments

world — Virtual world

vrworld object

Virtual world, specified as a vrworld object.

Note

Open the virtual world that you specify before you create a vrfigure object using that virtual world.

Position — Figure location and size

vector with four elements

Location and size of virtual figure, specified as the vector in the form [left bottom width height]. Specify measurements in pixels.

Note

On Windows^® systems, figure windows cannot be less than 104 pixels wide, regardless of the value of the Position property.

Element	Description
left	Distance from the left edge of the primary display to the inner left edge of the figure window. This value can be negative on systems that have more than one monitor.
bottom	Distance from the bottom edge of the primary display to the inner bottom edge of the figure window. This value can be negative on systems that have more than one monitor.
width	Distance between the right and left inner edges of the figure.
height	Distance between the top and bottom inner edges of the figure.

Example: [230 250 570 510]

Data Types: double

Output Arguments

virtual_figure — Virtual reality figure

vrfigure object | empty vector of type vrfigure

If you use a vrworld object as an input argument, virtual_figure is a virtual reality figure, represented by a vrfigure object.

If you use an empty array as an input argument, the vrfigure constructor returns a vector of type vrfigure.

If you do not use an input argument, the vrfigure constructor returns an empty vector of type vrfigure.

Methods

capture	(To be removed) Capture virtual reality figure image
close	(To be removed) Close virtual reality figure
get	(To be removed) Return property value of vrfigure object
isvalid	(To be removed) Check validity of vrfigure object handles
set	(To be removed) Set property values of vrfigure object

Version History

Introduced before R2006a

R2025a: Warns

The vrfigure function will be removed in a future release. The Simulink^® 3D Animation™ Viewer has been removed so vrfigure does not open the virtual world. For alternate functionality, see Transition Virtual Reality World to Unreal Engine 3D Environment.

R2023b: To be removed

The vrfigure runs without warning and will be removed in a future release.