[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

%VOS API Documentation

0.24.0-dev

Welcome to the VOS library. This API documentation contains fairly complete information about the C++ classes that make up the core VOS library, as well as various MetaObjects, Auxilliary and Utility libraries.

Please send feedback on this documentation so we can make it as clear and complete as possible (see http://interreality.org for contact information, forums and discussion lists). All of the classes are listed in the annotated class index, the full alphabetical listing, and in the class hierarchy. The modules listing groups classes by library.

See the VOS website interreality.org for up to date news, docs and code.

VOS core library

Some of the more important classes you should take a look at are VOS::vRef, VOS::Vobject, VOS::MetaObject, VOS::Site, VOS::LocalVipSiteExtension, VOS::Log, VOS::ParentChildRelation, and VOS::ChildChangeListener, from the libvos library.

Metaobject libraries

For working with properties, see VOS::Property and VOS::PropertyListener and libmetaobject_property.

For 3D objects, see the A3DL namespace in the libmetaobject_a3dl library.

Also of interest are Avatar, Talkative, Search, Hypercard, and Metadata from the libmetaobject_misc library.

For the service discovery metaobject, see VOS::Services from the libmetaobject_services library.

For object versioning, see VOS::VersionedVobject in the libmetaobject_versioned library and VOS::RevisionControlPersistance in the libvosext_revcontrol extension library.

Extension libraries

Use VOS::HTTPServer in libvosext_http for accessing Vobjects through HTTP, VOS::SQLPersistance (abstract interface) in libvosext_sqlpersist and libvosext_mysqldb (which provides an implementation for mySQL) for saving object information in a database backend, and VOS::FileSystemPersistance in libvosext_fspersist for saving object information as files. Use VOS::RevisionControlPersistence in libvosext_revcontrol to enable object revision control.

Auxilliary libraries

For the type helpers library (libtypehelper), see the TypeHelper class. For the ASE library (libASE), see libASE.h

Application utility libraries

A useful class for making VOS based applications is VOSApp and its subclass VOSDaemon (for background services), in the libvosapp library.