Interface SimpleGeometryMesh<UserData, TEvents>

Interface for meshes that represent a single OpenLayers Geometry.

interface SimpleGeometryMesh<
    UserData extends DefaultUserData = DefaultUserData,
    TEvents extends SimpleGeometryMeshEventMap = SimpleGeometryMeshEventMap,
> {
    geometryOrigin: Vector3 | undefined;
    isSimpleGeometryMesh: true;
    type: SimpleGeometryMeshTypes;
    userData: Partial<UserData>;
    set opacity(opacity: number): void;
    dispose(): void;
}

Type Parameters

UserData extends DefaultUserData = DefaultUserData
TEvents extends SimpleGeometryMeshEventMap = SimpleGeometryMeshEventMap

Hierarchy

Object3D<TEvents>
- SimpleGeometryMesh

Index

Properties

geometryOrigin

geometryOrigin: Vector3 | undefined

isSimpleGeometryMesh

isSimpleGeometryMesh: true

type

type: SimpleGeometryMeshTypes

A Read-only string to check this object type.

Remarks

This can be used to find a specific type of Object3D in a scene. Sub-classes will update this value.

Default Value

Object3D

userData

userData: Partial<UserData>

An object that can be used to store custom data about the Object3D.

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

Accessors

opacity

set opacity(opacity: number): void
Sets the opacity of the mesh. This opacity is combined with the opacity of the material.
Parameters
- opacity: number
Returns void
- Defined in renderer/geometries/SimpleGeometryMesh.ts:43

Methods

dispose

dispose(): void
Disposes the resources owned by this mesh.

Returns void
- Defined in renderer/geometries/SimpleGeometryMesh.ts:36

Interface SimpleGeometryMesh<UserData, TEvents>

Type Parameters

Hierarchy

Index

Properties

Accessors

Methods

Properties

geometryOrigin

isSimpleGeometryMesh

type

Remarks

Default Value

userData

Remarks

Default

Accessors

opacity

Parameters

Returns void

Methods

dispose

Returns void

Settings

On This Page