The marching-cubes Reference Manual

Table of Contents

The marching-cubes Reference Manual

This is the marching-cubes Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:21:28 2020 GMT+0.

1 Introduction

Marching-Cubes

A marching cubes algorithm implementation in Common Lisp based on Paul Bourke's (http://paulbourke.net/geometry/polygonise/)

API

[Function] marching-cubes

MARCHING-CUBES density-function min-position max-position delta isolevel => triangles

Extracts a surface from density field represented with density-function and returns triangles which is a list of triangles. density-function is a function that takes three arguments representing the position of a point and returns density as a scalar at the point. min-position and max-position are vec3 values and specify the minimun point and the maximun point of a grid to be processed. delta is a scalar that specifies the size of a cell in a grid to be processed. isolevel is a scalar that specifies the threshold of mesh construction.

[Function] marching-cubes-smooth

MARCHING-CUBES-SMOOTH density-function normal-function min-position max-position delta isolevel => smooth-triangles

Same as marching-cubes except that marching-cubes-smooth returns a list of smooth triangles which have normal vectors at each vertex. normal-function is a function that takes three arguments representing the position of a point and returns a normal vector at the point. Other arguments are same as marching-cubes's.

Example

See example/ directory.

Author

• Masayuki Takagi (kamonama@gmail.com)

Copyright

Copyright (c) 2012 Masayuki Takagi (kamonama@gmail.com)

License

Licensed under the LLGPL License.

2 Systems

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

2.1 marching-cubes

Author

Masayuki Takagi

License

LLGPL

Description

