lilith3d::LilithObject Class Reference

#include <genericobject.h>

List of all members.


Detailed Description

A generic object for describing a specific location in the Lilith engine. Used for pathing, intersection, things like that. Remember that the Lilith3D world is very dynamic - it is never safe to cache LilithObjects, because what they point to can be changed by many function calls and also changes over time.


Public Member Functions

 LilithObject ()
 Construct an object that points to nothing.
 LilithObject (TerrainMesh *tmesh, const grinliz::Vector3F &intersect, float distance)
 Construct an object that references a location on the terrain.
 LilithObject (Mesh *mesh, const grinliz::Vector3F &intersect, float distance)
 Construct an object that references a location on a Mesh.
 LilithObject (PathSurfaceInstance *psi, const grinliz::Vector3F &intersect, float distance)
 Construct an object that references a pathable building surfaces (PSI).
grinliz::Vector3F Intersection () const
 "Intersection" is the point on the object that this LilithObject refers to.
float X () const
 Convenience access to the Intersection point.
float Y () const
 Convenience access to the Intersection point.
float Z () const
 Convenience access to the Intersection point.
const std::string & Description () const
 Text description of the object.
TerrainMeshToTerrain () const
 Returns a pointer to the Terrain, if this is a terrain object.
MeshToMesh () const
PathSurfaceInstance * ToPSI () const
float Distance () const
 If the LilithObject was constructed as a distance from some other point, this will be >0.


Member Function Documentation

Mesh* lilith3d::LilithObject::ToMesh (  )  const [inline]

Returns a pointer to a Mesh, if this is a mesh object. Note that a non-const pointer is returned since Mesh is a user managed object.

PathSurfaceInstance* lilith3d::LilithObject::ToPSI (  )  const [inline]

Returns a pointer to a path surface if this references a path surface.


The documentation for this class was generated from the following file:
Generated on Fri Mar 23 19:36:26 2007 for Lilith3D by  doxygen 1.5.1-p1