Virtual Reality Toolbox

vrnode/sync

Enable or disable synchronization of VRML fields with clients

Syntax

• sync(vrnode_object, 'field_name', 'action')
  

Arguments

vrworld_object	Name of a vrworld object representing a virtual world.
field_name	Name of the VRML field to be changed.
action	The action parameter determines what should be done: 'on' enables synchronization of this field. 'off' disables synchronization of this field.

Description

The sync method controls whether the value of a VRML field is synchronized.

When the field is marked 'on', the field value is updated every time it is changed on the client computer. If the field is marked 'off', the host computer ignores the changes on the client computer.

Synchronized fields add more traffic to the network line because the value of the field must be resent by the client any time it is changed. Because of this, you should mark for synchronization only the fields you need to scan for user changes. By default, fields are not synchronized.

Synchronization is meaningful only for readable fields. For example, readable fields are eventOuts and exposedFields. You cannot enable synchronization for the field eventIns or the nonexposed fields.

See Also

vrnode/get, vrnode

vrnode/setfield

vrfigure Object Reference