Shapemetry API

---

Shapemetry API / ToroidalSurface

Class: ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:6

Toroidal surface: P(u,v) = center + (R + rcos(v))(cos(u)*x + sin(u)y) + rsin(v)*z.

Constructors

Constructor

new ToroidalSurface(center, majorRadius, minorRadius, xAxis, yAxis, zAxis): ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:14

Parameters

center

Point

majorRadius

number

minorRadius

number

xAxis

Vector

yAxis

Vector

zAxis

Vector

Returns

ToroidalSurface

Properties

center

readonly center: Point

Defined in: surfaces/ToroidalSurface.ts:7

---

majorRadius

readonly majorRadius: number

Defined in: surfaces/ToroidalSurface.ts:8

---

minorRadius

readonly minorRadius: number

Defined in: surfaces/ToroidalSurface.ts:9

---

xAxis

readonly xAxis: Vector

Defined in: surfaces/ToroidalSurface.ts:10

---

yAxis

readonly yAxis: Vector

Defined in: surfaces/ToroidalSurface.ts:11

---

zAxis

readonly zAxis: Vector

Defined in: surfaces/ToroidalSurface.ts:12

Methods

new()

static new(center, majorRadius, minorRadius): ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:23

Parameters

center

Point

majorRadius

number

minorRadius

number

Returns

ToroidalSurface

---

withAxis()

static withAxis(center, majorRadius, minorRadius, zAxis): ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:29

Parameters

center

Point

majorRadius

number

minorRadius

number

zAxis

Vector

Returns

ToroidalSurface

---

withAxisAndRefDir()

static withAxisAndRefDir(center, majorRadius, minorRadius, zAxis, refDir): ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:36

Parameters

center

Point

majorRadius

number

minorRadius

number

zAxis

Vector

refDir

Vector

Returns

ToroidalSurface

---

withAxes()

static withAxes(center, majorRadius, minorRadius, xAxis, yAxis, zAxis): ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:44

Construct directly from pre-computed axes (no normalization). Used for exact round-trip from serialized data.

Parameters

center

Point

majorRadius

number

minorRadius

number

xAxis

Vector

yAxis

Vector

zAxis

Vector

Returns

ToroidalSurface

---

pointAt()

pointAt(u, v): Point

Defined in: surfaces/ToroidalSurface.ts:50

Parameters

u

number

v

number

Returns

Point

---

normalAt()

normalAt(u, v): Vector

Defined in: surfaces/ToroidalSurface.ts:59

Parameters

u

number

v

number

Returns

Vector

---

partialU()

partialU(u, v): Vector

Defined in: surfaces/ToroidalSurface.ts:65

Parameters

u

number

v

number

Returns

Vector

---

partialV()

partialV(u, v): Vector

Defined in: surfaces/ToroidalSurface.ts:71

Parameters

u

number

v

number

Returns

Vector

---

closestParam()

closestParam(point): [number, number]

Defined in: surfaces/ToroidalSurface.ts:77

Parameters

point

Point

Returns

[number, number]

---

translated()

translated(offset): ToroidalSurface

Defined in: surfaces/ToroidalSurface.ts:93

Parameters

offset

Vector

Returns

ToroidalSurface