Class: Entity

Constructor

new Entity(optionsopt)

Parameters:

Name Type Attributes Description

options

IEntityParams

Entity options:

Properties

Name	Type	Attributes	Description
`name`	string	<optional>	Name of the entity.
`properties`	any	<optional>	Additional properties of the entity.
`cartesian`	Vec3 \| NumberArray3	<optional>	Cartesian position.
`lonlat`	LonLat \| NumberArray3 \| NumberArray2	<optional>	Geographic coordinates.
`altitude`	number	<optional>	Altitude.
`visibility`	boolean	<optional>	Visibility flag.
`billboard`	Billboard \| IBillboardParams	<optional>	Billboard object or parameters.
`label`	Label \| ILabelParams	<optional>	Label object or parameters.
`polyline`	Polyline \| IPolylineParams	<optional>	Polyline object or parameters.
`ray`	Ray \| IRayParams	<optional>	Ray object or parameters.
`pointCloud`	PointCloud \| IPointCloudParams	<optional>	Point cloud object or parameters.
`geometry`	Geometry \| IGeometryParams	<optional>	Geometry object or parameters.
`geoObject`	GeoObject \| IGeoObjectParams	<optional>	Geo object or parameters.
`strip`	Strip \| IStripParams	<optional>	Strip object or parameters.
`independentPicking`	boolean	<optional>	Independent picking flag.
`relativePosition`	boolean	<optional>	Parent relative position flag, otherwise position is absolute.
`pitch`	number	<optional>	Rotation around local X-axis in radians.
`yaw`	number	<optional>	Rotation around local Y-axis in radians.
`roll`	number	<optional>	Rotation around local Z-axis in radians.
`scale`	number \| Vec3 \| NumberArray3	<optional>	Scaling factor.
`forceGlobalPosition`	boolean	<optional>	Forces global position for the entity make the same position as its parent.
`forceGlobalRotation`	boolean	<optional>	Forces global rotation for the entity make the same rotation as its parent.
`forceGlobalScale`	boolean	<optional>	Forces global scale for the entity make the same scale as its parent.

Source: entity/Entity.ts, line 86

Members

entityCollection

Gets current entity collection container.

Source: entity/Entity.ts, line 452

id

Gets entity uniq id

Source: entity/Entity.ts, line 461

instanceName

Gets the instance class name of the entity.

Source: entity/Entity.ts, line 487

layer

Gets layer container

Source: entity/Entity.ts, line 1258

layerIndex

Gets the layer index of the entity.

Source: entity/Entity.ts, line 479

relativePosition

Sets relative position property

Source: entity/Entity.ts, line 409

relativePosition

Gets relative position property

Source: entity/Entity.ts, line 443

rootEntity

Returns root entity object.

Source: entity/Entity.ts, line 393

Methods

_setCartesian3vSilent(cartesian, skipLonLat)

Sets entity cartesian position without event dispatching.

Parameters:

Name	Type	Default	Description
`cartesian`	Vec3		Cartesian position in 3d space.
`skipLonLat`	boolean	false	skip geodetic calculation.

Source: entity/Entity.ts, line 987

addTo(collection, rightNowopt) → {Entity}

Adds current entity into the specified entity collection.

Parameters:

Name	Type	Attributes	Default	Description
`collection`	EntityCollection \| Vector			Specified entity collection or vector layer.
`rightNow`	boolean	<optional>	false	Entity insertion option for vector layer.

Source: entity/Entity.ts, line 514

Returns:

This object.

Type:: Entity

appendChild(entity)

Append child entity.

Parameters:

Name	Type	Description
`entity`	Entity	Child entity.

Source: entity/Entity.ts, line 1276

getAbsoluteCartesian() → {Vec3}

Returns absolute cartesian position.

Source: entity/Entity.ts, line 881

Returns:

Type:: Vec3

getAbsolutePitch() → {number}

Gets the absolute pitch angle of the entity.

Source: entity/Entity.ts, line 802

Returns:

The absolute pitch angle in radians.

Type:: number

getAbsoluteRoll() → {number}

Gets the absolute roll angle of the entity.

Source: entity/Entity.ts, line 827

Returns:

The absolute roll angle in radians.

Type:: number

