The glu-tessellate Reference Manual

Table of Contents

The glu-tessellate Reference Manual

This is the glu-tessellate Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:11:00 2020 GMT+0.

1 Introduction

glu-tessellate

This is a triangulation library that wraps around GLU's tessellation routines to make turning vectors of point data into triangles stupid easy.

Yes, it supports concave polygons, and yes it supports holes. It also allows you to specify which winding rule you use to triangulate.

It also returns every triangle it produces in counter-clockwise order. You can change this to clockwise by passing :cw t.

Usage

The library has one public function (don't you love simplicity?) which takes a vector points (a point being an '(x y) list) into a list of triangles:

;; returns two triangles making up this square
(glu-tessellate:tessellate #( (0 0) (0 10) (10 10) (10 0) ))  ->
    (((10.0d0 10.0d0) (0.0d0 10.0d0) (0.0d0 0.0d0))
	 ((10.0d0 0.0d0) (10.0d0 10.0d0) (0.0d0 0.0d0)))

It also supports polygons with holes. Holes are specified as a list of point vectors:

;; a square with a hole returns quite a few more triangles
(glu-tessellate:tessellate #( (0 0) (0 10) (10 10) (10 0) ) :holes '( #((3 3) (3 7) (7 7) (7 3)) )) ->
    (((10.0d0 10.0d0) (0.0d0 10.0d0) (3.0d0 7.0d0))
     ((0.0d0 0.0d0) (3.0d0 7.0d0) (0.0d0 10.0d0))
     ((3.0d0 7.0d0) (0.0d0 0.0d0) (3.0d0 3.0d0))
     ((10.0d0 0.0d0) (3.0d0 3.0d0) (0.0d0 0.0d0))
     ((3.0d0 3.0d0) (10.0d0 0.0d0) (7.0d0 3.0d0))
     ((10.0d0 10.0d0) (7.0d0 3.0d0) (10.0d0 0.0d0))
     ((7.0d0 3.0d0) (10.0d0 10.0d0) (7.0d0 7.0d0))
     ((3.0d0 7.0d0) (7.0d0 7.0d0) (10.0d0 10.0d0)))

Arguments

The one function this library uses takes the following keyword arguments:

:holes           ; a list of point vectors describing the holes in the polygon
:winding-rule    ; a keyword describing the winding rule: (:odd :nonzero :positive :negative :abs-geq-two)
:cw              ; if T, produced triangles will be in CW order instead of CCW

Limitations

GLU tessellation normally allows you to store arbitrary data with each point and also merge this point data when new points are created. This library doesn't currently allow this, and is only used for triangulation of points. If you need to attach colors to your triangles, it must be done so outside of the library...unless, of course, you wish to add arbitrary data support and issue a pull request ;).

The only other limitation I can think of is that it relies on GLU being on the system. Show me a system without GLU and I'll show you a computer from an alternate universe where Microsoft finally did away with all competition and DirectX rules o'er the land with an iron fist.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 glu-tessellate

Author

Andrew Lyon <orthecreedence@gmail.com>

License

MIT

Description

A simple triangulation engine that wraps around GLU’s tessellation system.

Version

0.1.0

Dependency

cffi

Source

glu-tessellate.asd (file)

Components

• package.lisp (file)
• tessellate.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 glu-tessellate.asd

Location

glu-tessellate.asd

Systems

glu-tessellate (system)

3.1.2 glu-tessellate/package.lisp

Parent

glu-tessellate (system)

Location

package.lisp

Packages

glu-tessellate

3.1.3 glu-tessellate/tessellate.lisp

Dependency

package.lisp (file)

Parent

glu-tessellate (system)

Location

tessellate.lisp

Exported Definitions

tessellate (function)

Internal Definitions

• *created-points* (special variable)
• *cur-triangle* (special variable)
• *cur-triangle-wind* (special variable)
• *cur-type* (special variable)
• *polygons* (special variable)
• *triangles* (special variable)
• +begin+ (constant)
• +ccw+ (constant)
• +cw+ (constant)
• +edge-flag+ (constant)
• +end+ (constant)
• +exterior+ (constant)
• +interior+ (constant)
• +line-loop+ (constant)
• +line-strip+ (constant)
• +lines+ (constant)
• +points+ (constant)
• +polygon+ (constant)
• +quad-strip+ (constant)
• +quads+ (constant)
• +tess-begin+ (constant)
• +tess-begin-data+ (constant)
• +tess-boundary-only+ (constant)
• +tess-combine+ (constant)
• +tess-combine-data+ (constant)
• +tess-coord-too-large+ (constant)
• +tess-edge-flag+ (constant)
• +tess-edge-flag-data+ (constant)
• +tess-end+ (constant)
• +tess-end-data+ (constant)
• +tess-error+ (constant)
• +tess-error-1+ (constant)
• +tess-error-2+ (constant)
• +tess-error-3+ (constant)
• +tess-error-4+ (constant)
• +tess-error-5+ (constant)
• +tess-error-6+ (constant)
• +tess-error-7+ (constant)
• +tess-error-8+ (constant)
• +tess-error-data+ (constant)
• +tess-max-coord+ (constant)
• +tess-missing-begin-contour+ (constant)
• +tess-missing-begin-polygon+ (constant)
• +tess-missing-end-contour+ (constant)
• +tess-missing-end-polygon+ (constant)
• +tess-need-combine-callback+ (constant)
• +tess-tolerance+ (constant)
• +tess-vertex+ (constant)
• +tess-vertex-data+ (constant)
• +tess-winding-abs-geq-two+ (constant)
• +tess-winding-negative+ (constant)
• +tess-winding-nonzero+ (constant)
• +tess-winding-odd+ (constant)
• +tess-winding-positive+ (constant)
• +tess-winding-rule+ (constant)
• +triangle-fan+ (constant)
• +triangle-strip+ (constant)
• +triangles+ (constant)
• +unknown+ (constant)
• +vertex+ (constant)
• begin-polygon (function)
• def-c-callback (macro)
• delete-tess (function)
• do-tess-begin (function)
• do-tess-combine (function)
• do-tess-end (function)
• do-tess-error (function)
• do-tess-vertex (function)
• end-polygon (function)
• error-string (function)
• get-tess-property (function)
• get-winding-rule (function)
• new-tess (function)
• next-contour (function)
• polygon-clockwise-p (function)
• tess-begin-contour (function)
• tess-begin-polygon (function)
• tess-callback (function)
• tess-end-contour (function)
• tess-end-polygon (function)
• tess-normal (function)
• tess-property (function)
• tess-vertex (function)

4 Packages

Packages are listed by definition order.

4.1 glu-tessellate

Source

package.lisp (file)

Nickname

tess

Use List

• cffi
• common-lisp

Exported Definitions

tessellate (function)

Internal Definitions

• *created-points* (special variable)
• *cur-triangle* (special variable)
• *cur-triangle-wind* (special variable)
• *cur-type* (special variable)
• *polygons* (special variable)
• *triangles* (special variable)
• +begin+ (constant)
• +ccw+ (constant)
• +cw+ (constant)
• +edge-flag+ (constant)
• +end+ (constant)
• +exterior+ (constant)
• +interior+ (constant)
• +line-loop+ (constant)
• +line-strip+ (constant)
• +lines+ (constant)
• +points+ (constant)
• +polygon+ (constant)
• +quad-strip+ (constant)
• +quads+ (constant)
• +tess-begin+ (constant)
• +tess-begin-data+ (constant)
• +tess-boundary-only+ (constant)
• +tess-combine+ (constant)
• +tess-combine-data+ (constant)
• +tess-coord-too-large+ (constant)
• +tess-edge-flag+ (constant)
• +tess-edge-flag-data+ (constant)
• +tess-end+ (constant)
• +tess-end-data+ (constant)
• +tess-error+ (constant)
• +tess-error-1+ (constant)
• +tess-error-2+ (constant)
• +tess-error-3+ (constant)
• +tess-error-4+ (constant)
• +tess-error-5+ (constant)
• +tess-error-6+ (constant)
• +tess-error-7+ (constant)
• +tess-error-8+ (constant)
• +tess-error-data+ (constant)
• +tess-max-coord+ (constant)
• +tess-missing-begin-contour+ (constant)
• +tess-missing-begin-polygon+ (constant)
• +tess-missing-end-contour+ (constant)
• +tess-missing-end-polygon+ (constant)
• +tess-need-combine-callback+ (constant)
• +tess-tolerance+ (constant)
• +tess-vertex+ (constant)
• +tess-vertex-data+ (constant)
• +tess-winding-abs-geq-two+ (constant)
• +tess-winding-negative+ (constant)
• +tess-winding-nonzero+ (constant)
• +tess-winding-odd+ (constant)
• +tess-winding-positive+ (constant)
• +tess-winding-rule+ (constant)
• +triangle-fan+ (constant)
• +triangle-strip+ (constant)
• +triangles+ (constant)
• +unknown+ (constant)
• +vertex+ (constant)
• begin-polygon (function)
• def-c-callback (macro)
• delete-tess (function)
• do-tess-begin (function)
• do-tess-combine (function)
• do-tess-end (function)
• do-tess-error (function)
• do-tess-vertex (function)
• end-polygon (function)
• error-string (function)
• get-tess-property (function)
• get-winding-rule (function)
• new-tess (function)
• next-contour (function)
• polygon-clockwise-p (function)
• tess-begin-contour (function)
• tess-begin-polygon (function)
• tess-callback (function)
• tess-end-contour (function)
• tess-end-polygon (function)
• tess-normal (function)
• tess-property (function)
• tess-vertex (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: tessellate POINTS &key HOLES WINDING-RULE CW

Tessellate a polygon into triangles.

Package

glu-tessellate

Source

tessellate.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +begin+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +ccw+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +cw+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +edge-flag+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +end+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +exterior+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +interior+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +line-loop+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +line-strip+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +lines+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +points+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +polygon+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +quad-strip+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +quads+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-begin+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-begin-data+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-boundary-only+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-combine+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-combine-data+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-coord-too-large+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-edge-flag+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-edge-flag-data+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-end+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-end-data+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-1+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-2+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-3+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-4+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-5+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-6+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-7+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-8+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-error-data+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-max-coord+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-missing-begin-contour+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-missing-begin-polygon+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-missing-end-contour+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-missing-end-polygon+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-need-combine-callback+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-tolerance+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-vertex+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-vertex-data+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-winding-abs-geq-two+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-winding-negative+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-winding-nonzero+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-winding-odd+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-winding-positive+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +tess-winding-rule+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +triangle-fan+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +triangle-strip+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +triangles+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +unknown+

Package

glu-tessellate

Source

tessellate.lisp (file)

Constant: +vertex+

Package

glu-tessellate

Source

tessellate.lisp (file)

5.2.2 Special variables

Special Variable: *created-points*

Package

glu-tessellate

Source

tessellate.lisp (file)

Special Variable: *cur-triangle*

Package

glu-tessellate

Source

tessellate.lisp (file)

Special Variable: *cur-triangle-wind*

Package

glu-tessellate

Source

tessellate.lisp (file)

Special Variable: *cur-type*

Package

glu-tessellate

Source

tessellate.lisp (file)

Special Variable: *polygons*

Package

glu-tessellate

Source

tessellate.lisp (file)

Special Variable: *triangles*

Package

glu-tessellate

Source

tessellate.lisp (file)

5.2.3 Macros

Macro: def-c-callback NAME &rest ARGS

Package

glu-tessellate

Source

tessellate.lisp (file)

5.2.4 Functions

Function: begin-polygon TESS

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: delete-tess TESS

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: do-tess-begin TYPE

Called when a tessellation shape begins. Stores the shape type for later reference.

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: do-tess-combine COORDS VERTEX-DATA WEIGHTS DATA-OUT

Called when tessellation must create a new point. Ideally this is where user data would be merged into a new point, but since we don’t support user data, there’s nothing to do but create the point and return =].

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: do-tess-end ()

Called with tessellation finishes with a shape. Saves all relevant data and sets up for another shape to come its way.

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: do-tess-error ERR

Error!!!!

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: do-tess-vertex VERTEX

Called when tessellation sends us a vertex. Uses the current shape type to figure out how the vertex will be processed/stored.

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: end-polygon TESS

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: error-string CODE

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: get-tess-property TESS WHICH DATA

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: get-winding-rule WIND-KEYWORD

Get the global winding rule for the keyword passed in.

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: new-tess ()

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: next-contour TESS TYPE

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: polygon-clockwise-p POLYGON-POINTS

Determine if the points of a polygon are in clockwise order.

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-begin-contour TESS

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-begin-polygon TESS DATA

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-callback TESS WHICH CALLBACKFUNC

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-end-contour TESS

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-end-polygon TESS

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-normal TESS VALUEX VALUEY VALUEZ

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-property TESS WHICH VALUE

Package

glu-tessellate

Source

tessellate.lisp (file)

Function: tess-vertex TESS LOCATION DATA

Package

glu-tessellate

Source

tessellate.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types