The stl Reference Manual

Table of Contents

The stl Reference Manual

This is the stl Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 13:01:37 2020 GMT+0.

1 Introduction

This is a small library for reading the triangle data in binary STL files.

Here is a small example showing how to read a file and compute the area of the triangles in it.

    CL-USER> (ql:quickload :stl)
    To load "stl":
      Load 1 ASDF system:
        stl
    ; Loading "stl"
    ...
    (:STL)
    CL-USER> (defparameter *cube* (stl:read-stl "~/3d_models/cube.stl"))
    *CUBE*
    CL-USER> (stl:stl-area *cube*)
    24.000002
    CL-USER>

2 Systems

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

2.1 stl

Author

Jeremiah LaRocco <jeremiah.larocco@gmail.com>

License

ISC

Description

Load triangle data from binary stereolithography (STL) files.

Dependency

3d-vectors

Source

stl.asd (file)

Components

• package.lisp (file)
• stl.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 stl.asd

Location

stl.asd

Systems

stl (system)

3.1.2 stl/package.lisp

Parent

stl (system)

Location

package.lisp

Packages

stl

3.1.3 stl/stl.lisp

Dependency

package.lisp (file)

Parent

stl (system)

Location

stl.lisp

Exported Definitions

• area (method)
• area (method)
• area (method)
• bounding-box (function)
• distance (function)
• read-stl (function)
• to-opengl (function)
• triangle (class)

Internal Definitions

• *float-byte-size* (special variable)
• *point-byte-size* (special variable)
• *triangle-byte-size* (special variable)
• compute-triangle-normal (function)
• get-float (function)
• get-point (function)
• get-s4 (function)
• get-triangle (function)
• get-u2 (function)
• get-u4 (function)
• zero-point (function)

4 Packages

Packages are listed by definition order.

4.1 stl

Source

package.lisp (file)

Use List

• 3d-vectors
• common-lisp

Exported Definitions

• area (generic function)
• area (method)
• area (method)
• area (method)
• bounding-box (function)
• distance (function)
• read-stl (function)
• to-opengl (function)
• triangle (class)

Internal Definitions

• *float-byte-size* (special variable)
• *point-byte-size* (special variable)
• *triangle-byte-size* (special variable)
• compute-triangle-normal (function)
• get-float (function)
• get-point (function)
• get-s4 (function)
• get-triangle (function)
• get-u2 (function)
• get-u4 (function)
• zero-point (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: bounding-box TRIANGLES

Package

stl

Source

stl.lisp (file)

Function: distance PT1 PT2

Compute the distance between two points.

Package

stl

Source

stl.lisp (file)

Function: read-stl FNAME

Read an STL file from fname and return the vector of triangles.

Package

stl

Source

stl.lisp (file)

Function: to-opengl TRIANGLES &key COLOR

Package

stl

Source

stl.lisp (file)

5.1.2 Generic functions

Generic Function: area OBJECT

Package

stl

Methods

Method: area (TRIANGLES simple-vector)

Compute the area of a vector of triangles.

Source

stl.lisp (file)

Method: area (TRI triangle)

Compute the area of a triangle.

Source

stl.lisp (file)

Method: area OBJECT

Source

stl.lisp (file)

5.1.3 Classes

Class: triangle ()

Package

stl

Source

stl.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

area (method)

Direct slots

Slot: normal

Type

3d-vectors:vec3

Initargs

:normal

Slot: pt1

Type

3d-vectors:vec3

Initargs

:pt1

Slot: pt2

Type

3d-vectors:vec3

Initargs

:pt2

Slot: pt3

Type

3d-vectors:vec3

Initargs

:pt3

Slot: attribute

Type

fixnum

Initargs

:attribute

Initform

0

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *float-byte-size*

Size of an STL float in bytes.

Package

stl

Source

stl.lisp (file)

Special Variable: *point-byte-size*

Size of an STL point in bytes.

Package

stl

Source

stl.lisp (file)

Special Variable: *triangle-byte-size*

Size of an STL triangle in bytes.

Package

stl

Source

stl.lisp (file)

5.2.2 Functions

Function: compute-triangle-normal TRI

Compute the normal of a triangle.

Package

stl

Source

stl.lisp (file)

Function: get-float ARR

Interpret four bytes in arr as a single-float.

Package

stl

Source

stl.lisp (file)

Function: get-point ARR

Create a point using x, y, and z values read from arr.

Package

stl

Source

stl.lisp (file)

Function: get-s4 ARR

Interpret four bytes in arr as an ’(signed-byte 32)

Package

stl

Source

stl.lisp (file)

Function: get-triangle ARR

Read a triangle from arr.

Package

stl

Source

stl.lisp (file)

Function: get-u2 ARR

Interpret two bytes in arr as an ’(unsigned-byte 32)

Package

stl

Source

stl.lisp (file)

Function: get-u4 ARR

Interpret the four bytes in arr as an ’(unsigned-byte 32)

Package

stl

Source

stl.lisp (file)

Function: zero-point PT

Package

stl

Source

stl.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types