A marching cubes algorithm implementation in Common Lisp based on Paul Bourke’s (http://paulbourke.net/geometry/polygonise/)

Long Description

# Marching-Cubes

A marching cubes algorithm implementation in Common Lisp based on Paul Bourke’s (http://paulbourke.net/geometry/polygonise/)

## API

### [Function] marching-cubes

MARCHING-CUBES density-function min-position max-position delta isolevel => triangles

Extracts a surface from density field represented with ‘density-function‘ and returns ‘triangles‘ which is a list of triangles. ‘density-function‘ is a function that takes three arguments representing the position of a point and returns density as a scalar at the point. ‘min-position‘ and ‘max-position‘ are ‘vec3‘ values and specify the minimun point and the maximun point of a grid to be processed. ‘delta‘ is a scalar that specifies the size of a cell in a grid to be processed. ‘isolevel‘ is a scalar that specifies the threshold of mesh construction.

### [Function] marching-cubes-smooth

MARCHING-CUBES-SMOOTH density-function normal-function min-position max-position delta isolevel => smooth-triangles

Same as ‘marching-cubes‘ except that ‘marching-cubes-smooth‘ returns a list of smooth triangles which have normal vectors at each vertex. ‘normal-function‘ is a function that takes three arguments representing the position of a point and returns a normal vector at the point. Other arguments are same as ‘marching-cubes‘’s.

## Example

See example/ directory.

## Author

* Masayuki Takagi (kamonama@gmail.com)

## Copyright

Copyright (c) 2012 Masayuki Takagi (kamonama@gmail.com)

## License

Licensed under the LLGPL License.

Version

1.0

Source

marching-cubes.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 marching-cubes/src

Parent

marching-cubes (system)

Location

src/

Components

• package.lisp (file)
• tables.lisp (file)
• marching-cubes.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 marching-cubes.asd

Location

marching-cubes.asd

Systems

marching-cubes (system)

Packages

marching-cubes-asd

4.1.2 marching-cubes/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

marching-cubes

4.1.3 marching-cubes/src/tables.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/tables.lisp

Internal Definitions

• +edge-table+ (special variable)
• +tri-table+ (special variable)

4.1.4 marching-cubes/src/marching-cubes.lisp

Dependency

tables.lisp (file)

Parent

src (module)

Location

src/marching-cubes.lisp

Exported Definitions

• make-smooth-triangle (function)
• make-triangle (function)
• make-vec3 (function)
• marching-cubes (function)
• marching-cubes-smooth (function)
• normalize-vec3 (function)
• smooth-triangle-normal (macro)
• smooth-triangle-vertex (macro)
• smooth-triangle= (function)
• triangle-vertex (macro)
• triangle= (function)
• vec3-x (function)
• vec3-y (function)
• vec3-z (function)
• vec3= (function)

Internal Definitions

• *vertex-offsets* (special variable)
• copy-grid (function)
• copy-grid-cell (function)
• copy-smooth-triangle (function)
• copy-triangle (function)
• copy-vec3 (function)
• degenerate-triangle (function)
• grid (structure)
• grid-cell (function)
• grid-cell (structure)
• grid-cell-p (function)
• grid-cell-value (macro)
• grid-cell-values (function)
• grid-cell-values% (function)
• (setf grid-cell-values%) (function)
• grid-cell-vertex (macro)
• grid-cell-vertices (function)
• grid-cell-vertices% (function)
• (setf grid-cell-vertices%) (function)
• grid-delta (function)
• (setf grid-delta) (function)
• grid-max (function)
• (setf grid-max) (function)
• grid-min (function)
• (setf grid-min) (function)
• grid-p (function)
• grid-point (function)
• grid-size-x (function)
• (setf grid-size-x) (function)
• grid-size-y (function)
• (setf grid-size-y) (function)
• grid-size-z (function)
• (setf grid-size-z) (function)
• grid-value (function)
• grid-values% (function)
• (setf grid-values%) (function)
• inc-logior (macro)
• make-grid (function)
• make-grid-cell (function)
• make-grid-values (function)
• make-raw-grid (function)
• polygonise (function)
• reduce-grid (function)
• remove-degenerate-triangles (function)
• smooth-triangle (structure)
• smooth-triangle-normal-0 (function)
• smooth-triangle-normal-1 (function)
• smooth-triangle-normal-2 (function)
• smooth-triangle-p (function)
• smooth-triangle-vertex-0 (function)
• smooth-triangle-vertex-1 (function)
• smooth-triangle-vertex-2 (function)
• to-smooth-triangle (function)
• triangle (structure)
• triangle-p (function)
• triangle-vertex-0 (function)
• triangle-vertex-1 (function)
• triangle-vertex-2 (function)
• vec3 (structure)
• vec3-p (function)
• vertex-interop (function)

5 Packages

Packages are listed by definition order.

5.1 marching-cubes-asd

Source

marching-cubes.asd

Use List

• asdf/interface
• common-lisp

5.2 marching-cubes

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• make-smooth-triangle (function)
• make-triangle (function)
• make-vec3 (function)
• marching-cubes (function)
• marching-cubes-smooth (function)
• normalize-vec3 (function)
• smooth-triangle-normal (macro)
• smooth-triangle-vertex (macro)
• smooth-triangle= (function)
• triangle-vertex (macro)
• triangle= (function)
• vec3-x (function)
• vec3-y (function)
• vec3-z (function)
• vec3= (function)

Internal Definitions

• *vertex-offsets* (special variable)
• +edge-table+ (special variable)
• +tri-table+ (special variable)
• copy-grid (function)
• copy-grid-cell (function)
• copy-smooth-triangle (function)
• copy-triangle (function)
• copy-vec3 (function)
• degenerate-triangle (function)
• grid (structure)
• grid-cell (function)
• grid-cell (structure)
• grid-cell-p (function)
• grid-cell-value (macro)
• grid-cell-values (function)
• grid-cell-values% (function)
• (setf grid-cell-values%) (function)
• grid-cell-vertex (macro)
• grid-cell-vertices (function)
• grid-cell-vertices% (function)
• (setf grid-cell-vertices%) (function)
• grid-delta (function)
• (setf grid-delta) (function)
• grid-max (function)
• (setf grid-max) (function)
• grid-min (function)
• (setf grid-min) (function)
• grid-p (function)
• grid-point (function)
• grid-size-x (function)
• (setf grid-size-x) (function)
• grid-size-y (function)
• (setf grid-size-y) (function)
• grid-size-z (function)
• (setf grid-size-z) (function)
• grid-value (function)
• grid-values% (function)
• (setf grid-values%) (function)
• inc-logior (macro)
• make-grid (function)
• make-grid-cell (function)
• make-grid-values (function)
• make-raw-grid (function)
• polygonise (function)
• reduce-grid (function)
• remove-degenerate-triangles (function)
• smooth-triangle (structure)
• smooth-triangle-normal-0 (function)
• smooth-triangle-normal-1 (function)
• smooth-triangle-normal-2 (function)
• smooth-triangle-p (function)
• smooth-triangle-vertex-0 (function)
• smooth-triangle-vertex-1 (function)
• smooth-triangle-vertex-2 (function)
• to-smooth-triangle (function)
• triangle (structure)
• triangle-p (function)
• triangle-vertex-0 (function)
• triangle-vertex-1 (function)
• triangle-vertex-2 (function)
• vec3 (structure)
• vec3-p (function)
• vertex-interop (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: smooth-triangle-normal TRI I

Package

marching-cubes

Source

marching-cubes.lisp (file)

Macro: smooth-triangle-vertex TRI I

Package

marching-cubes

Source

marching-cubes.lisp (file)

Macro: triangle-vertex TRI I

Package

marching-cubes

Source

marching-cubes.lisp (file)

6.1.2 Functions

Function: make-smooth-triangle VERTEX-0 NORMAL-0 VERTEX-1 NORMAL-1 VERTEX-2 NORMAL-2

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: make-triangle VERTEX-0 VERTEX-1 VERTEX-2

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: make-vec3 X Y Z

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: marching-cubes FN MIN MAX DELTA ISOLEVEL

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: marching-cubes-smooth FN-VALUE FN-NORMAL MIN MAX DELTA ISOLEVEL

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: normalize-vec3 V

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle= A B

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: triangle= A B

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: vec3-x INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: vec3-y INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: vec3-z INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: vec3= A B

Package

marching-cubes

Source

marching-cubes.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *vertex-offsets*

Package

marching-cubes

Source

marching-cubes.lisp (file)

Special Variable: +edge-table+

Package

marching-cubes

Source

tables.lisp (file)

Special Variable: +tri-table+

Package

marching-cubes

Source

tables.lisp (file)

6.2.2 Macros

Macro: grid-cell-value GRID I

Package

marching-cubes

Source

marching-cubes.lisp (file)

Macro: grid-cell-vertex GRID I

Package

marching-cubes

Source

marching-cubes.lisp (file)

Macro: inc-logior X VAL

Package

marching-cubes

Source

marching-cubes.lisp (file)

6.2.3 Functions

Function: copy-grid INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: copy-grid-cell INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: copy-smooth-triangle INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: copy-triangle INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: copy-vec3 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: degenerate-triangle TRI

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-cell GRID I J K

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-cell-p OBJECT

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-cell-values GRID I J K

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-cell-values% INSTANCE

Function: (setf grid-cell-values%) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-cell-vertices GRID I J K

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-cell-vertices% INSTANCE

Function: (setf grid-cell-vertices%) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-delta INSTANCE

Function: (setf grid-delta) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-max INSTANCE

Function: (setf grid-max) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-min INSTANCE

Function: (setf grid-min) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-p OBJECT

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-point GRID I J K

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-size-x INSTANCE

Function: (setf grid-size-x) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-size-y INSTANCE

Function: (setf grid-size-y) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-size-z INSTANCE

Function: (setf grid-size-z) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-value GRID I J K

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: grid-values% INSTANCE

Function: (setf grid-values%) VALUE INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: make-grid FN MIN MAX DELTA

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: make-grid-cell VERTICES% VALUES%

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: make-grid-values FN I J K ORIGIN DELTA

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: make-raw-grid MIN MAX SIZE-X SIZE-Y SIZE-Z DELTA VALUES%

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: polygonise GRID ISOLEVEL

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: reduce-grid GRID FN

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: remove-degenerate-triangles TRIS

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-normal-0 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-normal-1 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-normal-2 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-p OBJECT

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-vertex-0 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-vertex-1 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: smooth-triangle-vertex-2 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: to-smooth-triangle TRI FN

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: triangle-p OBJECT

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: triangle-vertex-0 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: triangle-vertex-1 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: triangle-vertex-2 INSTANCE

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: vec3-p OBJECT

Package

marching-cubes

Source

marching-cubes.lisp (file)

Function: vertex-interop ISOLEVEL P1 P2 VAL1 VAL2

Package

marching-cubes

Source

marching-cubes.lisp (file)

6.2.4 Structures

Structure: grid ()

Package

marching-cubes

Source

marching-cubes.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: min

Readers

grid-min (function)

Writers

(setf grid-min) (function)

Slot: max

Readers

grid-max (function)

Writers

(setf grid-max) (function)

Slot: size-x

Readers

grid-size-x (function)

Writers

(setf grid-size-x) (function)

Slot: size-y

Readers

grid-size-y (function)

Writers

(setf grid-size-y) (function)

Slot: size-z

Readers

grid-size-z (function)

Writers

(setf grid-size-z) (function)

Slot: delta

Readers

grid-delta (function)

Writers

(setf grid-delta) (function)

Slot: values%

Readers

grid-values% (function)

Writers

(setf grid-values%) (function)

Structure: grid-cell ()

Package

marching-cubes

Source

marching-cubes.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: vertices%

Readers

grid-cell-vertices% (function)

Writers

(setf grid-cell-vertices%) (function)

Slot: values%

Readers

grid-cell-values% (function)

Writers

(setf grid-cell-values%) (function)

Structure: smooth-triangle ()

Package

marching-cubes

Source

marching-cubes.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: vertex-0

Readers

smooth-triangle-vertex-0 (function)

Writers

(setf smooth-triangle-vertex-0) (function)

Slot: normal-0

Readers

smooth-triangle-normal-0 (function)

Writers

(setf smooth-triangle-normal-0) (function)

Slot: vertex-1

Readers

smooth-triangle-vertex-1 (function)

Writers

(setf smooth-triangle-vertex-1) (function)

Slot: normal-1

Readers

smooth-triangle-normal-1 (function)

Writers

(setf smooth-triangle-normal-1) (function)

Slot: vertex-2

Readers

smooth-triangle-vertex-2 (function)

Writers

(setf smooth-triangle-vertex-2) (function)

Slot: normal-2

Readers

smooth-triangle-normal-2 (function)

Writers

(setf smooth-triangle-normal-2) (function)

Structure: triangle ()

Package

marching-cubes

Source

marching-cubes.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: vertex-0

Readers

triangle-vertex-0 (function)

Writers

(setf triangle-vertex-0) (function)

Slot: vertex-1

Readers

triangle-vertex-1 (function)

Writers

(setf triangle-vertex-1) (function)

Slot: vertex-2

Readers

triangle-vertex-2 (function)

Writers

(setf triangle-vertex-2) (function)

Structure: vec3 ()

Package

marching-cubes

Source

marching-cubes.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: x

Initform

0

Readers

vec3-x (function)

Writers

(setf vec3-x) (function)

Slot: y

Initform

0

Readers

vec3-y (function)

Writers

(setf vec3-y) (function)

Slot: z

Initform

0

Readers

vec3-z (function)

Writers

(setf vec3-z) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types