Dive/Tcl Reference Manual Index

Web Site: http://www.sics.se/dive/manual/tclref_idx.html

Main author: Emmanuel Frécon / emmanuel@sics.se

To ease look-up, two different index tables are offered:

• Alphabetic Index
• Functional Index

Alphabetic Index

• dive entities - Tree of Dive Entities.
• dive_abs_EulerXYZ - Absolute Euler rotation of an object.
• dive_abs_angle_axis - Absolute rotation of an object around an axis.
• dive_abs_fixedXYZ- Absolute rotation of an object.
• dive_abs_move - Abolute translation of an object.
• dive_abs_rotate - Absolute general rotation of an object.
• dive_abs_transform - Absolute general rotation and translation of an object.
• dive_abs_transport - Absolute general rotation and translation of an object (no collision interpolation).
• dive_add_sub - Modify the entity tree hierarchy.
• dive_add_to_visor - Add a new object to the personal visor.
• dive_ang_velocity - Set angular velocity of an object.
• dive_angle_axis - Rotate an object around an axis.
• dive_assoc_put - Add an object association to an actor.
• dive_association_put - Add an object association to a collection.
• dive_association_remove_byid - Remove an association from a collection.
• dive_association_remove_byname - Remove an association from a collection.
• dive_audio_group_join - Join an audio (lightweight) group.
• dive_audio_group_leave - Leave an audio (lightweight) group.
• dive_body_change - Change body representation with another object.
• dive_body_load - Change body representation with the content of an URL.
• dive_body_undo - Undo a changement.
• dive_bookmark_add - Add a bookmark in the current person actor.
• dive_bookmark_del - Remove a bookmark in the current person actor.
• dive_bookmark_goto - Transport the current person actor to a bookmark.
• dive_bookmark_list - Return a list of the bookmarks of the current person actor.
• dive_box - Modify the shape of a box view.
• dive_broadcast - Broadcast a command to all connected peers.
• dive_call - Execute a command in an object, wait for result.
• dive_can_render_stereo - Determine stereo capability.
• dive_center_entity - Center an entity.
• dive_change_interaction - Change the interaction mode.
• dive_change_world - Current peer changes world.
• dive_classdef - Declare class implemented by an entity.
• dive_collection_create - Create a collection, grouping of entities.
• dive_collection_membership - Calculate the membership of an entity within a collection.
• dive_compute_bbox - Compute the bounding box of an entity.
• dive_date - Return the current system date and/or time.
• dive_declare - Declare new command (procedure) in an entity.
• dive_dir_velocity - Set directional velocity of an object.
• dive_entity_copy - Copy an entity hierarchy.
• dive_entity_exist - Find out whether an entity with a given id exists in the database or not.
• dive_entity_info - Get entity information.
• dive_entity_message - Send an entity message, i.e. an application-level event.
• dive_entity_request - Send a request for an entity to group.
• dive_entity_rotation_pt - Set origo for an entity.
• dive_entity_save - Save an entity to a file, in the Dive file format.
• dive_EulerXYZ - Euler rotation of an object.
• dive_exec - Execute an external command, if authorized.
• dive_export - Export an entity to a file in another file format.
• dive_find_ancestor - Find top most ancestor of an entity.
• dive_find_ancestor_byclass - Find ancestor of an entity matching class name.
• dive_find_ancestor_byname - Find ancestor of an entity matching name.
• dive_find_assoc - Find entity associated to an actor with a given logical name.
• dive_find_assoc_actor - Find actor which has a logical association to an entity.
• dive_find_closest_byclass - Find nearest entity matching class name.
• dive_find_closest_byname - Find nearest entity matching name.
• dive_find_entity_byname- Find entity matching name.
• dive_find_first_realobj - Find first ancestor with "realobj" flag on.
• dive_find_root - Find world containing an entity.
• dive_find_sub_byclass - Find descendant of entity matching class name.
• dive_find_sub_byname - Find descendant of entity matching name.
• dive_find_super- Find direct parent of entity.
• dive_fixedXYZ - Rotate an object.
• dive_flag - Set local and/or distributed flags.
• dive_for_all_ancestors - Execute command for all ancestors of an entity matching a type.
• dive_for_all_descendants - Execute command for all descendants of an entity matching a type.
• dive_for_all_entities - Execute command for all entities matching a type.
• dive_for_all_subs - Exectue command for all direct children of an entity matching a type.
• dive_get_audio_group_addr - Get audio group address associated with entity.
• dive_get_center - Get gravitation center of an object.
• dive_get_group_addr - Get group address associated with entity.
• dive_get_radius - Get radius of sphere bounding an object.
• dive_group_join - Join a (lightweight) group.
• dive_group_leave - Leave a (lightweight) group.
• dive_group_member - Test if process is member of a (lightweight) group.
• dive_hastcl - Test if entity has a Dive/Tcl interpreter.
• dive_input_signal - Simulate an input signal.
• dive_insert_sub - Modify the entity tree hierarchy.
• dive_interaction_signal - Simulate an interaction signal.
• dive_is_ancestor - Test if an entity is among the ancestors of another one.
• dive_isa - Test if an entity implements a given class.
• dive_isect_objs - Test if two objects intersect.
• dive_isect_ray_object - Test which object is intersected by a ray and where.
• dive_mark_change - Change marked object up and down in original mark's hierarchy.
• dive_mark_get - Return object marked by an actor.
• dive_mark_put - Put new mark in person actor.
• dive_material - Manipulate material vector associated to an object.
• dive_material_index - Change material used by a view.
• dive_move - Translate an object.
• dive_movement_abort - Abort a running movement.
• dive_movement_to_obj - Move an object towards another.
• dive_movement_to_pos - Move an object towards a world position.
• dive_new_group_addr - Generate and return a new Dive group address.
• dive_name - Change the name of an entity.
• dive_object_blink - Blink 5 seconds an object by switching on and off wireframe flag.
• dive_object_load - Load an URL in front of the current person actor.
• dive_object_source - Return a string describing an entity in the Dive file format.
• dive_parse_string - Parse a 3D description from a string.
• dive_plugin_is_loaded - Check if a specific DIVE plugin is loaded.
• dive_pointset_vertex - Modify the vertices of a pointset view.
• dive_property_create- Create a property in an entity.
• dive_property_get- Get value of a property.
• dive_property_link - Link a property in an entity to a global Tcl variable.
• dive_property_put - Put a new value in a property.
• dive_property_remove - Delete a property from an entity.
• dive_random - Return a random floating point number between 0 and 1.
• dive_readbuf_withMIME - Open a viewer for a MIME document residing in memory.
• dive_readURL - Attach a new entity hierarchy to an existing entity.
• dive_readURL_as_addr - Read the content of any URL and return it as an (indirect) reference.
• dive_readURL_as_text - Return raw content of an URL in a variable.
• dive_readURL_withMIME - Read content of an URL an treat it according to its MIME type.
• dive_register - Register a procedure to be triggered when a Dive event occur.
• dive_register_velocity - Register a Dive/Tcl command to be called each time the position of an object is requested.
• dive_remove - Remove an entity.
• dive_remove_from_visor - Remove an object from the personal visor.
• dive_reset_rot - Align Y axis of an object with its world's Y axis.
• dive_rmtmp - Remove a temporary file.
• dive_rotate - General rotation of an object.
• dive_saveURL - Save the raw content of any URL in a local temporary file.
• dive_scale - Scale an object.
• dive_self - Return entity in which the script is executed.
• dive_send - Execute a command in an entity.
• dive_set_audio_group_addr - Set audio group address associated with entity.
• dive_set_audio_src_type - Set audio source type of an entity.
• dive_sleep - Sleep some milliseconds.
• dive_smooth_entity - Improve Gouraud shading in an entity.
• dive_source - Inline another Dive/Tcl script.
• dive_switch_choice - Change the current state of a switch node.
• dive_text - Change string content of a text view.
• dive_texture - Manipulate texture vector associated to an object.
• dive_texture_index - Change texture used by a view.
• dive_texture_move - Translate texture on surface.
• dive_texture_abs_move - Translate texture on surface.
• dive_texture_angle_point - Rotate texture on surface.
• dive_texture_abs_angle_point - Rotate texture on surface.
• dive_time_add - Add two divetimes.
• dive_time_deregister - Unregister a timer or a timeout (period unknown).
• dive_time_diff - Return the difference between two absolute times.
• dive_time_get - Return an absolute time.
• dive_time_incr - Increment an absolute time.
• dive_time_sub - Subtract two divetimes.
• dive_time_unregister - Unregister a timer or a timeout.
• dive_timeout - Register a command to be executed once some milliseconds have expired.
• dive_timer - Register a command to be executed perodically.
• dive_transform - General translation and rotation of an object (no collision interpolation).
• dive_transport - General translation and rotation of an object.
• dive_type - Return type of an entity.
• dive_vehicle_fast - Start/stop fastrak vehicle for a person actor.
• dive_vehicle_fly - Start/stop a fly vehicle in the current person actor.
• dive_vehicle_hmd - Start/stop a HMD vehicle in the current person actor.
• dive_vehicle_kbd - Start/stop a keyboard vehicle in the current person actor.
• dive_vehicle_mouse - Start/stop a mouse vehicle in the current person actor.
• dive_vehicle_object_mouse - Start/stop a vehicle for an object.
• dive_vehicle_speed - Set/get speed of 3D vehicles in the current person actor.
• dive_vehicle_walk - Start/stop a simple vehicle in the current person actor.
• dive_vehicle_wand - Start/stop a wand vehicle in the current person actor.
• dive_vehicle_wand_change - Turn off or on wand features.
• dive_velocity - Set angular and directional velocities of an object.
• dive_video_configure - Configure video.
• dive_video_image_quality - Set quality of video images.
• dive_video_in_start - Start video in.
• dive_video_in_stop - Stop video in.
• dive_video_out_start - Start video out.
• dive_video_out_stop - Stop video out.
• dive_world_disconnect - Disconnect from a given world.

