ProtoTwin API
    Preparing search index...

    Class Arc

    Immutable arc.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    • Constructor.

      Parameters

      • plane: Plane

        The plane in which the arc lies.

      • angle: number

        The angle for the arc.

      • radius: number

        The uniform radius for the arc.

      • initialSurfaceNormal: Vec3 = Vec3.zero

        The (optional) initial surface normal for the arc.

      Returns Arc

    Properties

    angle: number

    The angle for the arc.

    initialSurfaceNormal: Vec3

    The initial surface normal for the arc.

    plane: Plane

    The plane in which the arc lies.

    radius: number

    The uniform radius for the arc.

    Accessors

    • get closed(): boolean

      Whether the arc is a complete circle.

      Returns boolean

    • get length(): number

      The arc length.

      Returns number

    Methods

    • Evaluates the frame at the specified distance.

      Parameters

      • s: number

        The distance.

      Returns Frame

      The frame.

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

      Parameters

      • s: number

        The arc-length.

      Returns Vec3

      The normal to the arc.

    • Parameters

      • s: number

      Returns number

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

      Parameters

      • s: number

        The arc-length.

      Returns Vec3

      The point on the arc.

    • Calculates the angle for the specified point when projected onto the arc.

      Parameters

      Returns number

      The angle for the projected point.

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

      Parameters

      Returns number

      The arc-length for the projected point.

    • Parameters

      • s: number
      • distances: number[]

      Returns number

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

      Parameters

      • s: number

        The arc-length.

      Returns Vec3

      The tangent to the arc.