Euclid 0.20.0-beta1

Euclid

A comprehensive 2D and 3D geometry library in F# without dependencies, designed for precision engineering and computational design.
It runs on JavaScript too.

Features

While most 3D geometry libraries just use a generic type ( often called Vec3 or similar) containing three floats for both points and vectors,
Euclid makes a distinction to preserve semantic meaning and avoid accidental misuse.
A point represents a position in space, while a vector represents a direction and magnitude.
Even unitized vectors are a separate type. They are guaranteed to have a length of 1.0.
This helps to skip checks for zero length vectors in many operations.

🎯 Core Geometry Types

• Points (Pt, Pnt), Vectors (Vc, Vec), Unit Vectors (UnitVc, UnitVec)
• Lines, Planes, Boxes, Bounding Boxes, Polylines
• Rotations, Quaternions, 4x4 and rigid orthonormal 4x3 matrices

✨ Key Advantages

• Zero dependencies - lightweight and self-contained
• Double precision - engineered for CAD/manufacturing accuracy
• Immutable types - functional programming friendly
• Cross-platform - compiles to .NET, JavaScript, TypeScript, Rust, Python via Fable
• Performant - All small types are structs, functions are often inline and try to minimize the allocation of intermediate objects.

🔧 Design & Manufacturing Focus

• Optimized for design, construction, and manufacturing workflows
• Integrates seamlessly with Rhino3D
• Right-handed coordinate system (Z-up) matching industry standards

Installation

Add Euclid to your F# project via NuGet:

dotnet add package Euclid

Or in F# scripting:

#r "nuget: Euclid"

Quick Start

open Euclid

// Create 3D points and vectors
let point1 = Pnt(1.0, 2.0, 3.0)
let point2 = Pnt(4.0, 5.0, 6.0)
let vector = Vec(1.0, 1.0, 0.0)

// Calculate distance
let distance = Pnt.distance point1 point2

// Create and use unit vectors
let unitVec = vector.Unitized  // returns a UnitVec

// Transform with 4x4 matrix
let matrix =
    Matrix.createShear(3.0, 0, 0, 0, 0, 0)
    *** // Combine transformations
    Matrix.createRotationZ 45

point1
|> Pnt.translate vector
|> Pnt.scale 3.0
|> Pnt.transform matrix

Coordinate System

This library uses a right-handed coordinate system with the Z-axis pointing up.

✅ Same as in: Rhino3D, Blender, SketchUp, Revit, AutoCAD ❌ Different from: Unity, Unreal Engine, Maya

This choice aligns with industry-standard CAD and architectural software.

Design Philosophy

Points vs Vectors

• Points (Pt, Pnt): Positions in space
• Vectors (Vc, Vec): Directions and displacements

When a 4x4 transformation matrix is applied:

• Points: Undergo full transformation (rotation, scaling, translation)
• Vectors: Only rotate and scale (no translation)

This follows homogeneous coordinate conventions where vectors have w=0.

Naming Conventions

Function Patterns

Functions are available in multiple forms:

// Static module function (lowercase)
let normalized = Vec.unitized myVector

// Instance method/property (uppercase)
let normalized = myVector.Unitized

API Documentation

📚 Full API Reference: goswinr.github.io/Euclid

Platform Support

Thanks to Fable, Euclid can be used not only on .NET but also in JavaScript, TypeScript, Rust, and Python.

Development

Prerequisites

• .NET SDK 10.0 or later (to have scoped warnings available)
• Node.js (only needed to run the .NET tests in JavaScript and TypeScript via Fable.Mocha)

Building from Source

git clone https://github.com/goswinr/Euclid.git
cd Euclid
dotnet build

Testing

Tests run on both .NET and JavaScript with TypeScript build verification.

.NET Testing

dotnet run --project ./Tests/Euclid.Tests.fsproj

JavaScript Testing

npm run test --prefix ./Tests

The test suite ensures cross-platform compatibility and verifies TypeScript type definitions.

Contributing

Contributions are welcome!

Changelog

📋 See CHANGELOG.md for version history.

Related Projects

🦏 Euclid.Rhino - Rhino3D integration

License

MIT