Functional Index

Event Registration

• dive_register - Register a procedure to be triggered when a Dive event occur.

Time

• dive_timer - Register a command to be executed perodically.
• dive_timeout - Register a command to be executed once some milliseconds have expired.
• dive_time_unregister - Unregister a timer or a timeout.
• dive_time_deregister - Unregister a timer or a timeout (period unknown).
• dive_sleep - Sleep some milliseconds.
• dive_time_add - Add two divetimes.
• dive_time_diff - Return the difference between two absolute times.
• dive_time_get - Return an absolute time.
• dive_time_incr - Increment an absolute time.
• dive_time_sub - Subtract two divetimes.

Geometry

• dive_move - Translate an object.
• dive_abs_move - Abolute translation of an object.
• dive_fixedXYZ - Rotate an object.
• dive_abs_fixedXYZ- Absolute rotation of an object.
• dive_EulerXYZ - Euler rotation of an object.
• dive_abs_EulerXYZ - Absolute Euler rotation of an object.
• dive_angle_axis - Rotate an object around an axis.
• dive_abs_angle_axis - Absolute rotation of an object around an axis.
• dive_rotate - General rotation of an object.
• dive_abs_rotate - Absolute general rotation of an object.
• dive_transform - General translation and rotation of an object (no collision interpolation).
• dive_abs_transform - Absolute general rotation and translation of an object (no collision interpolation).
• dive_transport - General translation and rotation of an object.
• dive_abs_transport - Absolute general rotation and translation of an object.
• dive_dir_velocity - Set directional velocity of an object.
• dive_ang_velocity - Set angular velocity of an object.
• dive_velocity - Set angular and directional velocities of an object.
• dive_register_velocity - Register a Dive/Tcl command to be called each time the position of an object is requested.
• dive_reset_rot - Align Y axis of an object with its world's Y axis.
• dive_scale - Scale an object.
• dive_texture_move - Translate texture on surface.
• dive_texture_abs_move - Translate texture on surface.
• dive_texture_angle_point - Rotate texture on surface.
• dive_texture_abs_angle_point - Rotate texture on surface.

