vrworld/get
Property value of vrworld
object
Syntax
get(vrworld_object)
x = get(vrworld_object)
x = get(vrworld_object, 'property_name
')
Arguments
| A |
| Name of the property. |
Description
get(vrworld_object)
displays all the virtual world properties and their values.
x = get(vrworld_object)
returns an M-by-1 structure where the field names are the names of the virtual world properties. Each field contains the associated property value. M is equal to length(vrworld_object)
.
x = get(vrworld_object, '
returns the value of the specified property.property_name
')
If
vrworld_object
is a vector ofvrworld
handles, theget
method returns an M-by-1 cell array of values where M is equal tolength(vrworld_object)
.If
property_name
is a 1-by-N or N-by-1 cell array of strings containing field names, theget
method returns an M-by-N cell array of values.
The following are properties of vrworld
objects. Names are not case sensitive.
Property | Value | Description |
---|---|---|
| Scalar | Number of clients currently viewing the virtual world. Read only. |
|
Default: | Client cannot or can update the virtual scene. Read/write. |
| Vector of canvases | Vector of handles of canvases currently open for this world. |
| String. Default: automatically taken from the virtual world 3D file property | Description of the virtual world as it appears on the main Web page. Read/write. |
| Vector of | Vector of handles to Simulink® 3D Animation™ Viewer windows currently viewing the virtual world. Read only. |
| String | Name of the associated virtual world 3D file. Read only. |
| Vector of | Vector of |
|
Default: | Indicates a closed or open virtual world. Read only. |
|
Default: | Enables 3-D animation recording. Read/write. |
| String. Default: | 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. |
|
Default: | Animation recording toggle. This property acts as the main recording switch. Read/write. |
|
Default: | Animation recording mode. Read/write. |
| Vector of two doubles Default: | Start and stop times for scheduled animation recording. Corresponds to the virtual world object |
|
Default: | Remote access flag. If the virtual world is enabled for remote viewing, it is set to |
|
Default: | Render |
| Double | Current time in the virtual world. Read/write. |
|
Default: | Source of the time for the virtual world. If set to If set to |
|
Default: | Indicates an unviewable or viewable virtual world. Read/write. |
| Vector of | Vector of |
The ClientUpdates
property is set to 'on'
by default and can be set by the user. When it is set to 'off'
, the viewers looking at this virtual world should not update the view according to the virtual world changes. That is, the view is frozen until this property is changed to 'on'
. This is useful for preventing tearing effects with complex animations. Before every animation frame, set ClientUpdates
to 'off'
, make the appropriate modifications to the object positions, and then switch ClientUpdates
back to 'on'
.
The Description
property defaults to '(untitled)'
and can be set by the user. If the virtual world is loaded from a virtual world 3D file containing a WorldInfo node with a title
property, the Description
property is loaded from the virtual world 3D file instead.
The Nodes
property is valid only when the virtual world is open. If the virtual world is closed, Nodes
always contains an empty vector.
The RemoteView
property is set to 'off'
by default and can be set by the user. If it is set to 'on'
, all viewers can access the virtual world through the Web interface. If it is set to 'off'
, only host viewers can access it.
The View
property is set to 'on'
by default and can be set by the user. When it is set to 'off'
, the virtual world is not accessible by the viewer. You rarely use this property.
Version History
Introduced before R2006a