Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The stl Reference Manual

This is the stl Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 14:58:23 2023 GMT+0.

Table of Contents

Next: Systems, Previous: The stl Reference Manual, Up: The stl Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The stl Reference Manual [Contents][Index]

2 Systems

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

stl

Previous: Systems, Up: Systems [Contents][Index]

2.1 `stl`

Load triangle data from binary stereolithography (STL) files.

Author

Jeremiah LaRocco <jeremiah.larocco@gmail.com>

License

ISC

Dependency

3d-vectors (system).

Source

Child Components

package.lisp (file).
stl.lisp (file).

Next: Packages, Previous: Systems, Up: The stl Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

stl/stl.asd
stl/package.lisp
stl/stl.lisp

Next: stl/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `stl/stl.asd`

Source: stl.asd.
Parent Component: stl (system).
ASDF Systems: stl.

Next: stl/stl.lisp, Previous: stl/stl.asd, Up: Lisp [Contents][Index]

3.1.2 `stl/package.lisp`

Source: stl.asd.
Parent Component: stl (system).
Packages: stl.

Previous: stl/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `stl/stl.lisp`

Dependency

package.lisp (file).

Source

Parent Component

stl (system).

Public Interface

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

Internals

*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).

Next: Definitions, Previous: Files, Up: The stl Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

stl

Previous: Packages, Up: Packages [Contents][Index]

4.1 `stl`

Source

package.lisp.

Use List

3d-vectors.
common-lisp.

Public Interface

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

Internals

*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).

Next: Indexes, Previous: Packages, Up: The stl Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions
Generic functions
Classes

Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: bounding-box (triangles) ¶

Package: stl.
Source: stl.lisp.

Function: distance (pt1 pt2) ¶

Compute the distance between two points.

Package: stl.
Source: stl.lisp.

Function: read-stl (fname) ¶

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

Package: stl.
Source: stl.lisp.

Function: to-opengl (triangles &key color) ¶

Package: stl.
Source: stl.lisp.

Next: Classes, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Generic functions

Generic Function: area (object) ¶

Package

Methods

Method: area ((triangles simple-vector)) ¶

Compute the area of a vector of triangles.

Source: stl.lisp.

Method: area ((tri triangle)) ¶

Compute the area of a triangle.

Source: stl.lisp.

Method: area (object) ¶

Source: stl.lisp.

Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.3 Classes

Class: triangle ¶

Package

Source

Direct methods

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
Initform: 0
Initargs: :attribute

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *float-byte-size* ¶

Size of an STL float in bytes.

Package: stl.
Source: stl.lisp.

Special Variable: *point-byte-size* ¶

Size of an STL point in bytes.

Package: stl.
Source: stl.lisp.

Special Variable: *triangle-byte-size* ¶

Size of an STL triangle in bytes.

Package: stl.
Source: stl.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: compute-triangle-normal (tri) ¶

Compute the normal of a triangle.

Package: stl.
Source: stl.lisp.

Function: get-float (arr) ¶

Interpret four bytes in arr as a single-float.

Package: stl.
Source: stl.lisp.

Function: get-point (arr) ¶

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

Package: stl.
Source: stl.lisp.

Function: get-s4 (arr) ¶

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

Package: stl.
Source: stl.lisp.

Function: get-triangle (arr) ¶

Read a triangle from arr.

Package: stl.
Source: stl.lisp.

Function: get-u2 (arr) ¶

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

Package: stl.
Source: stl.lisp.

Function: get-u4 (arr) ¶

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

Package: stl.
Source: stl.lisp.

Function: zero-point (pt) ¶

Package: stl.
Source: stl.lisp.

Previous: Definitions, Up: The stl Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	A B C D F G M R T Z

	Index Entry		Section

A
	`area`:		Public generic functions
	`area`:		Public generic functions
	`area`:		Public generic functions
	`area`:		Public generic functions

B
	`bounding-box`:		Public ordinary functions

C
	`compute-triangle-normal`:		Private ordinary functions

D
	`distance`:		Public ordinary functions

F
	`Function, bounding-box`:		Public ordinary functions
	`Function, compute-triangle-normal`:		Private ordinary functions
	`Function, distance`:		Public ordinary functions
	`Function, get-float`:		Private ordinary functions
	`Function, get-point`:		Private ordinary functions
	`Function, get-s4`:		Private ordinary functions
	`Function, get-triangle`:		Private ordinary functions
	`Function, get-u2`:		Private ordinary functions
	`Function, get-u4`:		Private ordinary functions
	`Function, read-stl`:		Public ordinary functions
	`Function, to-opengl`:		Public ordinary functions
	`Function, zero-point`:		Private ordinary functions

G
	`Generic Function, area`:		Public generic functions
	`get-float`:		Private ordinary functions
	`get-point`:		Private ordinary functions
	`get-s4`:		Private ordinary functions
	`get-triangle`:		Private ordinary functions
	`get-u2`:		Private ordinary functions
	`get-u4`:		Private ordinary functions

M
	`Method, area`:		Public generic functions
	`Method, area`:		Public generic functions
	`Method, area`:		Public generic functions

R
	`read-stl`:		Public ordinary functions

T
	`to-opengl`:		Public ordinary functions

Z
	`zero-point`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* A N P S

	Index Entry		Section

*
	`float-byte-size`:		Private special variables
	`point-byte-size`:		Private special variables
	`triangle-byte-size`:		Private special variables

A
	`attribute`:		Public classes

N
	`normal`:		Public classes

P
	`pt1`:		Public classes
	`pt2`:		Public classes
	`pt3`:		Public classes

S
	`Slot, attribute`:		Public classes
	`Slot, normal`:		Public classes
	`Slot, pt1`:		Public classes
	`Slot, pt2`:		Public classes
	`Slot, pt3`:		Public classes
	`Special Variable, float-byte-size`:		Private special variables
	`Special Variable, point-byte-size`:		Private special variables
	`Special Variable, triangle-byte-size`:		Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F P S T

	Index Entry		Section

C
	`Class, triangle`:		Public classes

F
	`File, package.lisp`:		The stl/package․lisp file
	`File, stl.asd`:		The stl/stl․asd file
	`File, stl.lisp`:		The stl/stl․lisp file

P
	`Package, stl`:		The stl package
	`package.lisp`:		The stl/package․lisp file

S
	`stl`:		The stl system
	`stl`:		The stl package
	`stl.asd`:		The stl/stl․asd file
	`stl.lisp`:		The stl/stl․lisp file
	`System, stl`:		The stl system

T
	`triangle`:		Public classes