QSDK 1.1 Documentation
Main Page | Modules | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members | Related Pages

Q::Region Struct Reference
[Geometric Objects]

A simple box geom for triggers. More...

#include <Q/q.h>

Inheritance diagram for Q::Region:

Q::Geom Q::Object Q::ObjectBase List of all members.

Public Member Functions

 Region ()
 Region (const char *name)
Utils::Result setBox (const Maths::Box3f &box)
Utils::Result setCollideable (bool b)

Static Public Member Functions

Region create (const char *name, const Maths::Box3f &box, const Database &db=Database())
Region create (const char *name, const Maths::Sphere3f &s, const Database &db=Database())
Region create (const char *name, const Maths::Cylinder3f &c, const Database &db=Database())
Region find (const char *name)
ClassType classType ()
Region cast (const ObjectBase &)

Detailed Description

A simple box geom for triggers.

The Region object is used to construct trigger volumes in the scene graph.

Constructor & Destructor Documentation

Q::Region::Region (   )  [inline]
 

Create a null region reference.

Q::Region::Region (  const char *  name  ) 
 

Search the currently attached databases for a region with the given name.

Member Function Documentation

Region Q::Region::cast (  const ObjectBase &   )  [static]
 

If the object referenced by obj is a region, then return a suitable Region reference to the object.

Note:
Casting this object will cause it to be loaded from the database if it is not currently resident.

Reimplemented from Q::Geom.

ClassType Q::Region::classType (   )  [static]
 

Return the type for this class.

Region Q::Region::create (  const char *  name,
const Maths::Cylinder3f &  c,
const Database &  db = Database()
)  [static]
 

Create a new region named name in the given database, db, (or the most recently attached read-write database if db is null). The shape of the region is given by the cylinder c. This is currently not supported.

Region Q::Region::create (  const char *  name,
const Maths::Sphere3f &  s,
const Database &  db = Database()
)  [static]
 

Create a new region named name in the given database, db, (or the most recently attached read-write database if db is null). The shape of the region is given by the sphere s.

Region Q::Region::create (  const char *  name,
const Maths::Box3f &  box,
const Database &  db = Database()
)  [static]
 

Create a new region named name in the given database, db, (or the most recently attached read-write database if db is null). The shape of the region is given by the axis-aligned bounding box box. The values of the new object's visible, intersectable, collidee, collider, boundsEvent and lightable flags are set to false.

Region Q::Region::find (  const char *  name  )  [static]
 

Search the currently attached databases for a region with the given name and return that object, if it exists.

Utils::Result Q::Region::setBox (  const Maths::Box3f &  box  ) 
 

Set the Box on the region to a new value. If the Region is being used by any Instance then Instance::resetBox must be called on every one of those instances, otherwise they will not reflect the change.

Utils::Result Q::Region::setCollideable (  bool  b  ) 
 

Set the collidability properties (i.e. collidee and collider) of the region based on the value of b.

Return to QSDK documentation Contents page. Contact details for support, information and fault-reporting.
Qube Software Limited © 2000-2004