vrworld/get (Virtual Reality Toolbox)

Read the property value of a vrworld object

Syntax

get(vrworld_object)
x = get(vrworld_object, 'property_name')

Arguments

vrworld_object
Name of a vrworld object representing a virtual world.

property_name
Name of the property.

`vrworld_object`	Name of a vrworld object representing a virtual world.
`property_name`	Name of the property.

Description

If no property name is given, the get(vrworld_object) method displays all the virtual world properties and their values. When a property name is given, the value of that property is returned.

The following are properties of vrworld objects. Names are not case sensitive.

Field Name
Description

Clients
Number of clients viewing this world.

ClientUpdates
This is 'on' if the clients are allowed to update the viewed scene and 'off' if they are not.

Description
Description of the virtual world, as it appears on the main Web page.

Figures
Handles of figures currently open for this world.

FileName
Name of the VRML file associated with this world.

Nodes
A vector of vrnode objects for all nodes in the virtual world.

Open
If the virtual world is open, value is 'on'. If the virtual world is closed, value is 'off'.

RemoteView
If virtual world is enabled for remote viewing, it is set to 'on'; otherwise, it is set to 'off'.

View
If virtual world is enabled for viewing, it is set to 'on'; otherwise, it is set to 'off'.

Field Name	Description
`Clients`	Number of clients viewing this world.
`ClientUpdates`	This is `'on'` if the clients are allowed to update the viewed scene and `'off'` if they are not.
`Description`	Description of the virtual world, as it appears on the main Web page.
`Figures`	Handles of figures currently open for this world.
`FileName`	Name of the VRML file associated with this world.
`Nodes`	A vector of vrnode objects for all nodes in the virtual world.
`Open`	If the virtual world is open, value is `'on'`. If the virtual world is closed, value is `'off'`.
`RemoteView`	If virtual world is enabled for remote viewing, it is set to `'on'`; otherwise, it is set to `'off'`.
`View`	If virtual world is enabled for viewing, it is set to `'on'`; otherwise, it is set to `'off'`.

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 VRML file containing a WorldInfo node with a title property (see the VRML reference), the Description property is loaded from the VRML 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.

See Also

vrworld/set, vrworld

vrworld/edit vrworld/isvalid