front: rename getPointCoordinates -> getPointCoordinatesOnTrack

Signed-off-by: Clara Ni <[email protected]>

front/src/applications/operationalStudies/hooks/useSetupItineraryForTrainUpdate.ts

@@ -23,7 +23,7 @@ import { setFailure } from 'reducers/main';
 import type { PathStep } from 'reducers/osrdconf/types';
 import { useAppDispatch } from 'store';
 import { castErrorToFailure } from 'utils/error';
-import { getPointCoordinates } from 'utils/geometry';
+import { getPointCoordinatesOnTrack } from 'utils/geometry';
 
 import type { ManageTrainSchedulePathProperties } from '../types';
 import { useManageTrainScheduleContext } from './useManageTrainScheduleContext';
@@ -103,7 +103,7 @@ const useSetupItineraryForTrainUpdate = (trainIdToEdit: number) => {
         if ('track' in step) {
           const track = tracks[step.track];
           if (track) {
-            coordinates = getPointCoordinates(track.geo, track.length, step.offset);
+            coordinates = getPointCoordinatesOnTrack(track.geo, track.length, step.offset);
           }
         } else {
           let op: SearchResultItemOperationalPoint | undefined;

front/src/modules/pathfinding/helpers/getPointOnPathCoordinates.ts

@@ -1,6 +1,6 @@
 import type { TrackRange, TrackSection } from 'common/api/osrdEditoastApi';
 import { findTrackSectionOffset } from 'modules/powerRestriction/helpers/createPathStep';
-import { getPointCoordinates } from 'utils/geometry';
+import { getPointCoordinatesOnTrack } from 'utils/geometry';
 import { mToMm } from 'utils/physics';
 
 /**
@@ -21,7 +21,7 @@ const getPointOnPathCoordinates = (
 
   const track = tracks[trackOffset!.track];
 
-  return getPointCoordinates(track.geo, mToMm(track.length), trackOffset!.offset);
+  return getPointCoordinatesOnTrack(track.geo, mToMm(track.length), trackOffset!.offset);
 };
 
 export default getPointOnPathCoordinates;

front/src/modules/pathfinding/utils.ts

@@ -12,7 +12,7 @@ import { getSupportedElectrification, isThermal } from 'modules/rollingStock/hel
 import type { SuggestedOP } from 'modules/trainschedule/components/ManageTrainSchedule/types';
 import type { PathStep } from 'reducers/osrdconf/types';
 import { addElementAtIndex } from 'utils/array';
-import { getPointCoordinates } from 'utils/geometry';
+import { getPointCoordinatesOnTrack } from 'utils/geometry';
 
 import getStepLocation from './helpers/getStepLocation';
 
@@ -35,7 +35,7 @@ export const formatSuggestedOperationalPoints = (
     offsetOnTrack: op.part.position,
     track: op.part.track,
     positionOnPath: op.position,
-    coordinates: getPointCoordinates(geometry, pathLength, op.position),
+    coordinates: getPointCoordinatesOnTrack(geometry, pathLength, op.position),
     metadata: op?.metadata,
   }));
 

front/src/modules/trainschedule/components/ManageTrainSchedule/ManageTrainScheduleMap/AddPathStepPopup.tsx

@@ -19,7 +19,7 @@ import { osrdEditoastApi, type OperationalPoint } from 'common/api/osrdEditoastA
 import { useOsrdConfSelectors } from 'common/osrdContext';
 import { setPointIti } from 'modules/trainschedule/components/ManageTrainSchedule/ManageTrainScheduleMap/setPointIti';
 import { type PathStep } from 'reducers/osrdconf/types';
-import { getPointCoordinates } from 'utils/geometry';
+import { getPointCoordinatesOnTrack } from 'utils/geometry';
 
 import type { FeatureInfoClick } from '../types';
 import OperationalPointPopupDetails from './OperationalPointPopupDetails';
@@ -121,7 +121,7 @@ const AddPathStepPopup = ({
 
       const trackPartCoordinates = operationalPoint.parts.map((part) => ({
         trackName: tracks[part.track]?.extensions?.sncf?.track_name,
-        coordinates: getPointCoordinates(
+        coordinates: getPointCoordinatesOnTrack(
           tracks[part.track]?.geo,
           tracks[part.track]?.length,
           part.position

front/src/utils/geometry.ts

@@ -151,16 +151,21 @@ export function nearestPointOnLine(
   });
 }
 
-export function getPointCoordinates(
+/**
+ * Given a track's geometry and length and an offset from the start of the track (in mm),
+ * returns the coordinates of the point for the given offset.
+ */
+export function getPointCoordinatesOnTrack(
   geometry: GeoJsonLineString,
-  pathLength: number,
-  infraPositionOnPath: number
+  trackLength: number, // in mm
+  infraPositionOnTrack: number // in mm
 ): Position {
   const pathLineString = lineString(geometry.coordinates);
   const geometryTrackLength = length(pathLineString, { units: 'millimeters' });
-  const infraTrackLength = pathLength;
+  const infraTrackLength = trackLength;
   // TODO TS2 : when adapting train update check that this computation works properly
-  const geometryDistanceAlongTrack = infraPositionOnPath * (geometryTrackLength / infraTrackLength);
+  const geometryDistanceAlongTrack =
+    infraPositionOnTrack * (geometryTrackLength / infraTrackLength);
   return along(pathLineString, geometryDistanceAlongTrack, { units: 'millimeters' }).geometry
     .coordinates;
 }