Table of Contents

System Information

Definition Index

• ORG.SHIRAKUMO.FRAF.MANIFOLDS

  No documentation provided.

  • EXTERNAL STRUCTURE

    EDGE

    Source

    No documentation provided.
  • EXTERNAL STRUCTURE

    EXTENDED-EDGE

    Source

    No documentation provided.
  • EXTERNAL TYPE-DEFINITION

    F32

    Source

    Type alias for SINGLE-FLOAT.
    
    See F32

  • EXTERNAL TYPE-DEFINITION

    F64

    Source

    Type alias for DOUBLE-FLOAT.
    
    See F64

  • EXTERNAL TYPE-DEFINITION

    FACE

    Source

    Type for a face index.
    
    See FACE-ARRAY (type)

  • EXTERNAL TYPE-DEFINITION

    FACE-ARRAY

    Type for a face vertex indices array.
    
    Faces are always triangular, meaning a pair of three vertex indices
    represents a face. The order of the vertices must always be
    counter-clockwise whenever the normal of the face matters.
    
    Each vertex index in the face array describes the index of the vertex,
    NOT the starting index in the corresponding vertex-array. Meaning in
    order to reach the first element of the described vertex, the index
    must first be multiplied by 3.
    
    This is an alias for:
      (SIMPLE-ARRAY (UNSIGNED-BYTE 32) (*))

  • EXTERNAL TYPE-DEFINITION

    U16

    Source

    No documentation provided.
  • EXTERNAL TYPE-DEFINITION

    U32

    Source

    Type alias for (UNSIGNED-BYTE 32)
    
    See U32

  • EXTERNAL TYPE-DEFINITION

    VERTEX

    Source

    Type for a vertex index.
    
    See VERTEX-ARRAY (type)

  • EXTERNAL TYPE-DEFINITION

    VERTEX-ARRAY

    Type for a vertex array.
    
    Vertices are always a triplet of X Y Z coordinates. The vertices by
    themselves represent a point cloud. A FACE-ARRAY is required to build
    a surface using the vertices.
    
    If an element-type argument is given is an alias for:
      (SIMPLE-ARRAY element-type (*))
    
    Otherwise is an alias for:
      (OR (SIMPLE-ARRAY SINGLE-FLOAT (*))
          (SIMPLE-ARRAY DOUBLE-FLOAT (*)))

  • EXTERNAL FUNCTION

    2-MANIFOLD-P

    • FACES
    • &OPTIONAL
    • ADJACENCY

    Source

    Returns true if the face array describes a 2-manifold.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    ADJACENT-FACES

    • FACE
    • A
    • B
    • FACES
    • &OPTIONAL
    • ADJACENCY

    Source

    Returns a list of adjacent faces bordering the AB edge of FACE.
    
    ADJACENCY if given should be the face adjacency list obtained via
    FACE-ADJACENCY-LIST.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ADJACENCY-LIST
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    BOUNDARY-LENGTH

    • VERTICES
    • FACES

    Source

    Returns the length of the boundary of the mesh.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See BOUNDARY-LIST
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    BOUNDARY-LIST

    • FACES

    Source

    Returns a vector of edges on the boundary of the faces.
    
    Each entry in the resulting vector is one edge described by an
    EXTENDED-EDGE instance with the START and END slots being vertex
    indices, and the edge pointing from the START to the END. The OPPOSITE
    slot contains the index of the third vertex of the face to which the
    edge indicated by START and END belongs.
    
    Note that this requires that the FACES describe one coherent shape
    with only one outside edge. It does not consider multiple edge loops
    on the faces as separate boundaries.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    BOUNDING-BOX

    • VERTICES

    Source

    Returns the AABB of the point cloud.
    
    The AABB is returned as two VEC3s, the first being the center,, and
    the second being the half-size.
    
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)

  • EXTERNAL FUNCTION

    BOUNDING-SPHERE

    • VERTICES

    Source

    Computes a tight bounding sphere encapsulating the set of vertices.
    
    Returns two values, the center of the sphere as a *VEC3 and its radius.
    The returned types match the input vertex array's element type.
    
    See VERTEX-ARRAY (type)

  • EXTERNAL FUNCTION

    CENTROID

    • VERTICES
    • FACES

    Source

    Returns the centroid of the mesh.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    CLOSEST-POINT-ON-TRIANGLE

    • VERTICES
    • FACES
    • FACE
    • POINT

    Source

    Returns the closest point to POINT that lies on the FACE.
    
    FACE must be a FACE.
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACE (type)
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    CONVEX-P

    • VERTICES
    • FACES
    • &OPTIONAL
    • EPS

    Source

    Returns true if the mesh is convex.
    
    FACES must be a FACE-ARRAY
    VERTICES must be a VERTEX-ARRAY
    
    See FACE-ARRAY (type)
    See VERTEX-ARRAY (type

  • EXTERNAL FUNCTION

    EDGE

    • START
    • END

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    EDGE-ADJACENCY-MAP

    • FACES
    • &OPTIONAL
    • ADJACENCY

    Source

    Returns a map for the adjacent face for every edge of every face.
    
    The returned array is indexed by [ AB, BC, CA, ... ] of the edges of
    FACES, with each entry containing a list of other face indices that
    are adjacent to that edge, excluding the face of the edge being indexed.
    
    ADJACENCY if given should be the face adjacency list obtained via
    FACE-ADJACENCY-LIST.
    
    FACES must be a FACE-ARRAY.
    
    See ADJACENT-FACES
    See FACE-ADJACENCY-LIST
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    EDGE-LIST

    • FACES

    Source

    Returns a vector of bidirectional edges for the described faces.
    
    Unlike the half-edge-list, this edge-list does not contain any
    duplicated edges between any two vertices. Each entry in the resulting
    vector is one edge described by an EDGE instance with the START and
    END slots being vertex indices. Note that the actual direction of the
    edge is not indicated.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)
    See HALF-EDGE-LIST

  • EXTERNAL FUNCTION

    END

    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    (SETF END)

    • VALUE
    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    ENSURE-F32

    • A

    Source

    Ensure the given vector is an F32-vector.
    
    If it is not, returns a fresh vector that is.
    
    See F32 (type)

  • EXTERNAL FUNCTION

    ENSURE-F64

    • A

    Source

    Ensure the given vector is an F64-vector.
    
    If it is not, returns a fresh vector that is.
    
    See F64 (type)

  • EXTERNAL FUNCTION

    ENSURE-U16

    • A

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    ENSURE-U32

    • A

    Source

    Ensure the given vector is an U32-vector.
    
    If it is not, returns a fresh vector that is.
    
    See U32 (type)

  • EXTERNAL FUNCTION

    EXTENDED-EDGE

    • START
    • END
    • OPPOSITE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    F32

    • A

    Source

    Coerce a REAL into a F32.
    
    See F32 (type)

  • EXTERNAL FUNCTION

    F32*

    • &REST
    • I

    Source

    Construct a F32-vector from arguments.
    
    The arguments are automatically coerced to F32 elements.
    
    See F32 (type)

  • EXTERNAL FUNCTION

    F64

    • A

    Source

    Coerce a REAL into a F64.
    
    See F64 (type)

  • EXTERNAL FUNCTION

    F64*

    • &REST
    • I

    Source

    Construct a F64-vector from arguments.
    
    The arguments are automatically coerced to F64 elements.
    
    See F64 (type)

  • EXTERNAL FUNCTION

    FACE-ADJACENCY-LIST

    • FACES
    • &OPTIONAL
    • ADJACENCY

    Source

    Returns a vector of adjacent faces for each face.
    
    To get the list of adjacent faces for a face, access the element
    corresponding to the face's index.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    FACE-AREA

    • VERTICES
    • FACES
    • FACE

    Source

    Returns the area covered by the face.
    
    FACE must be a FACE.
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACE (type)
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    FACE-EDGE-P

    • FACES
    • FACE
    • A
    • B

    Source

    Returns true if the edge given by A B is a part of FACE
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    FACE-IN-VOLUME-P

    • VERTICES
    • FACES
    • FACE
    • LOCATION
    • BSIZE

    Source

    Returns true if the FACE is within the AABB described by LOCATION and BSIZE.
    
    LOCATION should be the center of the AABB, and BSIZE the half-size
    extent of the AABB.
    
    FACE must be a FACE.
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACES-IN-VOLUME
    See FACE (type)
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    FACE-NORMAL

    • VERTICES
    • FACES
    • FACE
    • &OPTIONAL
    • OUTPUT

    Source

    Returns the normal vector of the FACE.
    
    FACE must be a FACE.
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACE (type)
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    FACE-NORMALS

    • VERTICES
    • FACES
    • &OPTIONAL
    • FACE-NORMALS

    Source

    Returns an array of the normals of all faces.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    FACES-IN-VOLUME

    • VERTICES
    • FACES
    • LOCATION
    • BSIZE

    Source

    Returns a vector of all faces that are part of the AABB described by LOCATION and BSIZE.
    
    LOCATION should be the center of the AABB, and BSIZE the half-size
    extent of the AABB.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACE-IN-VOLUME-P
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    HALF-EDGE-LIST

    • FACES

    Source

    Returns a vector of half edges for the described faces.
    
    A half-edge is a directed edge from one vertex of a face to
    another. Each entry in the array represents a half-edge and contains
    an EDGE instance with the START and END slots each being vertex
    indices, and the edge pointing from the START to the END.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)
    See EDGE-LIST

  • EXTERNAL FUNCTION

    INTERSECTS-VOLUME-P

    • VERTICES
    • FACES
    • LOCATION
    • BSIZE

    Source

    Returns whether the mesh intersects the AABB described by LOCATION and BSIZE.
    
    LOCATION should be the center of the AABB, and BSIZE the half-size
    extent of the AABB.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACE-IN-VOLUME-P
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    NORMALIZE

    • VERTICES
    • INDICES
    • &KEY
    • THRESHOLD
    • CENTER
    • SCALE
    • ANGLE-THRESHOLD
    • AREA-THRESHOLD

    Source

    Normalizes the mesh by removing degenerate geometry.
    
    This is a shorthand for invoking
    REMOVE-DUPLICATE-VERTICES (if THRESHOLD is non-NIL and greater than
    zero) and
    REMOVE-DEGENERATE-TRIANGLES (if ANGLE-THRESHOLD or AREA-THRESHOLD are
    non-NIL and greater than zero) or REMOVE-UNUSED (if not). The
    AREA-THRESHOLD is multiplied by SCALE.
    
    Returns two values, a fresh VERTICES array and fresh FACES array.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)
    See REMOVE-UNUSED
    See REMOVE-DEGENERATE-TRIANGLES
    See REMOVE-DUPLICATE-VERTICES

  • EXTERNAL FUNCTION

    OPPOSITE

    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    (SETF OPPOSITE)

    • VALUE
    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    RAY-TRIANGLE

    • P
    • DIR
    • A
    • B
    • C

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    REMOVE-DEGENERATE-TRIANGLES

    • VERTICES
    • INDICES
    • &KEY
    • ANGLE-THRESHOLD
    • AREA-THRESHOLD
    • LENGTH-THRESHOLD

    Source

    Removes any triangle with a corner angle or area smaller than the given threshold
    
    The ANGLE-THRESHOLD (rad) is a parameter to determine how narrow an
    angle should be for a face to be considered to have no relevant
    surface and be removed. Similarly, AREA-THRESHOLD is a parameter to
    determine the surface area below which a triangle is deleted. This
    will potentially move vertices and introduce new vertices, and remove
    or introduce new faces. Finally, LENGTH-THRESHOLD is used to determine
    whether an edge is small enough to consider for fusion. If an edge is
    above this length it will be split instead of fused away.
    
    This will also compact the mesh via REMOVE-UNUSED.
    
    Returns two values, a fresh VERTICES array and fresh FACES array.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)
    See NORMALIZE
    See REMOVE-UNUSED

  • EXTERNAL FUNCTION

    REMOVE-DUPLICATE-VERTICES

    • VERTICES
    • INDICES
    • &KEY
    • THRESHOLD
    • CENTER
    • SCALE

    Source

    Removes all vertices within a threshold of another vertex, merging them together.
    
    The THRESHOLD is the distance threshold below which two vertices are
    considered the same. You may also optionally pass in a CENTER and
    SCALE to which the resulting vertices are positioned and scaled prior
    to normalisation.
    
    Returns two values, a fresh VERTICES array and fresh FACES array.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)
    See NORMALIZE

  • EXTERNAL FUNCTION

    REMOVE-UNUSED

    • VERTICES
    • INDICES

    Source

    Removes any vertex not referenced by a face, and any face that refers to two or more identical vertices.
    
    Returns two values, a fresh VERTICES array and fresh FACES array.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)
    See NORMALIZE

  • EXTERNAL FUNCTION

    SEPARATE-MESHES

    • VERTICES
    • FACES

    Source

    Returns a list of disjoint meshes.
    
    Each entry in the list is a CONS of a VERTEX-ARRAY and a FACE-ARRAY
    that make up the mesh. Each mesh is also disjoint from every other
    mesh, meaning they do not share any vertices.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    START

    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    (SETF START)

    • VALUE
    • INSTANCE

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    SURFACE-AREA

    • VERTICES
    • FACES

    Source

    Returns the total surface area of the mesh.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See FACE-AREA
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    TRANSFORM-MESH

    • VERTICES
    • MATRIX

    Source

    Transforms all vertices of the mesh by the given transform matrix.
    
    Returns the modified vertex array.
    
    See VERTEX-ARRAY (type)
    See 3D-MATH:MAT
    See 3D-MATH:DMAT

  • EXTERNAL FUNCTION

    TRIANGLE-AREA

    • P1
    • P2
    • P3

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    U16

    • A

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    U16*

    • &REST
    • I

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    U32

    • A

    Source

    Coerce a REAL into a U32.
    
    See U32 (type)

  • EXTERNAL FUNCTION

    U32*

    • &REST
    • I

    Source

    Construct a U32-vector from arguments.
    
    The arguments are automatically coerced to U32 elements.
    
    See U32 (type)

  • EXTERNAL FUNCTION

    V

    • VERTICES
    • I
    • &OPTIONAL
    • VEC

    Source

    Access a vertex as a vector.
    
    The vector matches the element-type of the vertices array.
    
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)

  • EXTERNAL FUNCTION

    (SETF V)

    • V
    • VERTICES
    • I

    Source

    No documentation provided.
  • EXTERNAL FUNCTION

    VERTEX-ADJACENCY-LIST

    • FACES
    • &OPTIONAL
    • ADJACENCY

    Source

    Returns a vector of adjacent vertices for each vertex.
    
    To get the list of adjacent vertices for a vertex, access the
    element corresponding to the vertex' index.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    VERTEX-FACES

    • FACES
    • &OPTIONAL
    • VERTEX-FACES

    Source

    Returns a vector of faces bordering each vertex.
    
    Each element in the returned array is another vector of face indices
    for the element's corresponding vector.
    
    FACES must be a FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    VERTEX-NORMAL

    • VERTICES
    • VERTEX
    • ADJACENTS

    Source

    Returns the normal vector of the VERTEX with ADJACENTS.
    
    You can obtain the ADJACENTS list via VERTEX-ADJACENCY-LIST.
    The normal is "smooth" based on the surrounding adjacent vertices.
    
    See VERTEX-ARRAY (type)
    See VERTEX (type)
    See VERTEX-ADJACENCY-LIST

  • EXTERNAL FUNCTION

    VOLUME

    • VERTICES
    • FACES

    Source

    Returns the volume of the mesh.
    
    FACES must be a FACE-ARRAY.
    VERTICES must be a VERTEX-ARRAY.
    
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL FUNCTION

    VOXELIZE

    • VERTICES
    • FACES
    • &KEY
    • GRID

    Source

    Creates a voxel representation of the given mesh.
    
    If FILL-INSIDES is T, the mesh is treated as a filled volume,
    otherwise as a hollow shell.
    
    GRID may be one of the following:
      INTEGER      --- The resolution in each dimension
      SINGLE-FLOAT --- The approximate size of a voxel cube
      (X Y Z)      --- The resolution of the voxel grid in each dimension
      ARRAY        --- The voxel grid to use. Must be a 3D SIMPLE-ARRAY
                       of element-type BIT.
    
    Returns the voxel grid, which is a 3-d array with the indices being
    DEPTH HEIGHT WIDTH, in that order. Each element is a BIT where 0 means
    empty space and 1 means occupied.
    
    The grid is normalised to be centred around the mesh's centroid and
    scaled according to its bounding size, which are returned as secondary
    values.
    
    See INTERSECTS-VOLUME-P
    See VERTEX-ARRAY (type)
    See FACE-ARRAY (type)

  • EXTERNAL MACRO

    DO-FACES

    • A
    • B
    • C
    • FACES
    • &OPTIONAL
    • RESULT
    • &BODY
    • BODY

    Source

    Iterate over the faces of a FACE-ARRAY.
    
    A B and C are bound to the vertex indices for each face in the
    FACE-ARRAY. RESULT is evaluated and returned at the end of iteration.
    
    FACES must be of type FACE-ARRAY.
    
    See FACE-ARRAY (type)

  • EXTERNAL MACRO

    DO-VERTICES

    • V
    • VERTICES
    • &KEY
    • UPDATE
    • RESULT
    • &BODY
    • BODY

    Source

    No documentation provided.