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

Q::Portal Struct Reference
[QServer]

Zone-Zone connection geom. More...

#include <Q/q.h>

Inheritance diagram for Q::Portal:

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

Public Member Functions

 Portal ()
 Portal (const char *name)
Maths::Vec3f normal () const
unsigned int vertexCount () const
Utils::Result getVertices (Maths::Vec3f *v) const
Utils::Result setPolygon (unsigned int count, const Maths::Vec3f *v, const Maths::Vec3f &normal)

Static Public Member Functions

Portal create (const char *name, const Database &db=Database())
Portal find (const char *name)
ClassType classType ()
Portal cast (const ObjectBase &)

Detailed Description

Zone-Zone connection geom.

The Portal object defines a polygon within a zone which is used by the PortalInstance object to connect up neighbouring zones.

Constructor & Destructor Documentation

Q::Portal::Portal (   )  [inline]
 

Create a null portal reference.

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

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

Member Function Documentation

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

If the object referenced by obj is a portal, then return a suitable Portal 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::Portal::classType (   )  [static]
 

Return the type for this class.

Portal Q::Portal::create (  const char *  name,
const Database &  db = Database()
)  [static]
 

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

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

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

Utils::Result Q::Portal::getVertices (  Maths::Vec3f *  v  )  const
 

Return the vertices for the portal polygon. The array v must contain at least Portal::vertexCount() elements.

Maths::Vec3f Q::Portal::normal (   )  const
 

Return the normal vector for the portal polygon.

Utils::Result Q::Portal::setPolygon (  unsigned int  count,
const Maths::Vec3f *  v,
const Maths::Vec3f &  normal
) 
 

Set the portal's polygon.

unsigned int Q::Portal::vertexCount (   )  const
 

Return the number of vertices in the portal polygon.

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