Class GeoLine

constructor

• new GeoLine(): GeoLine

• 建立線段

  Returns GeoLine

  Example

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

• new GeoLine(obj): GeoLine

• 建立線段

  Parameters

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

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

    • From: PointLike

    • To: PointLike

  Returns GeoLine

  Example

  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
  Copy

• new GeoLine(from, to): GeoLine

• 建立線段

  Parameters

  • from: PointLike

    指定的From。

  • to: PointLike

    指定的To。

  Returns GeoLine

  Example

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

From

To

Boundary

• get Boundary(): GeoBoundary

• 此幾何的範圍

  Returns GeoBoundary

Center

• get Center(): GeoPoint

• 中心點

  Returns GeoPoint

Length

• get Length(): number

• 長度

  Returns number

PolarAngle

• get PolarAngle(): number

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

  Returns number

type

• get type(): 2

• 物件型態,值為 GEO_TYPE.LINE

  Returns 2

BackExtend

• BackExtend(distance): void

• 線段往後退縮。

  Parameters

  • distance: number

    往後退縮的距離。

  Returns void

Classify

• Classify(p): GeoStatus

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

  Parameters

  • p: PointLike

    欲測試的資料點。

  Returns GeoStatus

  相關位置

Clone

• Clone(): GeoLine

• 產生一份新的自己。

  Returns GeoLine

  傳回複製的新的自己。

CopyFrom

• CopyFrom(obj): GeoLine

• 複製。

  Parameters

  • obj: GeoLine

    複製的資料源。

  Returns GeoLine

  this
• CopyFrom(obj): GeoLine

• 複製。

  Parameters

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

    複製的資料源。

    • From: PointLike

    • To: PointLike

  Returns GeoLine

  this

Distance

• Distance(obj): number

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

  Parameters

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

    要計算距離的幾何資料。

  Returns number

  傳回距離。

Flip

• Flip(): void

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

  Returns void

ForwardExtend

• ForwardExtend(distance): void

• 線段往前延展。

  Parameters

  • distance: number

    往前延展的距離。

  Returns void

FromGeoJSON

• FromGeoJSON(src): boolean

• 讀入 GeoJSON 數值。

  Parameters

  • src: string | GeoJSON.Geometry

    GeoJSON 物件或字串。

  Returns boolean

  回傳讀取是否成功。

GetNearPoint

• GetNearPoint(p, ret): number

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

  Parameters

  • p: PointLike3D

    要計算的點。

  • ret: GeoPoint

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

  Returns number

  傳回離最近的點的距離。

GetPoint

• GetPoint(t): GeoPoint

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

  Parameters

  • t: number

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

  Returns GeoPoint

  取出的點

Intersect

• Intersect(e, obj, includeZ?): null | GeoStatus

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

  Parameters

  • e: GeoLine

    欲比較的線段。

  • obj: GeoPoint | {
        t: number;
    }

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

  • includeZ: boolean = false

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

  Returns null | GeoStatus

  相關位置。

IsIntersect

• IsIntersect(line, endPointIncluded, obj, includeZ?): boolean

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

  Parameters

  • line: GeoLine

    欲檢查的線段。

  • endPointIncluded: undefined | boolean

    若只交道端點,是否算是相交。

  • obj: GeoPoint | {
        t: number;
    }

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

  • includeZ: boolean = false

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

  Returns boolean

  是否相交。

MakeBuffer

• MakeBuffer(distance, polygonSet): boolean

• 做出環域的PolygonSet。

  Parameters

  • distance: number

    環域的距離。

  • polygonSet: GeoPolygonSet

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

  Returns boolean

  回傳是否成功。

Offset

• Offset(p): void

• 將線段位移p。

  Parameters

  • p: PointLike

    欲位移的距離。

  Returns void

PtInsideLine

• PtInsideLine(p): boolean

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

  Parameters

  • p: GeoPoint

    欲判斷的點。

  Returns boolean

  傳回判斷的結果。

Rot

• Rot(): void

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

  Returns void

SplitBy

• SplitBy(line, buffer1, buffer2): boolean

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

  Parameters

  • line: GeoLine

    要計算的線段。

  • buffer1: GeoLine[]

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

  • buffer2: GeoLine[]

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

  Returns boolean

  傳回所有交點數量。

ToGeoJSON

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

• 將幾何輸出成GeoJSON物件。

  Parameters

  • Optional toString: false

    是否把物件轉成JSON字串。

  • Optional includeZ: boolean

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

  Returns GeoJSON.Polyline

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

• 將幾何輸出成GeoJSON字串。

  Parameters

  • toString: true

    是否把物件轉成JSON字串。

  • Optional includeZ: boolean

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

  Returns string

  輸出轉換結果。