On this page

GeoObject

Represents 3D object on the the globe or 3d space

Constructor

new GeoObject(options)

Parameters:

Name Type Description

options

IGeoObjectParams

Geo object parameters:

Properties

Name	Type	Attributes	Default	Description
`object3d`	Object3d	<optional>		3D object associated with the geo object.
`objSrc`	string	<optional>		Source url of the 3D object.
`tag`	string	<optional>		Unique instancing drawing identifier tag.
`position`	Vec3 \| NumberArray3	<optional>		Position in Cartesian coordinates.
`scale`	number \| Vec3 \| NumberArray3	<optional>	1	Scale of the object.
`translate`	Vec3 \| NumberArray3	<optional>		Translation offset.
`color`	Vec4 \| NumberArray4 \| string	<optional>		RGBA color or HTML color string.
`visibility`	boolean	<optional>	true	Visibility flag.

Source: entity/geoObject/GeoObject.ts, line 35

Members

indices

Gets geometry mesh indices.

Source: entity/geoObject/GeoObject.ts, line 207

normals

Gets geometry mesh normals.

Source: entity/geoObject/GeoObject.ts, line 189

object3d

Gets the 3D object associated with this geo object.

Source: entity/geoObject/GeoObject.ts, line 171

tag

Gets the unique tag of the geo object.

Source: entity/geoObject/GeoObject.ts, line 154

texCoords

Gets geometry mesh texture coordinates.

Source: entity/geoObject/GeoObject.ts, line 198

vertices

Gets geometry mesh vertices.

Source: entity/geoObject/GeoObject.ts, line 180

Methods

getDirection() → {Vec3}

Returns object direction

Source: entity/geoObject/GeoObject.ts, line 438

Returns:

Type:: Vec3

getLocalPosition() → {Vec3}

Gets local offset position.

Source: entity/geoObject/GeoObject.ts, line 384

Returns:

Type:: Vec3

getOpacity() → {number}

Gets the opacity of the geo object.

Source: entity/geoObject/GeoObject.ts, line 225

Returns:

Type:: number

getPosition() → {Vec3}

Gets the position of the geo object.

Source: entity/geoObject/GeoObject.ts, line 162

Returns:

Type:: Vec3

getRotation() → {Quat}

Returns orientation quaternion.

Source: entity/geoObject/GeoObject.ts, line 422

Returns:

Type:: Quat

getScale() → {Vec3}

Gets scale.

Source: entity/geoObject/GeoObject.ts, line 357

Returns:

Type:: Vec3

getVisibility() → {boolean}

Returns geo object visibility.

Source: entity/geoObject/GeoObject.ts, line 271

Returns:

Type:: boolean

remove()

Removes the geo object from the handler.

Source: entity/geoObject/GeoObject.ts, line 393

setColor(r, g, b, aopt)

Sets the color of the geo object.

Parameters:

Name	Type	Attributes	Description
`r`	number		Red component.
`g`	number		Green component.
`b`	number		Blue component.
`a`	number	<optional>	Alpha component.

Source: entity/geoObject/GeoObject.ts, line 233

setColor4v(color)

Sets color.

Parameters:

Name	Type	Description
`color`	Vec3 \| Vec4	RGBA vector.

Source: entity/geoObject/GeoObject.ts, line 248

setColorHTML(color)

Sets object HTML color.

Parameters:

Name	Type	Description
`color`	string

Source: entity/geoObject/GeoObject.ts, line 329

setLocalPosition3v(localPosition)

Sets local offset position.

Parameters:

Name	Type	Description
`localPosition`	Vec3

Source: entity/geoObject/GeoObject.ts, line 375

setObject(object)

Sets Object3d for the object

Parameters:

Name	Type	Description
`object`	Object3d

Source: entity/geoObject/GeoObject.ts, line 312

setObjectSrc(src)

Sets the object url source.

Parameters:

Name	Type	Description
`src`	string

Source: entity/geoObject/GeoObject.ts, line 320

setOpacity(a)

Sets the opacity of the geo object.

Parameters:

Name	Type	Description
`a`	number	Opacity value (0 to 1).

Source: entity/geoObject/GeoObject.ts, line 216

setPickingColor3v(color)

Sets billboard picking color.

Parameters:

Name	Type	Description
`color`	Vec3	Picking color.

Source: entity/geoObject/GeoObject.ts, line 402

setPosition(x, y, z)

Sets geo object position.

Parameters:

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

Source: entity/geoObject/GeoObject.ts, line 280

setPosition3v(position)

Sets geo object position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Source: entity/geoObject/GeoObject.ts, line 303

setRotation(qRot)

Sets the rotation quaternion.

Parameters:

Name	Type	Description
`qRot`	Quat	Rotation quaternion.

Source: entity/geoObject/GeoObject.ts, line 411

setScale(scale)

Sets scales.

Parameters:

Name	Type	Description
`scale`	number

Source: entity/geoObject/GeoObject.ts, line 337

setScale3v(scale)

Sets X, Y, Z axis scales

Parameters:

Name	Type	Description
`scale`	Vec3

Source: entity/geoObject/GeoObject.ts, line 347

setVisibility(visibility)

Sets geo object visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Visibility flag.

Source: entity/geoObject/GeoObject.ts, line 261

updateRotation()

Update object rotation

Source: entity/geoObject/GeoObject.ts, line 431