revolve.md

title	revolve
description	Code3D revolve API: Rotate a planar profile about a straight directed axis. Learn parameters, coordinates, results and limits.
sourceReview	packageVersion sources 0.0.1-alpha.16 path sha256 commit packages/core/src/library/revolve.ts 664590e1d7211b0886b124d347c2706df51d630a511a62c734e7b2b1ace472e0 2e2cf49d64dba98b613224b6ae39aa632d6d2eb0 path sha256 packages/core/src/library/runtime.ts dcee3d2388a9b7b3819bb4897edd894463daa0e5b519e832a3349fac98c3bff8 path sha256 commit packages/core/src/library/extrude-geometry.ts d40306254ae087b4d327fd7b4ad37a15d13fbd6925073cd0a7fe8aaa28fc34f6 2e2cf49d64dba98b613224b6ae39aa632d6d2eb0
sidebar	hidden true
head	tag content title revolve — Code3D TypeScript API reference

Rotate a planar profile about a straight directed axis. Optional axial advance produces screw motion over one or several turns.

Example

import {circle, line, revolve} from '@code3d/core';

const axis = line([0, -20, 0], [0, 20, 0]);
const ringSection = circle(1).rotate(90, 0, 0).originOffset(-8, 0, 0);
export const ring = revolve(ringSection, axis, {angle: 360});

Complete example: shape construction.

Signature

function revolve(
  profile: FaceModel<{}>,
  axis: LineAnchor,
  config: RevolveConfig,
): SolidModel;
type RevolveConfig = Readonly<{angle: number; advance?: number}>;
// Equivalent method:
profile.revolve(axis, config);

Import the functions and named types from @code3d/core.

Parameters

Parameter	Meaning
profile	One planar filled face
axis	A straight directed line or axis reference; a line model works directly
config.angle	Required finite, non-zero signed angle, in degrees
config.advance	Signed total distance along the axis over the entire angle; defaults to 0

Positive rotation follows the right-hand rule about the directed axis. A positive advance follows that same axis; reversing it reverses both senses. Advance is not pitch per turn: {angle: 1800, advance: 25} describes five turns with pitch 5. See the helical revolution example.

The ring example sweeps a radius-1 disk whose center is 8 units from the Y axis. It produces a torus with volume 16 * Math.PI ** 2, approximately 157.913670.

Placement and limits

The result retains the profile's local frame and placement. The axis and profile are solved together, so the axis model's own relations are respected. An axis is an infinite directed reference for this operation; the finite line's endpoints do not clip the rotation.

Without advance, Math.abs(angle) must not exceed 360. With non-zero advance, multiple turns are allowed. A helical profile must have one outer boundary and no holes. Crossing the axis, intersecting turns or other degenerate inputs may fail to form a valid solid. Leave clearance between turns; coil is a shorter constructor with dedicated clearance checks for circular-wire coils.

Curved profiles and curved axes are rejected. Angle must be finite and non-zero; advance must be finite. The TypeScript configuration and its angle are required. During incomplete-call editing, the runtime uses angle 360 and advance 0. The App can inspect either participant and edit those numeric configuration fields.

Coordinates and model values

The operation creates new geometry without modifying its inputs. References and measurements belong to the returned model's local frame; relations participate where the operation combines inputs. See local coordinates and model values. A solid supports .area, .volume, topology selection, Booleans and finishing operations.

Related APIs

• extrude extends a profile without rotation.
• sweep carries it along an authored curve.