getAbsoluteRotation() → {Quat}

Gets the absolute rotation direction of the entity.

Source: entity/Entity.ts, line 635

Returns:

The absolute rotation quaternion.

Type:: Quat

getAbsoluteYaw() → {number}

Gets the absolute yaw angle of the entity.

Source: entity/Entity.ts, line 815

Returns:

The absolute yaw angle in radians.

Type:: number

getAltitude() → {number}

Sets entity altitude over the planet.

Source: entity/Entity.ts, line 1097

Returns:

Altitude.

Type:: number

getCartesian() → {Vec3}

Returns cartesian position.

Source: entity/Entity.ts, line 1106

Returns:

Type:: Vec3

getCollectionIndex() → {number}

Gets the collection index of the entity.

Source: entity/Entity.ts, line 506

Returns:

The entity collection index.

Type:: number

getExtent() → {Extent}

Return geodetic extent.

Source: entity/Entity.ts, line 1315

Returns:

Type:: Extent

getLonLat() → {LonLat}

Gets entity geodetic coordinates.

Source: entity/Entity.ts, line 1023

Returns:

Type:: LonLat

getPitch() → {number}

Gets the pitch angle of the entity.

Source: entity/Entity.ts, line 733

Returns:

The pitch angle in radians.

Type:: number

getRoll() → {number}

Gets the roll angle of the entity.

Source: entity/Entity.ts, line 751

Returns:

The roll angle in radians.

Type:: number

getRotation() → {Quat}

Gets the local rotation of the entity. For the root entity it is equal to the absolute rotation.

Source: entity/Entity.ts, line 644

Returns:

The rotation quaternion.

Type:: Quat

getScale() → {Vec3}

Gets scale factor

Source: entity/Entity.ts, line 584

Returns:

Type:: Vec3

getVisibility() → {boolean}

Returns entity visibility.

Source: entity/Entity.ts, line 566

Returns:

Type:: boolean

getYaw() → {number}

Gets the yaw angle of the entity.

Source: entity/Entity.ts, line 742

Returns:

The yaw angle in radians.

Type:: number

isEqual(entity) → {boolean}

Checks if the given entity is equal to the current entity.

Parameters:

Name	Type	Description
`entity`	Entity	The entity to compare.

Source: entity/Entity.ts, line 470

Returns:

True if entities are equal, otherwise false.

Type:: boolean

remove()

Removes current entity from its collection or layer.

Source: entity/Entity.ts, line 526

setAbsoluteCartesian(x, y, z)

Sets the absolute cartesian position of the entity.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Source: entity/Entity.ts, line 853

setAbsoluteCartesian3v(absolutCartesian)

Sets the absolute cartesian position of the entity using a Vec3.

Parameters:

Name	Type	Description
`absolutCartesian`	Vec3	The absolute cartesian position.

Source: entity/Entity.ts, line 864

setAbsolutePitch(val)

Sets the absolute pitch of the entity.

Parameters:

Name	Type	Description
`val`	number	The absolute pitch angle in radians.

Source: entity/Entity.ts, line 760

setAbsoluteRoll(val)

Sets the absolute roll of the entity.

Parameters:

Name	Type	Description
`val`	number	The absolute roll angle in radians.

Source: entity/Entity.ts, line 788

setAbsoluteRotation(rot)

Sets the absolute rotation of the entity.

Parameters:

Name	Type	Description
`rot`	Quat	The new absolute rotation quaternion.

Source: entity/Entity.ts, line 684

setAbsoluteYaw(val)

Sets the absolute yaw of the entity.

Parameters:

Name	Type	Description
`val`	number	The absolute yaw angle in radians.

Source: entity/Entity.ts, line 774

setAltitude(altitude)

Sets entity altitude over the planet.

Parameters:

Name	Type	Description
`altitude`	number	Altitude.

Source: entity/Entity.ts, line 1088

setBillboard(billboard) → {Billboard}

Sets entity billboard.

Parameters:

Name	Type	Description
`billboard`	Billboard	Billboard object.

Source: entity/Entity.ts, line 1115

Returns:

Type:: Billboard

setCartesian(x, y, z)

Sets entity cartesian position.

Parameters:

