API Reference › core-geometry› CartesianGeometry › AngleSweep › FractionToSignedPeriodicFraction

fractionToSignedPeriodicFraction Method

Convert a sweep fraction to the equivalent period-shifted fraction inside this sweep, or within one period of zero on the desired side.

fractionToSignedPeriodicFraction(fraction: number, toNegativeFraction?: boolean): number

@returns period-shifted fraction. If fraction is already in [0,1], or the sweep is empty, then fraction is returned unchanged.

Parameter Type Description
fraction number fraction of the sweep.
toNegativeFraction boolean exterior fraction handling:
* if true, return fraction period-shifted to within one period of the start
* if false, return fraction period-shifted to within one period of the end
* if undefined, return the period-shift of fraction closest to [0,1].

Returns - number

period-shifted fraction. If fraction is already in [0,1], or the sweep is empty, then fraction is returned unchanged.

Defined in

Last Updated: 07 June, 2025