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>	When `true`, the entity position is relative to its parent.
`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 the entity to use the same world position as its parent.
`forceGlobalRotation`	boolean	<optional>	Forces the entity to use the same world rotation as its parent.
`forceGlobalScale`	boolean	<optional>	Forces the entity to use the same world scale as its parent.
`localPosition`	Vec3 \| NumberArray3	<optional>	Local position offset.

Source: entity/Entity.ts, line 86

Members

entityCollection

Gets current entity collection container.

Source: entity/Entity.ts, line 482

id

Returns the entity id.

Source: entity/Entity.ts, line 491

instanceName

Returns the instance class name.

Source: entity/Entity.ts, line 517

layer

Returns the assigned vector layer.

Source: entity/Entity.ts, line 1357

layerIndex

Gets the layer index of the entity.

Source: entity/Entity.ts, line 509

relativePosition

Sets whether the entity position is relative to its parent.

Source: entity/Entity.ts, line 441

relativePosition

Returns whether the entity position is relative to its parent.

Source: entity/Entity.ts, line 473

rootEntity

Returns the root entity.

Source: entity/Entity.ts, line 425

Methods

_setCartesian3vSilent(cartesian, skipLonLat)

Sets local cartesian position without dispatching events.

Parameters:

Name	Type	Default	Description
`cartesian`	Vec3		Cartesian position in 3D space.
`skipLonLat`	boolean	false	Skip geodetic conversion.

Source: entity/Entity.ts, line 1078

addTo(collection) → {Entity}

Adds the entity to a collection or vector layer.

Parameters:

Name	Type	Description
`collection`	EntityCollection \| Vector	Target collection or vector layer.

Source: entity/Entity.ts, line 541

Returns:

This object.

Type:: Entity

appendChild(entity)

Appends a child entity.

Parameters:

Name	Type	Description
`entity`	Entity	Child entity.

Source: entity/Entity.ts, line 1390

appendChildren(entities, forceRelativePositionopt)

Appends child entities.

Parameters:

Name	Type	Attributes	Description
`entities`	Array.<Entity>		Child entities.
`forceRelativePosition`	boolean	<optional>	If defined, sets `relativePosition` for each child.

Source: entity/Entity.ts, line 1375

getAbsoluteCartesian() → {Vec3}

Returns absolute cartesian position.

Source: entity/Entity.ts, line 958

Returns:

Absolute cartesian position.

Type:: Vec3

getAbsolutePitch() → {number}

Gets the absolute pitch angle of the entity.

Source: entity/Entity.ts, line 876

Returns:

The absolute pitch angle in radians.

Type:: number

getAbsoluteRoll() → {number}

Gets the absolute roll angle of the entity.

Source: entity/Entity.ts, line 901

Returns:

The absolute roll angle in radians.

Type:: number

getAbsoluteRotation() → {Quat}

Gets the absolute rotation direction of the entity.

Source: entity/Entity.ts, line 684

Returns:

The absolute rotation quaternion.

Type:: Quat

getAbsoluteYaw() → {number}

Gets the absolute yaw angle of the entity.

Source: entity/Entity.ts, line 889

Returns:

The absolute yaw angle in radians.

Type:: number

getAltitude() → {number}

Returns entity altitude over the planet.

Source: entity/Entity.ts, line 1187

Returns:

Altitude.

Type:: number

getCartesian() → {Vec3}

Returns cartesian position.

Source: entity/Entity.ts, line 1196

Returns:

Cartesian position.

Type:: Vec3

getCollectionIndex() → {number}

Gets the collection index of the entity.

Source: entity/Entity.ts, line 533

Returns:

The entity collection index.

Type:: number

getExtent() → {Extent}

Returns geodetic extent.

Source: entity/Entity.ts, line 1429

Returns:

Geodetic extent.

Type:: Extent

getLonLat() → {LonLat}

Returns geodetic coordinates.

Source: entity/Entity.ts, line 1113

Returns:

Entity geodetic coordinates.

Type:: LonLat

getOpacity() → {number}

Returns entity opacity.

Source: entity/Entity.ts, line 621

Returns:

Entity opacity.

Type:: number

getPitch() → {number}

Gets the pitch angle of the entity.

Source: entity/Entity.ts, line 807

Returns:

The pitch angle in radians.

Type:: number

getRoll() → {number}

Gets the roll angle of the entity.

Source: entity/Entity.ts, line 825

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 693

Returns:

The rotation quaternion.

Type:: Quat

getScale() → {Vec3}

Returns the local scale.

Source: entity/Entity.ts, line 648

Returns:

Type:: Vec3

getVisibility() → {boolean}

Returns entity visibility.

Source: entity/Entity.ts, line 630

Returns:

Entity visibility flag.

Type:: boolean

getYaw() → {number}

Gets the yaw angle of the entity.

Source: entity/Entity.ts, line 816

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 500

Returns:

True if entities are equal, otherwise false.

Type:: boolean

remove()

Removes the entity from its collection or layer.

Source: entity/Entity.ts, line 552

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 927

setAbsoluteCartesian3v(absolutCartesian)

Sets absolute cartesian position using a vector.

Parameters:

Name	Type	Description
`absolutCartesian`	Vec3	Absolute cartesian position.

Source: entity/Entity.ts, line 938

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 834

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 862

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 732

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 848

setAltitude(altitude)

Sets entity altitude over the planet.

Parameters:

Name	Type	Description
`altitude`	number	Altitude.

Source: entity/Entity.ts, line 1178

setBillboard(billboard) → {Billboard}

Sets entity billboard.

Parameters:

Name	Type	Description
`billboard`	Billboard	Billboard object.

Source: entity/Entity.ts, line 1205

Returns:

Assigned billboard object.

Type:: Billboard

setCartesian(x, y, z)

Sets local cartesian position.

Parameters:

Name	Type	Description
`x`	number	X coordinate in 3D space.
`y`	number	Y coordinate in 3D space.
`z`	number	Z coordinate in 3D space.

Source: entity/Entity.ts, line 971

setCartesian3v(cartesian)

Sets entity cartesian position.

Parameters:

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

Source: entity/Entity.ts, line 639

setDirectQuaternionRotation(rot)

Sets rotation directly from glTF quaternion with common coordinate system conversion. This method avoids the current pitch/yaw/roll conversion.

Parameters:

Name	Type	Description
`rot`	Quat	Quaternion from glTF.

Source: entity/Entity.ts, line 756

setGeoObject(geoObject) → {GeoObject}

Sets entity geoObject.

Parameters:

Name	Type	Description
`geoObject`	GeoObject	GeoObject.

Source: entity/Entity.ts, line 1320

Returns:

Assigned geo object.

Type:: GeoObject

setGeometry(geometry) → {Geometry}

Sets entity geometry.

Parameters:

Name	Type	Description
`geometry`	Geometry	Geometry object.

Source: entity/Entity.ts, line 1297

Returns:

Assigned geometry object.

Type:: Geometry

setLabel(label) → {Label}

Sets entity label.

Parameters:

Name	Type	Description
`label`	Label	Text label.

Source: entity/Entity.ts, line 1224

Returns:

Assigned label object.

Type:: Label

setLonLat(lonlat)

Sets geodetic coordinates.

Parameters:

Name	Type	Description
`lonlat`	LonLat	Geodetic coordinates.

Source: entity/Entity.ts, line 1122

setLonLat2(lon, lat, heightopt)

Sets geodetic coordinates.

Parameters:

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

Source: entity/Entity.ts, line 1149

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 702

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 720

setOpacity(opacity)

Sets entity opacity for all available features.

Parameters:

Name	Type	Description
`opacity`	number	Entity opacity.

Source: entity/Entity.ts, line 593

setPickingColor()

Applies entity picking color to all supported features.

Source: entity/Entity.ts, line 1405

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 776

setPointCloud(pointCloud) → {PointCloud}

Sets entity pointCloud.

Parameters:

Name	Type	Description
`pointCloud`	PointCloud	PointCloud object.

Source: entity/Entity.ts, line 1279

Returns:

Assigned point cloud object.

Type:: PointCloud

setPolyline(polyline) → {Polyline}

Sets entity polyline.

Parameters:

Name	Type	Description
`polyline`	Polyline	Polyline object.

Source: entity/Entity.ts, line 1261

Returns:

Assigned polyline object.

Type:: Polyline

setRay(ray) → {Ray}

Sets entity ray.

Parameters:

Name	Type	Description
`ray`	Ray	Ray object.

Source: entity/Entity.ts, line 1243

Returns:

Assigned ray object.

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 796

setRotation(rot)

Sets the local rotation of the entity.

Parameters:

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

Source: entity/Entity.ts, line 742

setScale(val)

Sets uniform local scale.

Parameters:

Name	Type	Description
`val`	number	Scale value.

Source: entity/Entity.ts, line 675

setScale3v(scale)

Sets per-axis local scale.

Parameters:

Name	Type	Description
`scale`	Vec3	Scale vector.

Source: entity/Entity.ts, line 657

setStrip(strip) → {Strip}

Sets entity strip.

Parameters:

Name	Type	Description
`strip`	Strip	Strip object.

Source: entity/Entity.ts, line 1339

Returns:

Assigned strip object.

Type:: Strip

setVisibility(visibility)

Sets the entity visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Entity visibility.

Source: entity/Entity.ts, line 562

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 786