Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

Phx::GraphicsEngine::MeshDescription Class Reference

A Description representing a raw 3D mesh. More...

#include <PhxGraphicsEngine.h>

Inheritance diagram for Phx::GraphicsEngine::MeshDescription:

Phx::Description Phx::LockedPtrInterface< Description > List of all members.

Public Member Functions

virtual void resourceName (const String &resourceName)=0
 Sets the resource name for the mesh.
const String & resourceName (void) const

Static Public Attributes

static const Description::Type DESCRIPTION_TYPE
static const String DESCRIPTION_TYPE_NAME

Protected Member Functions

void setResourceName (const String &name)

Detailed Description

A Description representing a raw 3D mesh.

Most or all of the mesh specification will be implementation specific, and hence the mesh is described primarily by a "resource name" attribute that will be interpreted by the underlying engine. The engine will use it to locate the appropriate native mesh resource.


Member Function Documentation

virtual void Phx::GraphicsEngine::MeshDescription::resourceName const String &  resourceName  )  [pure virtual]
 

Sets the resource name for the mesh.

The resource name should not have any file-type suffix. This allows different implementations to select the appropriate file type for the platform/engine in use. For instance, OGRE may add a .mesh suffix and attempt to load a .mesh resource from the media directory. If a different engine is being used, with a different native format (e.g., because OGRE does not work on that platform yet), then it may choose to supply a different suffix, or may search a different path. In any case, all that needs to be supplied here is the location and root name of the resource (e.g., "MyData/MyMesh" instead of "MyData/MyMesh.mesh").


The documentation for this class was generated from the following file:
Generated on Mon Jul 10 19:45:29 2006 for Phoenix OSFS by  doxygen 1.4.2