Class: Polyline

Constructor#

new Polyline(optionsopt)#

Parameters:

Name Type Attributes Description

options

Object

Polyline options:

Properties

Name	Type	Attributes	Description
`thickness`	number	<optional>	Thickness in screen pixels 1.5 is default.
`altitude`	Number	<optional>	Relative to ground layers altitude value.
`color`	Vec4	<optional>	RGBA color.
`opacity`	Boolean	<optional>	Line opacity.
`visibility`	Boolean	<optional>	Polyline visibility. True default.
`isClosed`	Boolean	<optional>	Closed geometry type identification.
`pathLonLat`	Array.<SegmentPathLonLatExt>	<optional>	Polyline geodetic coordinates array. [[[0,0,0], [1,1,1],...]]
`path3v`	Array.<SegmentPath3vExt>	<optional>	LinesString cartesian coordinates array. [[[0,0,0], [1,1,1],...]]
`pathColors`	Array.<SegmentPathColor>	<optional>	Coordinates color. [[[1,0,0,1], [0,1,0,1],...]] for right and green colors.

Source: entity/Polyline.ts, line 60

Methods#

__appendLineData3v()#

Appends to the line array new cartesian coordinates line data.

Source: entity/Polyline.ts, line 260

__appendLineDataLonLat()#

Appends to the line array new geodetic coordinates line data.

Source: entity/Polyline.ts, line 774

__appendPoint3v()#

Appends to the line new cartesian coordinates point data.

Source: entity/Polyline.ts, line 482

(protected) _createIndexBuffer()#

Creates gl index and order buffer.

Source: entity/Polyline.ts, line 2280

(protected) _createVerticesBuffer()#

Creates vertices buffers.

Source: entity/Polyline.ts, line 2257

_deleteBuffers()#

Clear GL buffers.

Source: entity/Polyline.ts, line 2234

(protected) _refresh()#

Refresh buffers.

Source: entity/Polyline.ts, line 2207

(protected) _setEqualPath3v(path3v)#

Sets polyline path with cartesian coordinates.

Parameters:

Name	Type	Description
`path3v`	Array.<SegmentPath3vExt>	Cartesian coordinates.

Source: entity/Polyline.ts, line 1010

(protected) _setEqualPathLonLat(pathLonLat)#

Sets polyline with geodetic coordinates.

Parameters:

Name	Type	Description
`pathLonLat`	Array.<SegmentPathLonLat>	Geodetic polyline path coordinates.

Source: entity/Polyline.ts, line 1172

(protected) _update()#

Updates render buffers.

Source: entity/Polyline.ts, line 2218

addPoint3v(point3v, multiLineIndexopt)#

Append new point in the end of the path.

Parameters:

Name	Type	Attributes	Default	Description
`point3v`	Vec3			New point coordinates.
`multiLineIndex`	number	<optional>	0	Path segment index, first by default.

Source: entity/Polyline.ts, line 1662

addPointLonLat(lonLat, multiLineIndexopt)#

Append new geodetic point in the end of the path.

Parameters:

Name	Type	Attributes	Default	Description
`lonLat`	LonLat			New coordinate.
`multiLineIndex`	number	<optional>	0	Path segment index, first by default.

Source: entity/Polyline.ts, line 1679

appendPoint3v(point3v, coloropt, skipEllipsoidopt)#

Adds a new cartesian point in the end of the path in a last line segment.

Parameters:

Name	Type	Attributes	Description
`point3v`	Vec3		New coordinates.
`color`	NumberArray4	<optional>
`skipEllipsoid`	boolean	<optional>

Source: entity/Polyline.ts, line 1616

clear()#

Clear polyline data.

Source: entity/Polyline.ts, line 1696

getExtent() → {Extent}#

Returns polyline geodetic extent.

Source: entity/Polyline.ts, line 1942

Returns:

Geodetic extent

Type:: Extent

getOpacity(opacity)#

Gets polyline opacity.

Parameters:

Name	Type	Description
`opacity`	number	Opacity.

Source: entity/Polyline.ts, line 1761

getPath3v() → {Array.<SegmentPath3vExt>}#

Returns path cartesian coordinates.

Source: entity/Polyline.ts, line 1951

Returns:

Polyline path.

Type:: Array.<SegmentPath3vExt>

getPathLonLat() → {Array.<SegmentPathLonLatExt>}#

Returns geodetic path coordinates.

Source: entity/Polyline.ts, line 1959

