類別 GeoLine

From

To

Clone

• Clone(): GeoLine

  產生一份新的自己。

  回傳 GeoLine

  傳回複製的新的自己。

CopyFrom

• CopyFrom(obj: GeoLine): GeoLine

  複製。

  參數

  • obj: GeoLine

    複製的資料源。

  回傳 GeoLine

  this
• CopyFrom(obj: { From: PointLike; To: PointLike }): GeoLine

  複製。

  參數

  • obj: { From: PointLike; To: PointLike }

    複製的資料源。

  回傳 GeoLine

  this

Classify

• Classify(p: PointLike): GeoStatus

  取得傳入點p與本身的相關位置。

  參數

  • p: PointLike

    欲測試的資料點。

  回傳 GeoStatus

  相關位置

Intersect

• Intersect(
      e: GeoLine,
      obj: GeoPoint | { t: number },
      includeZ?: boolean,
  ): null | GeoStatus

  取得與傳入線段e的相關位置。

  參數

  • e: GeoLine

    欲比較的線段。
  • obj: GeoPoint | { t: number }

    此為out參數,需先在外面配好變數,回傳時,若為GeoPoint,則為交點,否則Obj.t代表交點離起點的距離,單位為整個線段的比例,也就是0<=Obj.t<=1。
  • includeZ: boolean = false

    是否處理z值，預設值為false

  回傳 null | GeoStatus

  相關位置。

Rot

• Rot(): void

  將此線段以中心點為旋轉中心,逆時針,轉動90度。

  回傳 void

Flip

• Flip(): void

  將此線段的起點與終點對調。

  回傳 void

GetPoint

• GetPoint(t: number): GeoPoint

  取得從起點往終點方向的某比例的點。

  參數

  • t: number

    欲取出點的比例,此比例可為正或負,單位為線段的長度。

  回傳 GeoPoint

  取出的點

IsIntersect

• IsIntersect(
      line: GeoLine,
      endPointIncluded: boolean,
      obj: GeoPoint | { t: number },
      includeZ?: boolean,
  ): boolean

  判斷自己與傳入線段是否相交。

  參數

  • line: GeoLine

    欲檢查的線段。
  • endPointIncluded: boolean

    若只交道端點,是否算是相交。
  • obj: GeoPoint | { t: number }

    此為out參數,需先在外面配好變數,回傳時,若為GeoPoint,則為交點,否則Obj.t代表交點離起點的距離,單位為整個線段的比例,也就是0<=Obj.t<=1。
  • includeZ: boolean = false

    是否處理z值，預設值為false，只有在Obj類型為GeoPoint時有用。

  回傳 boolean

  是否相交。

Distance

• Distance(
      obj: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoLine,
  ): number

  計算自己與傳入幾何的距離。

  參數

  • obj: GeoPoint | GeoPolyline | GeoPolygon | GeoPolygonSet | GeoLine

    要計算距離的幾何資料。

  回傳 number

  傳回距離。

GetNearPoint

• GetNearPoint(p: PointLike3D, ret: GeoPoint): number

  取得在此線段中,離傳入的點p最近的點Ret。

  參數

  • p: PointLike3D

    要計算的點。
  • ret: GeoPoint

    此為out,要在外面先配置好,會傳回最近的點。

  回傳 number

  傳回離最近的點的距離。

PtInsideLine

• PtInsideLine(p: GeoPoint): boolean

  判定點p是否位於線段中。

  參數

  • p: GeoPoint

    欲判斷的點。

  回傳 boolean

  傳回判斷的結果。

Offset

• Offset(p: PointLike): void

  將線段位移p。

  參數

  • p: PointLike

    欲位移的距離。

  回傳 void

MakeBuffer

• MakeBuffer(distance: number, polygonSet: GeoPolygonSet): boolean

  做出環域的PolygonSet。

  參數

  • distance: number

    環域的距離。
  • polygonSet: GeoPolygonSet

    out參數，環域計算的答案。

  回傳 boolean

  回傳是否成功。

ForwardExtend

• ForwardExtend(distance: number): void

  線段往前延展。

  參數

  • distance: number

    往前延展的距離。

  回傳 void

BackExtend

• BackExtend(distance: number): void

  線段往後退縮。

  參數

  • distance: number

    往後退縮的距離。

  回傳 void

SplitBy

• SplitBy(line: GeoLine, buffer1: GeoLine[], buffer2: GeoLine[]): boolean

  找出此線段和傳入線段的焦點。

  參數

  • line: GeoLine

    要計算的線段。
  • buffer1: GeoLine[]

    此為out參數,要在外面先配置好,傳回從自己的起點算,所經過的交點,因為是線段,所以最多只會有一個點。
  • buffer2: GeoLine[]

    此為out參數,要在外面先配置好,傳回從傳入的Line起點算,所經過的交點,因為是線段,所以最多只會有一個點。

  回傳 boolean

  傳回所有交點數量。

ToGeoJSON

• ToGeoJSON(toString?: false, includeZ?: boolean): GeoJSON.Polyline

  將幾何輸出成GeoJSON物件。

  參數

  • 可選toString: false

    是否把物件轉成JSON字串。
  • 可選includeZ: boolean

    是否包含Z，標準GeoJSON不包含Z(可不給，預設false)。

  回傳 GeoJSON.Polyline

  輸出轉換結果。
• ToGeoJSON(toString: true, includeZ?: boolean): string

  將幾何輸出成GeoJSON字串。

  參數

  • toString: true

    是否把物件轉成JSON字串。
  • 可選includeZ: boolean

    是否包含Z，標準GeoJSON不包含Z(可不給，預設false)。

  回傳 string

  輸出轉換結果。

FromGeoJSON

• FromGeoJSON(src: string | GeoJSON.Geometry): boolean

  讀入 GeoJSON 數值。

  參數

  • src: string | GeoJSON.Geometry

    GeoJSON 物件或字串。

  回傳 boolean

  回傳讀取是否成功。

constructor

• new GeoLine(): GeoLine

  建立線段

  回傳 GeoLine

  範例

  let line = new GeoLine(); // 預設建構子
  複製

• new GeoLine(obj: { From: PointLike; To: PointLike }): GeoLine

  建立線段

  參數

  • obj: { From: PointLike; To: PointLike }

    欲複製的GeoLine; 帶有From,To的物件。

  回傳 GeoLine

  範例

  let line = new GeoLine();
  let lineCopy = new GeoLine(line); // 使用欲複製的GeoLine建立GeoLine
  let lineObj = new GeoLine({From: new GeoPoint(), To: new GeoPoint()}); // 使用帶有From,To的Object建立GeoLine
  複製

• new GeoLine(from: PointLike, to: PointLike): GeoLine

  建立線段

  參數

  • from: PointLike

    指定的From。
  • to: PointLike

    指定的To。

  回傳 GeoLine

  範例

  let from = new GeoPoint();
  let to = new GeoPoint();
  let line = new GeoLine(from, to); // 指定From,To並建立GeoLine
  複製

PolarAngle

• get PolarAngle(): number

  波拉角,即從起點往終點的向量,此向量的數學角度,單位為角度

  回傳 number

type

• get type(): 2

  物件型態,值為 GEO_TYPE.LINE

  回傳 2

Boundary

• get Boundary(): GeoBoundary

  此幾何的範圍

  回傳 GeoBoundary

Length

• get Length(): number

  長度

  回傳 number

Center

• get Center(): GeoPoint

  中心點

  回傳 GeoPoint