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`	string \| Array.<string>	<optional>	Default line color or per-segment HTML colors.
`opacity`	Boolean	<optional>	Line opacity.
`visibility`	Boolean	<optional>	Polyline visibility. True default.
`isClosed`	Array.<Boolean>	<optional>	Closed geometry type identification, per-segment.
`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.
`texParams`	TexParam	<optional>	Texture params for all segments: texOffset, strokeSize and texOffsetSpeed.

Source: entity/polyline/Polyline.ts, line 46

Members

isClosed

Set closed/open state for one path segment.

Source: entity/polyline/Polyline.ts, line 412

Methods

addPoint3v(point3v, segmentIndexopt, coloropt)

Append new point in the end of the path.

Parameters:

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

Source: entity/polyline/Polyline.ts, line 530

addPointLonLat(lonLat, segmentIndexopt, coloropt)

Append new geodetic point in the end of the path.

Parameters:

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

Source: entity/polyline/Polyline.ts, line 557

clear()

Clear polyline data.

Source: entity/polyline/Polyline.ts, line 946

getOpacity()

Gets polyline opacity.

Source: entity/polyline/Polyline.ts, line 813

getVisibility() → {boolean}

Gets Polyline visibility.

Source: entity/polyline/Polyline.ts, line 895

Returns:

Polyline visibility.

Type:: boolean

insertPoint3v(point3v, indexopt, coloropt, segmentIndexopt)

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
`segmentIndex`	number	<optional>	0	Path segment index

Source: entity/polyline/Polyline.ts, line 503

remove()

Removes from an entity.

Source: entity/polyline/Polyline.ts, line 958

removePath(index)

Remove multiline path segment

Parameters:

Name	Type	Description
`index`	number	Segment index in multiline

Source: entity/polyline/Polyline.ts, line 599

removePoint(index, segmentIndexopt)

Remove point from the path

Parameters:

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

Source: entity/polyline/Polyline.ts, line 472

setAltitude(altitude)

Sets Polyline thickness in screen pixels.

Parameters:

Name	Type	Description
`altitude`	number	ALtitude value.

Source: entity/polyline/Polyline.ts, line 821

setColor(htmlColor)

Sets polyline segment color.

Parameters:

Name	Type	Description
`htmlColor`	string	HTML color.

Source: entity/polyline/Polyline.ts, line 848

setColorHTML(htmlColor)

Sets polyline color

Parameters:

Name	Type	Description
`htmlColor`	string	HTML color.

Source: entity/polyline/Polyline.ts, line 931

setOpacity(opacity)

Sets polyline opacity.

Parameters:

Name	Type	Description
`opacity`	number	Opacity.

Source: entity/polyline/Polyline.ts, line 781

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/Polyline.ts, line 673

setPathLonLat(pathLonLat, pathColors, forceEqualopt)

Sets polyline geodetic coordinates.

Parameters:

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

Source: entity/polyline/Polyline.ts, line 726

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/Polyline.ts, line 452

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/Polyline.ts, line 584

setSrc()

Sets stroke source per segment (null = color-only).

Source: entity/polyline/Polyline.ts, line 376

setThickness(thickness)

Sets Polyline thickness in screen pixels.

Parameters:

Name	Type	Description
`thickness`	number	Thickness.

Source: entity/polyline/Polyline.ts, line 834

setVisibility(visibility)

Sets visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Polyline visibility.

Source: entity/polyline/Polyline.ts, line 886