Database look-up

• dive_find_ancestor - Find top most ancestor of an entity.
• dive_find_ancestor_byclass - Find ancestor of an entity matching class name.
• dive_find_ancestor_byname - Find ancestor of an entity matching name.
• dive_find_assoc - Find entity associated to an actor with a given logical name.
• dive_find_assoc_actor - Find actor which has a logical association to an entity.
• dive_find_closest_byclass - Find nearest entity matching class name.
• dive_find_closest_byname - Find nearest entity matching name.
• dive_find_entity_byname- Find entity matching name.
• dive_find_first_realobj - Find first ancestor with "realobj" flag on.
• dive_find_root - Find world containing an entity.
• dive_find_sub_byclass - Find descendant of entity matching class name.
• dive_find_sub_byname - Find descendant of entity matching name.

Entity information

• dive_compute_bbox - Compute the bounding box of an entity.
• dive_entity_exist - Find out whether an entity with a given id exists in the database or not.
• dive_entity_info - Get entity information.
• dive_find_super- Find direct parent of entity.
• dive_get_center - Get gravitation center of an object.
• dive_get_group_addr - Get group address associated with entity.
• dive_get_radius - Get radius of sphere bounding an object.
• dive_hastcl - Test if entity has a Dive/Tcl interpreter.
• dive_is_ancestor - Test if an entity is among the ancestors of another one.
• dive_isa - Test if an entity implements a given class.
• dive_isect_objs - Test if two objects intersect.
• dive_isect_ray_object - Test which object is intersected by a ray and where.
• dive_self - Return entity in which the script is executed.
• dive_type - Return type of an entity.
• dive_mark_get - Return object marked by an actor.

