QSDK 1.1 Documentation

QServer

Files
file	q.h
Modules
Animation
Audio
Geometric Objects
Knowledge Base
Particle Effects
Shading & Lighting
User Interface
Performance Counters
User Event Listeners
Object Iterators
Compounds
struct	Application
	The starting point of everything. More...
struct	BoundsReactor
	Bounds event filter. More...
struct	Camera
	The eye point in the scene. More...
struct	Clip
	Raw mime-type'd data. More...
struct	Clump
	Compacted scene transitions. More...
struct	Database
	The Q file store. More...
struct	Environment
	Zone global parameters. More...
struct	Group
	Transform and grouping node for the scene graph. More...
struct	Instance
	Connects Geoms to Groups to place in the scene. More...
struct	List
	A collection of objects. More...
struct	Object
	Generic object for persistent data. More...
struct	ObjectBase
	Generic reference counted object. More...
struct	Portal
	Zone-Zone connection geom. More...
struct	PortalInstance
	Instance required for using Portal. More...
struct	RayInfo
	Information returned successful ray casts. More...
struct	Scope
	Scene simulation radius. More...
struct	ScopeReactor
	Scope event filter. More...
struct	Text
	A simple wrapper class for null-terminated strings. More...
struct	Transition
	A geometry object for doing simple cross-fade effects. More...
struct	TransitionInstance
	Instance required for using Transitions. More...
struct	Zone
	Root 3D scene object. More...
Enumerations
enum	ResultCodes {   WObjectPresent = WARNING_CODE( 7 , 2),   WClipPresent = WARNING_CODE( 7 , 3),   WNameConflict = WARNING_CODE( 7 , 4),   WDatabaseOpenedReadOnly = WARNING_CODE( 7 , 5),   ENameConflict = ERROR_CODE( 7 , 1),   ENoAnimation = ERROR_CODE( 7 , 2),   EBadObject = ERROR_CODE( 7 , 3),   EBadType = ERROR_CODE( 7 , 4),   ENotFound = ERROR_CODE( 7 , 5),   ECantCreate = ERROR_CODE( 7 , 6),   ENotUnique = ERROR_CODE( 7 , 7),   EAudioInvalidFormat = ERROR_CODE( 7 , 8),   EAudioCacheOverflow = ERROR_CODE( 7 , 9),   EDatabaseAlreadyOpened = ERROR_CODE( 7 , 10),   ECannotAccess = ERROR_CODE( 7 , 11) }

---

Detailed Description

The QServer API is the main work horse of the Q Engine. It is the main entry point for controlling the Q Engine.

The QServer API comprises of a number of subsections that are described separately, but they all have a number of things in common.

• All objects in QServer are purely handles that reference through to internal objects. These handles are reference counted.
• All objects are created using create methods and not constructors. Objects that can have names are automatically saved in to a database if a name is specified.
• Dropping the last reference to an object does not guarantee that it will be deleted. Another object might have an internal reference to the object, that keeps it alive. Calling destroy on the object will force all internal references to be broken, so that dropping the last API reference will cause the object to be deleted.
• Heavyweight objects, ie. objects that are stored in the database, can be accessed explicitly by using the find method of the class and using the object's name to identify it.

---

Enumeration Type Documentation

enum Q::ResultCodes

Standard codes returned in a Utils::Result. See also: Utils::Result Enumeration values: WObjectPresent  An object that would have been copied into a database already existed there. WClipPresent  A clip that would have been copied into a database already existed there and so is assumed to be a duplicate. WNameConflict  An object that is being copied into a database has the same name as one that already exists. This means that although it retains its name, it will not be retrievable by name. WDatabaseOpenedReadOnly  The user has attempted to open a read-only Database with modify rights. In this case, the file is opened read only and only readOnly object access is granted. See also: Database::connect ENameConflict  An object that is being copied into a database has the same name as one that already exists and this behaviour is not wanted. ENoAnimation  See also: Playback::getAnimation() EBadObject  An API object that was passed to the function was invalid. EBadType  An API object that was passed to the function was of the wrong type. This happens in cases where, for example, the function takes a Geom as the argument type, but is actually after a sub-set of Geom types as valid parameters. ENotFound  The requested named object could not be found. ECantCreate  A persistent object creation failed because it failed to be written into the database. ENotUnique  A persistent object creation failed because its name was already used by an object of that type. EAudioInvalidFormat  An audio playback failed because its source did not have a valid format. EAudioCacheOverflow  An audio playback failed because the sound cache overflowed. See also: SpeakerSet::setSoundCacheSize EDatabaseAlreadyOpened  The Database has already been opened. See also: Database::connect ECannotAccess  The file that backs up the Database does not exist or cannot be opened (maybe already in use). See also: Database::connect

		Qube Software Limited © 2000-2004