ProtoTwin API
    Preparing search index...

    Interface SpeedProfile

    Speed profile.

    interface SpeedProfile {
        evaluate(t: number, point: SpeedProfilePoint): void;
        plan(
            targetPosition: number,
            initialPosition: number,
            initialVelocity: number,
            targetVelocity: number,
            maximumAcceleration: number,
            maximumDeceleration: number,
        ): void;
        reset(): void;
    }

    Implemented by

    Index

    Methods

    evaluate plan reset

    Methods

    • Evaluates a point on the speed profile curve.

      Parameters

      Returns void

    • Initializes the speed profile curve.

      Parameters

      • targetPosition: number

        The (signed) target position.

      • initialPosition: number

        The (signed) initial position.

      • initialVelocity: number

        The (signed) initial velocity.

      • targetVelocity: number

        The (unsigned) maximum/target velocity.

      • maximumAcceleration: number

        The (unsigned) maximum/target acceleration.

      • maximumDeceleration: number

        The (unsigned) maximum/target deceleration.

      Returns void

    • Resets the speed profile curve.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods