Hide menu
Loading...
Searching...
No Matches
ToroidalSurface

Defines a toroidal surface.

A toroidal surface is defined by a position axis returned by position, a major radius, and a minor radius.

Extends

Constructors

Constructor

new ToroidalSurface(position, majorRadius, minorRadius): ToroidalSurface

Creates a toroidal surface from a position axis, major radius, and minor radius.

Throws a RangeError if majorRadius is less than 0. Throws a RangeError if minorRadius is less than 0.

Parameters

position

Axis3d

Position axis of the toroidal surface.

majorRadius

number

Major radius of the toroidal surface.

minorRadius

number

Minor radius of the toroidal surface.

Returns

ToroidalSurface

Overrides

ElementarySurface.constructor

Properties

position

readonly position: Axis3d

Position axis of the surface.

Inherited from

ElementarySurface.position

Accessors

direction

Get Signature

get direction(): Direction

Returns the Z direction of the surface axis.

Returns

Direction

Inherited from

ElementarySurface.direction


id

Get Signature

get id(): bigint

Returns the unique identifier of the object.

Returns

bigint

Inherited from

ElementarySurface.id


location

Get Signature

get location(): Point

Returns the origin point of the surface axis.

Returns

Point

Inherited from

ElementarySurface.location


majorRadius

Get Signature

get majorRadius(): number

Major radius of the toroidal surface.

Returns

number


minorRadius

Get Signature

get minorRadius(): number

Minor radius of the toroidal surface.

Returns

number


type

Get Signature

get type(): SurfaceType

Type of the surface.

Returns

SurfaceType

Inherited from

ElementarySurface.type