-
Notifications
You must be signed in to change notification settings - Fork 208
/
LinearReferencingCommon.ts
42 lines (37 loc) · 1.5 KB
/
LinearReferencingCommon.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module LinearReferencing
*/
import { Id64String } from "@itwin/core-bentley";
/** Interface with data returned by LinearElement.queryLinearLocations API
* @beta
*/
export interface LinearLocationReference {
startDistanceAlong: number;
stopDistanceAlong: number;
linearlyLocatedId: Id64String;
linearlyLocatedClassFullName: string;
locationAspectId: Id64String;
}
/** Enum capturing range-comparison options for from/to distanceAlong in QueryParams
* @beta
*/
export enum ComparisonOption { Inclusive, Exclusive }
/** Enum enabling LinearElement.queryLinearLocations performance optimization when the target Linearly-Located classes are all either At or FromTo.
* @beta
*/
export enum LinearlyReferencedLocationType { At, FromTo, Any }
/** Interface capturing various parameters for the execution of LinearElement.queryLinearLocations API
* @beta
*/
export interface QueryParams {
fromDistanceAlong?: number;
fromComparisonOption?: ComparisonOption;
toDistanceAlong?: number;
toComparisonOption?: ComparisonOption;
linearlyReferencedLocationTypeFilter?: LinearlyReferencedLocationType;
linearlyLocatedClassFullNames?: string[];
}