Returns:

Polyline path.

Type:: Array.<SegmentPathLonLatExt>

getThickness() → {number}#

Returns thickness.

Source: entity/Polyline.ts, line 1788

Returns:

Thickness in screen pixels.

Type:: number

getVisibility() → {boolean}#

Gets Polyline visibility.

Source: entity/Polyline.ts, line 1806

Returns:

Polyline visibility.

Type:: boolean

insertPoint3v(point3v, indexopt, coloropt, multilineIndexopt)#

Insert point coordinates in a path segment

Parameters:

Name	Type	Attributes	Default	Description
`point3v`	Vec3			Point coordinates
`index`	number	<optional>	0	Index in the path
`color`	NumberArray4	<optional>		Point color
`multilineIndex`	number	<optional>	0	Path segment index

Source: entity/Polyline.ts, line 1587

remove()#

Removes from an entity.

Source: entity/Polyline.ts, line 1904

removePoint(index, multiLineIndexopt)#

Remove point from the path

Parameters:

Name	Type	Attributes	Default	Description
`index`	number			Point index in a path segment
`multiLineIndex`	number	<optional>	0	Segment path index

Source: entity/Polyline.ts, line 1574

removeSegment(index)#

Remove path segment

Parameters:

Name	Type	Description
`index`	number	Path segment index

Source: entity/Polyline.ts, line 1565

setAltitude(thickness)#

Sets Polyline thickness in screen pixels.

Parameters:

Name	Type	Description
`thickness`	number	Thickness.

Source: entity/Polyline.ts, line 1779

setColorHTML(htmlColor-)#

Sets polyline color

Parameters:

Name	Type	Description
`htmlColor-`	string	HTML color

Source: entity/Polyline.ts, line 1991

setOpacity(opacity)#

Sets polyline opacity.

Parameters:

Name	Type	Description
`opacity`	number	Opacity.

Source: entity/Polyline.ts, line 1752

setPath3v(path3v, pathColorsopt, forceEqualopt)#

Sets Polyline cartesian coordinates.

Parameters:

Name	Type	Attributes	Default	Description
`path3v`	Array.<SegmentPath3vExt>			Polyline path cartesian coordinates. (exactly 3 entries)
`pathColors`	Array.<SegmentPathColor>	<optional>		Polyline path cartesian coordinates. (exactly 3 entries)
`forceEqual`	Boolean	<optional>	false	Makes assigning faster for size equal coordinates array.

Source: entity/Polyline.ts, line 2062

setPathColors(pathColors)#

Sets polyline colors.

Parameters:

Name	Type	Description
`pathColors`	Array.<Array.<NumberArray4>>

Source: entity/Polyline.ts, line 1971
To Do: - Test the function.

setPathLonLat(pathLonLat, forceEqualopt)#

Sets polyline geodetic coordinates.

Parameters:

Name	Type	Attributes	Default	Description
`pathLonLat`	Array.<SegmentPathLonLat>			Polyline path cartesian coordinates.
`forceEqual`	Boolean	<optional>	false	OPTIMIZATION FLAG: Makes assigning faster for size equal coordinates array.

Source: entity/Polyline.ts, line 2030

setPoint3v(coordinates, indexopt, segmentIndexopt, skipLonLatopt)#

Changes cartesian point coordinates of the path

Parameters:

Name	Type	Attributes	Default	Description
`coordinates`	Vec3			New coordinates
`index`	number	<optional>	0	Path segment index
`segmentIndex`	number	<optional>	0	Index of the point in the path segment
`skipLonLat`	boolean	<optional>	false	Do not update geodetic coordinates

Source: entity/Polyline.ts, line 1367

setPointColor(color, indexopt, segmentIndexopt)#

Change path point color

Parameters:

Name	Type	Attributes	Default	Description
`color`	NumberArray4			New color
`index`	number	<optional>	0	Point index
`segmentIndex`	number	<optional>	0	Path segment index

Source: entity/Polyline.ts, line 1704

setRenderNode(renderNode)#

Assign with render node.

Parameters:

Name	Type	Description
`renderNode`	RenderNode

Source: entity/Polyline.ts, line 1815

setThickness(thickness)#

Sets Polyline thickness in screen pixels.

Parameters:

Name	Type	Description
`thickness`	number	Thickness.

Source: entity/Polyline.ts, line 1779

setVisibility(visibility)#

Sets visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Polyline visibility.

Source: entity/Polyline.ts, line 1797