Name	Type	Description
`x`	number	3d space X - position.
`y`	number	3d space Y - position.
`z`	number	3d space Z - position.

Source: entity/Entity.ts, line 894

setCartesian3v(cartesian)

Sets entity cartesian position.

Parameters:

Name	Type	Description
`cartesian`	Vec3	Cartesian position in 3d space.

Source: entity/Entity.ts, line 575

setGeoObject(geoObject) → {GeoObject}

Sets entity geoObject.

Parameters:

Name	Type	Description
`geoObject`	GeoObject	GeoObject.

Source: entity/Entity.ts, line 1223

Returns:

Type:: GeoObject

setGeometry(geometry) → {Geometry}

Sets entity geometry.

Parameters:

Name	Type	Description
`geometry`	Geometry	Geometry object.

Source: entity/Entity.ts, line 1202

Returns:

Type:: Geometry

setLabel(label) → {Label}

Sets entity label.

Parameters:

Name	Type	Description
`label`	Label	Text label.

Source: entity/Entity.ts, line 1133

Returns:

Type:: Label

setLonLat(lonlat)

Sets geodetic coordinates of the entity point object.

Parameters:

Name	Type	Description
`lonlat`	LonLat	coordinates.

Source: entity/Entity.ts, line 1032

setLonLat2(lon, lat, heightopt)

Sets geodetic coordinates of the entity point object.

Parameters:

Name	Type	Attributes	Description
`lon`	number		Longitude.
`lat`	number		Latitude
`height`	number	<optional>	Height

Source: entity/Entity.ts, line 1059

setLook3v(cart)

Rotates the entity to look at a given point in world coordinates.

Parameters:

Name	Type	Description
`cart`	Vec3	The target position to look at.

Source: entity/Entity.ts, line 653

setLookLonLat(lonLat)

Rotates the entity to look at a given geographic coordinate.

Parameters:

Name	Type	Description
`lonLat`	LonLat	The longitude and latitude to look at.

Source: entity/Entity.ts, line 672

setPickingColor()

Appends entity items(billboard, label etc.) picking color.

Source: entity/Entity.ts, line 1291

setPitch(val)

Sets the pitch rotation of the entity.

Parameters:

Name	Type	Description
`val`	number	The new pitch angle in radians.

Source: entity/Entity.ts, line 705

setPointCloud(pointCloud) → {PointCloud}

Sets entity pointCloud.

Parameters:

Name	Type	Description
`pointCloud`	PointCloud	PointCloud object.

Source: entity/Entity.ts, line 1185

Returns:

Type:: PointCloud

setPolyline(polyline) → {Polyline}

Sets entity polyline.

Parameters:

Name	Type	Description
`polyline`	Polyline	Polyline object.

Source: entity/Entity.ts, line 1168

Returns:

Type:: Polyline

setRay(ray) → {Ray}

Sets entity ray.

Parameters:

Name	Type	Description
`ray`	Ray	Ray object.

Source: entity/Entity.ts, line 1151

Returns:

Type:: Ray

setRoll(val)

Sets the roll rotation of the entity.

Parameters:

Name	Type	Description
`val`	number	The new roll angle in radians.

Source: entity/Entity.ts, line 723

setRotation(rot)

Sets the local rotation of the entity.

Parameters:

Name	Type	Description
`rot`	Quat	The new rotation quaternion.

Source: entity/Entity.ts, line 694

setScale(val)

Sets scale for the inner object such as GeoObject

Parameters:

Name	Type	Description
`val`	number	Scale factor

Source: entity/Entity.ts, line 614

setScale3v(scale)

Sets XYZ axis scale for the inner object such as GeoObject

Parameters:

Name	Type	Description
`scale`	Vec3	Scale factor

Source: entity/Entity.ts, line 593

setStrip(strip) → {Strip}

Sets entity strip.

Parameters:

Name	Type	Description
`strip`	Strip	Strip object.

Source: entity/Entity.ts, line 1241

Returns:

Type:: Strip

setVisibility(visibility)

Sets the entity visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Entity visibility.

Source: entity/Entity.ts, line 535

setYaw(val)

Sets the yaw rotation of the entity.

Parameters:

Name	Type	Description
`val`	number	The new yaw angle in radians.

Source: entity/Entity.ts, line 714