Class Circle

constructor

• new Circle(plane: Plane, radius: number, initialSurfaceNormal?: Vec3): Circle

  Constructor.

  Parameters

  • plane: Plane

    The plane in which the circle lies.
  • radius: number

    The uniform radius for the circle.
  • initialSurfaceNormal: Vec3 = Vec3.zero

    The (optional) initial surface normal for the circle.

  Returns Circle

ReadonlyinitialSurfaceNormal

Readonlyplane

Readonlyradius

closed

• get closed(): boolean

  Whether the curve is closed.

  Returns boolean

length

• get length(): number

  The circumference.

  Returns number

type

• get type(): CurveType

  The type of the curve.

  Returns CurveType

Staticdefault

• get default(): Circle

  Returns Circle

frame

• frame(s: number): Frame

  Evaluates the frame at the specified distance.

  Parameters

  • s: number

    The distance.

  Returns Frame

  The frame.

normal

• normal(s: number): Vec3

  Evaluates the normal to the circle at the specified arc-length.

  Parameters

  • s: number

    The arc-length.

  Returns Vec3

  The normal to the circle.

point

• point(s: number): Vec3

  Evaluates the point on the circle at the specified arc-length.

  Parameters

  • s: number

    The arc-length.

  Returns Vec3

  The point on the circle.

projectedAngle

• projectedAngle(point: IVec3): number

  Calculates the angle for the specified point when projected onto the circle.

  Parameters

  • point: IVec3

    The point.

  Returns number

  The angle for the projected point.

projectedLength

• projectedLength(point: IVec3): number

  Calculates the arc-length for the specified point when projected onto the circle.

  Parameters

  • point: IVec3

    The point.

  Returns number

  The arc-length for the projected point.

tangent

• tangent(s: number): Vec3

  Evaluates the tangent to the circle at the specified arc-length.

  Parameters

  • s: number

    The arc-length.

  Returns Vec3

  The tangent to the circle.