Hierarchy and entities modifications

• dive_add_sub - Modify the entity tree hierarchy.
• dive_assoc_put - Add an object association to an actor.
• dive_box - Modify the shape of a box view.
• dive_classdef - Declare class implemented by an entity.
• dive_declare - Declare new command (procedure) in an entity.
• dive_entity_copy - Copy an entity hierarchy.
• dive_entity_request - Send a request for an entity to group.
• dive_flag - Set local and/or distributed flags.
• dive_insert_sub - Modify the entity tree hierarchy.
• dive_material - Manipulate material vector associated to an object.
• dive_material_index - Change material used by a view.
• dive_name - Change the name of an entity.
• dive_parse_string - Parse a 3D description from a string.
• dive_pointset_vertex - Modify the vertices of a pointset view.
• dive_remove - Remove an entity.
• dive_switch_choice - Change the current state of a switch node.
• dive_text - Change string content of a text view.
• dive_texture - Manipulate texture vector associated to an object.
• dive_texture_index - Change texture used by a view.

Hierarchy parsing

• dive_for_all_ancestors - Execute command for all ancestors of an entity matching a type.
• dive_for_all_descendants - Execute command for all descendants of an entity matching a type.
• dive_for_all_entities - Execute command for all entities matching a type.
• dive_for_all_subs - Exectue command for all direct children of an entity matching a type.

Properties

• dive_property_create- Create a property in an entity.
• dive_property_remove - Delete a property from an entity.
• dive_property_get- Get value of a property.
• dive_property_link - Link a property in an entity to a global Tcl variable.
• dive_property_put - Put a new value in a property.

Entity-Entity communication

• dive_broadcast - Broadcast a command to all connected peers.
• dive_call - Execute a command in an object, wait for result.
• dive_send - Execute a command in an entity.
• dive_entity_message - Send an entity message, i.e. an application-level event.
• dive_input_signal - Simulate an input signal.
• dive_interaction_signal - Simulate an interaction signal.

