Documentation

vrfigure class

Superclasses:

Create virtual reality figure

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

example

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

expand all

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.

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.

ElementDescription
leftDistance 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.
bottomDistance 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.
widthDistance between the right and left inner edges of the figure.
heightDistance between the top and bottom inner edges of the figure.

Example: [230 250 570 510]

Data Types: double

Output Arguments

expand all

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

captureCapture virtual reality figure image
closeClose virtual reality figure
getReturn property value of vrfigure object
isvalidCheck validity of vrfigure object handles
setSet property values of vrfigure object

Examples

expand all

Create a vrworld object that is associated with the virtual world vrmount.wrl. Open and view the virtual world.

myworld = vrworld('vrmount.wrl');
open(myworld);
f = vrfigure(myworld);

Introduced before R2006a

Was this topic helpful?