This is the documentation for Enlighten.

module Deprecated: UV Parametisation and Grouping

This module is deprecated and will be removed.

About the libraries


The GeoAtlas library contains:

  1. A UV Parametiser for reshaping UVs to minimised surface area distortion.

  2. Two triangle grouping systems, an edge-based method for discovering charts to parametise, and a vertex-based method used by the Enlighten precompute.

For more information on the parametiser and edge-based charting, see the GeoFlattenAndPack() function and the AtlasMesh class.

For more information on the chart identification used by the precompute, see the classes TriGroupSelection and IdentVertLinkBuilder, both in the TriGroup.h file.

Classes

Name Description
Geo::AtlasMesh

The AtlasMesh implementation used for the packer and anything else that needs not to know whether we have one mesh or several.

Geo::AtlasMeshChart

A chart consists of a connected region of the mesh, which has a mapping into a single connected region in UV space.

Geo::AtlasMeshChartingFlags

Describe how you would like charting to be performed.

Geo::AtlasMeshPackingFlags

This tells the packer how to parameterise your stuff.

Geo::AtlasMeshTriangle

An AtlasMesh consists of a number of triangle faces, each composed of three vertices.

Geo::AtlasMeshTriangleCorner

A specific corner of a triangle in the mesh can be identified though an AtlasMeshTriangleCorner.

Geo::AtlasMeshVertex

An AtlasMesh has a simple vertex format, carrying a single 3D coordinate describing the model, and a single 2D "UV" coordinate though which to provide a unique unwrapping of the mesh into a UV atlas that can be used as high quality light map.

Geo::AtlasMeshVertexSplitResult

A specification describing that a specified vertex needs to duplicated, and that some of the m_Corner of the mesh faces need to be relinked to the copy.

Geo::ChartParametiserFailure

Details about a chart that failed to parametise well.

Geo::GeoFlattenAndPackResults

This class contains all the information about the results of a GeoFlattenAndPack call.

Enums

Name Description
eChartParametiserResult

An enum for the types of parametisation results we can get.

Typedefs

Name Description
GeoArray< AtlasMeshTriangle > AtlasMeshTriangles

Arrays of triangles.

GeoArray< AtlasMeshVertex > AtlasMeshVertices

Arrays of vertices.

Functions

Name Description
HasValidFloatData(const AtlasMeshVertices *)

Array version of the per-vertex function of the same name.


eChartParametiserResult


public: enum eChartParametiserResult
{
    PARAM_RESULT_OK = 0,
    PARAM_RESULT_OK_BUT_POOR_QUALITY,
    PARAM_RESULT_FAILED
}


An enum for the types of parametisation results we can get.

enumerators
PARAM_RESULT_OK

We produced results.

PARAM_RESULT_OK_BUT_POOR_QUALITY

Produced results, but the parametiser had trouble so they may not be ideal.

PARAM_RESULT_FAILED

Failed to produce any results.


bool GEO_CALL Geo::HasValidFloatData


public: bool GEO_CALL HasValidFloatData
(
    const AtlasMeshVertices * vs
)


Array version of the per-vertex function of the same name.