![interreality.org [VOS]](/wwwvos/banner5.jpg)
api_main_page
Go to the documentation of this file.00001 00002 /** @mainpage %VOS API Documentation 00003 00004 Welcome to the %VOS library. This API documentation contains fairly complete 00005 information about the C++ classes that make up the core %VOS library, as well 00006 as various MetaObjects, Auxilliary and Utility libraries. 00007 00008 Please send feedback on this documentation so we can make it as clear and 00009 complete as possible. Contact us at http://www.interreality.org with any suggestions. 00012 00013 All of the classes are listed in the <a href="annotated.html">annotated class 00014 index</a>, the <a href="classes.html">full alphabetical listing</a>, 00015 and in the <a href="hierarchy.html">class hierarchy</a>. The <a 00016 href="modules.html">modules listing</a> groups classes by library. 00017 00018 See the %VOS website <a href="http://www.interreality.org">interreality.org</a> 00019 for up to date news, docs and code. 00020 00021 <h3>%VOS core library</h3> 00022 00023 Some of the more important classes you should take a look at are VOS::vRef, 00024 VOS::Vobject, 00025 VOS::MetaObject, VOS::Site, VOS::LocalVipSiteExtension, VOS::Log, 00026 VOS::ParentChildRelation, and VOS::ChildChangeListener, from the @ref libvos 00027 library. 00028 00029 <h3>Metaobject libraries</h3> 00030 00031 For working with properties, see VOS::Property and VOS::PropertyListener and 00032 @ref libmetaobject_property. 00033 00034 For 3D objects, see the A3DL namespace in the @ref libmetaobject_a3dl library. 00035 00036 Also of interest are Avatar, Talkative, Search, Hypercard, 00037 and Metadata from the @ref libmetaobject_misc library. 00038 00039 For the service discovery metaobject, see VOS::Services from the 00040 @ref libmetaobject_services library. 00041 00042 For object versioning, see VOS::VersionedVobject in the @ref 00043 libmetaobject_versioned library and VOS::RevisionControlPersistance in 00044 the @ref libvosext_revcontrol extension library. 00045 00046 <h3>Extension libraries</h3> 00047 00048 Use VOS::HTTPServer in @ref libvosext_http for 00049 accessing Vobjects through HTTP, VOS::SQLPersistance (abstract interface) in 00050 @ref libvosext_sqlpersist and @ref libvosext_mysqldb (which provides 00051 an implementation for mySQL) 00052 for saving object information in a database 00053 backend, and VOS::FileSystemPersistance in @ref libvosext_fspersist for 00054 saving object information as files. Use VOS::RevisionControlPersistence 00055 in libvosext_revcontrol to enable object revision control. 00056 00057 00058 <h3>Auxilliary libraries</h3> 00059 00060 For the type helpers library (@ref libtypehelper), see the TypeHelper class. 00061 For the ASE library (@ref libASE), see libASE.h 00062 00063 <h3>Application utility libraries</h3> 00064 00065 A useful class for making %VOS based applications is VOSApp and 00066 its subclass VOSDaemon (for background services), in the @ref libvosapp 00067 library. 00068 00069 */ 00070 00071 /** @defgroup libvos libvos 00072 VOS Library. 00073 required libraries: @LIBSSL@ @LIBSOCKS@ @LIBZ@ @LEXLIB@ 00074 */ 00075 /** @defgroup libmetaobject_property libmetaobject_property 00076 Property metaobject. 00077 Required libraries: -lvos 00078 */ 00079 /** @defgroup libmetaobject_misc libmetaobject_misc 00080 Misc metaobjects. 00081 Required libraries: -lvos -lmetaobject_property 00082 */ 00083 /** @defgroup libmetaobject_services libmetaobject_services 00084 Service list metaobject. 00085 Libraries: -lvos -lmetaobject_property -lmetaobject_misc 00086 00087 */ 00088 /** @defgroup libmetaobject_a3dl libmetaobject_a3dl 00089 3D metaobjects. 00090 Libraries: -lvos -lmetaobject_property 00091 */ 00092 /** @defgroup libvosapp libvosapp 00093 Daemon utility library. 00094 Libraries: -lvos -lmetaobject_property -lmetaobject_misc -lmetaobject_services 00095 */ 00096 /** @defgroup libASE libASE 00097 ASE (3D Studio Max ASCII Scene Export) library. 00098 */ 00099 /* Xdefgroup libmetatronic libmetatronic 00100 Implements VOSGUI interfaces by providing a layer between libmetaobject_gui 00101 and wxWidgets (see <a href="http://www.wxwidgets.org">www.wxwidgets.org</a>). 00102 To get started with metatronic, see the Metatronic class. 00103 00104 Libraries: <code>-lvos -lmetaobject_property -lmetaboject_gui</code>. 00105 For wxWidgets flags, use <code>`wx-config --lflags`</code> for link flags 00106 and <code>`wx-config --cxxflags`</code> for compiler flags. 00107 */ 00108 00109 /** @defgroup libmetaobject_versioned libmetaobject_versioned 00110 Provides MetaObject interface to object versions. 00111 @sa libvosext_revcontrol 00112 00113 Libraries: <code>-lvos -lmetaobject_property</code> 00114 */ 00115 00116 /** @defgroup libvosext_revcontrol libvosext_revcontrol 00117 Provides extensions that record changes made to Vobjects on a site. 00118 @see libmetaobject_versioned 00119 00120 Libraries: <code>-lvos -lmetaobject_property</code> 00121 */ 00122 00123 /** @defgroup libvosext_http libvosext_http 00124 Provides extensions that allow access to Vobjects and Properties via HTTP. 00125 00126 Libraries: <code>-lvos -lmetaobject_property</code> 00127 */ 00128 00129 /** @defgroup libvosext_sqlpersist libvosext_sqlpersist 00130 Provides extensions that use an SQL database as a persistent Vobject 00131 backend. 00132 @see libvosext_mysqldb 00133 00134 Libraries: <code>-lvos</code> 00135 */ 00136 00137 /** @defgroup libvosext_mysqldb libvosext_mysqldb 00138 Provides access to mySQL for the SQL persistance extension. 00139 @see libvosext_sqlpersist 00140 00141 Libraries: <code></code> 00142 */ 00143 00144 /** @defgroup libvosext_fspersist libvosext_fspersist 00145 Provides extensions that use files on the filesystem as a persistent 00146 Vobject backend. 00147 00148 Libraries: <code>-lvos</code> 00149 */ 00150 00151 00152 00153 00154