Class MapNodeGeometry

Map node geometry is a geometry used to represent the map nodes.

Consists of a XZ plane with normals facing +Y.

The geometry points start in XZ plane that can be manipulated for example for height adjustment.

Geometry can also include skirts to mask off missalignments between tiles.

Hierarchy

  • BufferGeometry
    • MapNodeGeometry

Constructors

  • Map node geometry constructor.

    Parameters

    • width: number = 1.0

      Width of the node.

    • height: number = 1.0

      Height of the node.

    • widthSegments: number = 1.0

      Number of subdivisions along the width.

    • heightSegments: number = 1.0

      Number of subdivisions along the height.

    • skirt: boolean = false

      Skirt around the plane to mask gaps between tiles.

    • skirtDepth: number = 10.0

    Returns MapNodeGeometry

Properties

attributes: {
    [name: string]: BufferAttribute | InterleavedBufferAttribute;
}

Default

Type declaration

  • [name: string]: BufferAttribute | InterleavedBufferAttribute
boundingBox: Box3

Default

null

boundingSphere: Sphere

Default

null

drawRange: {
    count: number;
    start: number;
}

Default

Type declaration

  • count: number
  • start: number
drawcalls: any

Deprecated

Use BufferGeometry#groups .groups instead.

groups: {
    count: number;
    materialIndex?: number;
    start: number;
}[]

Default

[]

id: number

Unique number of this buffergeometry instance

index: BufferAttribute

Default

null

isBufferGeometry: true
morphAttributes: {
    [name: string]: (BufferAttribute | InterleavedBufferAttribute)[];
}

Default

Type declaration

  • [name: string]: (BufferAttribute | InterleavedBufferAttribute)[]
morphTargetsRelative: boolean

Default

false

name: string

Default

''

offsets: any

Deprecated

Use BufferGeometry#groups .groups instead.

type: string

Default

'BufferGeometry'

userData: {
    [key: string]: any;
}

Default

Type declaration

  • [key: string]: any
uuid: string

Methods

  • Deprecated

    Use BufferGeometry#setAttribute .setAttribute() instead.

    Parameters

    • name: string
    • attribute: BufferAttribute | InterleavedBufferAttribute

    Returns BufferGeometry

  • Parameters

    • name: any
    • array: any
    • itemSize: any

    Returns any

  • Deprecated

    Use BufferGeometry#addGroup .addGroup() instead.

    Parameters

    • start: any
    • count: any
    • Optional indexOffset: any

    Returns void

  • Adds a listener to an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, MapNodeGeometry>

      The function that gets called when the event is fired.

    Returns void

  • Parameters

    • start: number
    • count: number
    • Optional materialIndex: number

    Returns void

  • Deprecated

    Use BufferGeometry#setIndex .setIndex() instead.

    Parameters

    • index: any

    Returns void

  • Bakes matrix transform directly into vertex coordinates.

    Parameters

    • matrix: Matrix4

    Returns BufferGeometry

  • Parameters

    • q: Quaternion

    Returns BufferGeometry

  • Returns BufferGeometry

  • Deprecated

    Use BufferGeometry#clearGroups .clearGroups() instead.

    Returns void

  • Returns void

  • Returns BufferGeometry

  • Computes bounding box of the geometry, updating Geometry.boundingBox attribute. Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

    Returns void

  • Computes bounding sphere of the geometry, updating Geometry.boundingSphere attribute. Bounding spheres aren't' computed by default. They need to be explicitly computed, otherwise they are null.

    Returns void

  • Computes and adds tangent attribute to this geometry.

    Returns void

  • Computes vertex normals by averaging face normals.

    Returns void

  • Parameters

    • source: BufferGeometry

    Returns MapNodeGeometry

  • Parameters

    • name: BuiltinShaderAttributeName | string & {}

    Returns BufferGeometry

  • Fire an event type.

    Parameters

    • event: Event

    Returns void

  • Disposes the object from memory. You need to call this when you want the bufferGeometry removed while the application is running.

    Returns void

  • Parameters

    • name: BuiltinShaderAttributeName | string & {}

    Returns BufferAttribute | InterleavedBufferAttribute

  • Returns BufferAttribute

  • Parameters

    • name: BuiltinShaderAttributeName | string & {}

    Returns boolean

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, MapNodeGeometry>

      The function that gets called when the event is fired.

    Returns boolean

  • Parameters

    • v: Vector3

    Returns void

  • Returns void

  • Deprecated

    Use BufferGeometry#deleteAttribute .deleteAttribute() instead.

    Parameters

    • name: string

    Returns BufferGeometry

  • Removes a listener from an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<Event, T, MapNodeGeometry>

      The listener function that gets removed.

    Returns void

  • Parameters

    • angle: number

    Returns BufferGeometry

  • Parameters

    • angle: number

    Returns BufferGeometry

  • Parameters

    • angle: number

    Returns BufferGeometry

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns BufferGeometry

  • Parameters

    • name: BuiltinShaderAttributeName | string & {}
    • attribute: BufferAttribute | InterleavedBufferAttribute

    Returns BufferGeometry

  • Parameters

    • start: number
    • count: number

    Returns void

  • Parameters

    • points: Vector3[] | Vector2[]

    Returns BufferGeometry

  • Parameters

    • index: number[] | BufferAttribute

    Returns BufferGeometry

  • Returns any

  • Returns BufferGeometry

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns BufferGeometry

  • Parameters

    • width: number = 1.0
    • height: number = 1.0
    • widthSegments: number = 1.0
    • heightSegments: number = 1.0
    • indices: number[]
    • vertices: number[]
    • normals: number[]
    • uvs: number[]

    Returns void

  • Parameters

    • width: number = 1.0
    • height: number = 1.0
    • widthSegments: number = 1.0
    • heightSegments: number = 1.0
    • skirtDepth: number
    • indices: number[]
    • vertices: number[]
    • normals: number[]
    • uvs: number[]

    Returns void

Generated using TypeDoc