Documentation Center

  • Trial Software
  • Product Updates

vrworld/set

Change property values of vrworld object

Syntax

set(vrworld_object, 'property_name', property_value)

Arguments

vrworld_object

Name of a vrworld object representing a virtual world.

property_name

Name of the property.

property_value

New value of the property.

Description

You can change the values of the read/write virtual world properties. The following are properties of vrworld objects. Names are not case sensitive.

PropertyValueDescription

Clients

Scalar

Number of clients currently viewing the virtual world. Read only.

ClientUpdates

'off' | 'on'

Default: 'on'

Client cannot or can update the virtual scene. Read/write.

Description

String.

Default: automatically taken from the VRML file property title

Description of the virtual world as it appears on the main Web page. Read/write.

Figures

Vector of vrfigure objects

Vector of handles to Simulink® 3D Animation™ viewer windows currently viewing the virtual world. Read only.

FileName

String

Name of the associated VRML file. Read only.

Nodes

Vector of vrnode objects

Vector of vrnode objects for all named nodes in the virtual world. Read only.

Open

'off' | 'on'

Default: 'off'

Indicates a closed or open virtual world. Read only.

Record3D

'off' | 'on'

Default: 'off'

Enables 3-D animation recording. Read/write.

Record3DFileName

String.

Default: '%f_anim_%n.wrl'

3-D animation file name. The string can contain tokens that are replaced by the corresponding information when the animation recording takes place. For details, see File Name Tokens. Read/write.

Recording

'off' | 'on'

Default: 'off'

Animation recording toggle. This property acts as the master recording switch. Read/write.

RecordMode

'manual' | 'scheduled'

Default: 'manual'

Animation recording mode. Read/write.

RecordInterval

Vector of two doubles

Default: [0 0]

Start and stop times for scheduled animation recording. Corresponds to the virtual world object Time property. Read/write.

RemoteView

'off' | 'on'

Default: 'off'

Remote access flag. If the virtual world is enabled for remote viewing, it is set to 'on'; otherwise, it is set to 'off'. Read/write.

Time

Double

Current time in the virtual world. Read/write.

TimeSource

'external' | 'freerun'

Default: 'external'

Source of the time for the virtual world. If set to 'external', time in the scene is controlled from the MATLAB® interface (by setting the Time property) or the Simulink interface (simulation time).

If set to 'freerun', time in the scene advances independently based on the system timer. Read/write.

View

'off' | 'on'

Default: 'on'

Indicates an unviewable or viewable virtual world. Read/write.

See Also

|

Was this topic helpful?