PathEngine home previous: Colour Stringsnext: Key Strings
Contents, API Reference, Values and Strings, Face Attributes

Face Attributes

These values are defined in SDKRoot/include/i_pathengine.h.

Refer to Setting Face Attributes for information about adding face attributes to a ground mesh.

Name
Description
PE_FaceAttribute_SurfaceType

An application specific value that may be used to define the type of surface at a given point on the ground.
So, for example, the application could define values to correspond with wood, stone, grass, dirt, and so on.
This value is passed through during content processing and can later be queried with iMesh::getSurfaceType().
Surface types default to 0 if this attribute is not specified.

This surface type attribute can be used to set up regions with traversal cost, as described in Representing Regions with Cost to Traverse.

PE_FaceAttribute_SectionID This attribute is used to split ground meshes into sections.
These section IDs can be used to setup callback functions for terrain areas.
Refer to Working with Terrain for more details about the terrain callback functionality.
-1 is used to indicate that the section ID is not defined for a face.
PE_FaceAttribute_UserData

This attribute can be used to store arbitrary application defined values relating to a piece of ground.

The value of this user data defaults to 0 if the attribute is not specified.

PE_FaceAttribute_MarksPortal This attribute is used to define 'portals' for the automatic building connection functionality.
(Refer to Building Entrance Connections for details.)
Faces that are being used as portal markers should have this attribute set to 1.
PE_FaceAttribute_MarksTerrainPortal This attribute is used to define 'terrain portals' for the automatic building connection functionality.
(Refer to Building Entrance Connections for details.)
Faces that are being used as terrain portal markers should have this attribute set to 1.
PE_FaceAttribute_MarksExternalShape This attribute is used to define 'building external shapes' for the automatic building connection functionality.
(Refer to Building Entrance Connections for details.)
Faces on building external shapes should have this attribute set to 1.
PE_FaceAttribute_MarksConnectingEdge This attribute is used to define connecting edges for the automatic edge connection functionality.
(Refer to Matching Edge Connections for details.)
Faces that are being used as connecting edge markers should have this attribute set to 1.
Documentation for PathEngine release 5.17 - Copyright © 2002-2008 PathEnginenext: Key Strings