Group connection/disconnection

• dive_audio_group_join - Join an audio (lightweight) group.
• dive_audio_group_leave - Leave an audio (lightweight) group.
• dive_change_world - Current peer changes world.
• dive_get_audio_group_addr - Get audio group address associated with entity.
• dive_group_join - Join a (lightweight) group.
• dive_group_leave - Leave a (lightweight) group.
• dive_group_member - Test if process is member of a (lightweight) group.
• dive_new_group_addr - Generate and return a new Dive group address.
• dive_set_audio_group_addr - Set audio group address associated with entity.
• dive_world_disconnect - Disconnect from a given world.

URL and File I/O

• dive_source - Inline another Dive/Tcl script.
• dive_readbuf_withMIME - AOpen a viewer for a MIME document residing in memory.
• dive_readURL - Attach a new entity hierarchy to an existing entity.
• dive_readURL_withMIME - Read content of an URL an treat it according to its MIME type.
• dive_readURL_as_text - Return raw content of an URL in a variable.

Video

• dive_video_configure - Configure video.
• dive_video_image_quality - Set quality of video images.
• dive_video_in_start - Start video in.
• dive_video_in_stop - Stop video in.
• dive_video_out_start - Start video out.
• dive_video_out_stop - Stop video out.

Miscellaneous

• dive_date - Return the current system date and/or time.
• dive entities - Tree of Dive Entities.
• dive_exec - Execute an external command, if authorized.
• dive_plugin_is_loaded - Check if a specific DIVE plugin is loaded.
• dive_random - Return a random floating point number between 0 and 1.

Movement (PersonActor)

• dive_movement_abort - Abort a running movement.
• dive_movement_to_obj - Move an object towards another.
• dive_movement_to_pos - Move an object towards a world position.

Vehicles (PersonActor)

• dive_vehicle_fast - Start/stop fastrak vehicle for a person actor.
• dive_vehicle_fly - Start/stop a fly vehicle in the current person actor.
• dive_vehicle_hmd - Start/stop a HMD vehicle in the current person actor.
• dive_vehicle_kbd - Start/stop a keyboard vehicle in the current person actor.
• dive_vehicle_mouse - Start/stop a mouse vehicle in the current person actor.
• dive_vehicle_object_mouse - Start/stop a vehicle for an object.
• dive_vehicle_speed - Set/get speed of 3D vehicles in the current person actor.
• dive_vehicle_walk - Start/stop a simple vehicle in the current person actor.
• dive_vehicle_wand - Start/stop a wand vehicle in the current person actor.
• dive_vehicle_wand_change - Turn off or on wand features.

Bookmarks (PersonActor)

• dive_bookmark_add - Add a bookmark in the current person actor.
• dive_bookmark_del - Remove a bookmark in the current person actor.
• dive_bookmark_goto - Transport the current person actor to a bookmark.
• dive_bookmark_list - Return a list of the bookmarks of the current person actor.

URL and File I/O (PersonActor)

• dive_object_load - Load an URL in front of the current person actor.
• dive_entity_save - Save an entity to a file, in the Dive file format.
• dive_export - Export an entity to a file in another file format.
• dive_object_source - Return a string describing an entity in the Dive file format.
• dive_saveURL - Save the raw content of any URL in a local temporary file.
• dive_rmtmp - Remove a temporary file.

Body Changements (PersonActor)

• dive_body_change - Change body representation with another object.
• dive_body_load - Change body representation with the content of an URL.
• dive_body_undo - Undo a changement.

Miscellaneous (PersonActor)

• dive_add_to_visor - Add a new object to the personal visor.
• dive_remove_from_visor - Remove an object from the personal visor.
• dive_mark_change - Change marked object up and down in original mark's hierarchy.
• dive_mark_put - Put new mark in person actor.
• dive_object_blink - Blink 5 seconds an object by switching on and off wireframe flag.
• dive_smooth_entity - Improve Gouraud shading in an entity.