Class FeaturePointsGeometry

Hierarchy

  • BufferGeometry
    • FeaturePointsGeometry

Constructors

constructor

Methods

addEventListener addGroup applyMatrix4 applyQuaternion center clearGroups clone computeBoundingBox computeBoundingSphere computeTangents computeVertexNormals copy deleteAttribute dispatchEvent dispose getAttribute getIndex hasAttribute hasEventListener lookAt normalizeNormals removeEventListener rotateX rotateY rotateZ scale setAttribute setDrawRange setFromPoints setIndex toJSON toNonIndexed translate update

Properties

attributes boundingBox boundingSphere drawRange groups id index isBufferGeometry morphAttributes morphTargetsRelative name type userData uuid

Constructors

constructor

Methods

addEventListener

  • addEventListener<T>(type, listener): 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, FeaturePointsGeometry>

      The function that gets called when the event is fired.

    Returns void

addGroup

  • addGroup(start, count, materialIndex?): void

  • Adds a group to this geometry

    Parameters

    • start: number
    • count: number
    • OptionalmaterialIndex: number

    Returns void

    See

    the groups property for details.

applyMatrix4

  • applyMatrix4(matrix): this

  • Applies the matrix transform to the geometry.

    Parameters

    • matrix: Matrix4

    Returns this

applyQuaternion

  • applyQuaternion(quaternion): this

  • Applies the rotation represented by the quaternion to the geometry.

    Parameters

    • quaternion: Quaternion

    Returns this

center

  • center(): this

  • Center the geometry based on the bounding box.

    Returns this

clearGroups

  • clearGroups(): void

  • Clears all groups.

    Returns void

clone

  • clone(): this

  • Creates a clone of this BufferGeometry

    Returns this

computeBoundingBox

  • computeBoundingBox(): void

  • Computes bounding box of the geometry, updating .boundingBox attribute.

    Returns void

    Remarks

    Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

computeBoundingSphere

  • computeBoundingSphere(): void

  • Computes bounding sphere of the geometry, updating .boundingSphere attribute.

    Returns void

    Remarks

    bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

computeTangents

  • computeTangents(): void

  • Calculates and adds a tangent attribute to this geometry. The computation is only supported for indexed geometries and if position, normal, and uv attributes are defined

    Returns void

    Remarks

    When using a tangent space normal map, prefer the MikkTSpace algorithm provided by BufferGeometryUtils.computeMikkTSpaceTangents instead.

computeVertexNormals

  • computeVertexNormals(): void

  • Computes vertex normals by averaging face normals.

    Returns void

copy

  • copy(source): this

  • Copies another BufferGeometry to this BufferGeometry.

    Parameters

    • source: BufferGeometry

    Returns this

deleteAttribute

  • deleteAttribute(name): BufferGeometry

  • Deletes the attribute with the specified name.

    Parameters

    • name: BuiltinShaderAttributeName | string & {}

    Returns BufferGeometry

dispatchEvent

  • dispatchEvent(event): void

  • Fire an event type.

    Parameters

    • event: Event

      The event that gets fired.

    Returns void

dispose

  • dispose(): void

  • Frees the GPU-related resources allocated by this instance.

    Returns void

    Remarks

    Call this method whenever this instance is no longer used in your app.

getAttribute

  • getAttribute(name): InterleavedBufferAttribute | BufferAttribute | GLBufferAttribute

  • Returns the attribute with the specified name.

    Parameters

    • name: BuiltinShaderAttributeName | string & {}

    Returns InterleavedBufferAttribute | BufferAttribute | GLBufferAttribute

getIndex

  • getIndex(): null | BufferAttribute

  • Return the .index buffer.

    Returns null | BufferAttribute

hasAttribute

  • hasAttribute(name): boolean

  • Returns true if the attribute with the specified name exists.

    Parameters

    • name: BuiltinShaderAttributeName | string & {}

    Returns boolean

hasEventListener

  • hasEventListener<T>(type, listener): 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, FeaturePointsGeometry>

      The function that gets called when the event is fired.

    Returns boolean

lookAt

  • lookAt(vector): this

  • Rotates the geometry to face a point in space.

    Parameters

    • vector: Vector3

      A world vector to look at.

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

normalizeNormals

  • normalizeNormals(): void

  • Every normal vector in a geometry will have a magnitude of 1

    Returns void

    Remarks

    This will correct lighting on the geometry surfaces.

removeEventListener

  • removeEventListener<T>(type, listener): void

  • 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, FeaturePointsGeometry>

      The listener function that gets removed.

    Returns void

rotateX

  • rotateX(angle): this

  • Rotate the geometry about the X axis. This is typically done as a one time operation, and not during a loop.

    Parameters

    • angle: number

      radians. Expects a Float

    Returns this

    Remarks

    Use Object3D.rotation for typical real-time mesh rotation.

rotateY

  • rotateY(angle): this

  • Rotate the geometry about the Y axis.

    Parameters

    • angle: number

      radians. Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

rotateZ

  • rotateZ(angle): this

  • Rotate the geometry about the Z axis.

    Parameters

    • angle: number

      radians. Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

scale

  • scale(x, y, z): this

  • Scale the geometry data.

    Parameters

    • x: number

      Expects a Float

    • y: number

      Expects a Float

    • z: number

      Expects a Float

    Returns this

    Remarks

    This is typically done as a one time operation, and not during a loop.

setAttribute

  • setAttribute(name, attribute): this

  • Sets an attribute to this geometry with the specified name.

    Parameters

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

    Returns this

    Remarks

    Use this rather than the attributes property, because an internal hashmap of .attributes is maintained to speed up iterating over attributes.

setDrawRange

  • setDrawRange(start, count): void

  • Set the .drawRange property

    Parameters

    • start: number
    • count: number

      is the number of vertices or indices to render. Expects a Integer

    Returns void

    Remarks

    For non-indexed BufferGeometry, count is the number of vertices to render

setFromPoints

  • setFromPoints(points): this

  • Sets the attributes for this BufferGeometry from an array of points.

    Parameters

    • points: Vector3[] | Vector2[]

    Returns this

setIndex

  • setIndex(index): this

  • Set the .index buffer.

    Parameters

    • index: null | number[] | BufferAttribute

    Returns this

toJSON

  • toJSON(): {}

  • Convert the buffer geometry to three.js JSON Object/Scene format.

    Returns {}

    toNonIndexed

    • toNonIndexed(): BufferGeometry

    • Return a non-index version of an indexed BufferGeometry.

      Returns BufferGeometry

    translate

    • translate(x, y, z): this

    • Translate the geometry.

      Parameters

      • x: number

        Expects a Float

      • y: number

        Expects a Float

      • z: number

        Expects a Float

      Returns this

      Remarks

      This is typically done as a one time operation, and not during a loop.

    update

    Properties

    attributes

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

    This hashmap has as id the name of the attribute to be set and as value the THREE.BufferAttribute | buffer to set it to. Rather than accessing this property directly, use .setAttribute and .getAttribute to access attributes of this geometry.

    Default Value

    {}

    boundingBox

    boundingBox: null | Box3

    Bounding box for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingBox().

    Remarks

    Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

    Default Value

    null

    boundingSphere

    boundingSphere: null | Sphere

    Bounding sphere for the THREE.BufferGeometry | BufferGeometry, which can be calculated with .computeBoundingSphere().

    Remarks

    bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.

    Default Value

    null

    drawRange

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

    Determines the part of the geometry to render. This should not be set directly, instead use .setDrawRange(...).

    Remarks

    For non-indexed THREE.BufferGeometry | BufferGeometry, count is the number of vertices to render.

    Default Value

    { start: 0, count: Infinity }

    groups

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

    Split the geometry into groups, each of which will be rendered in a separate WebGL draw call. This allows an array of materials to be used with the geometry.

    Type declaration

    • count: number

      Specifies how many vertices (or indices) are included.

      Remarks

      Expects a Integer

    • OptionalmaterialIndex?: number

      Specifies the material array index to use.

      Remarks

      Expects a Integer

    • start: number

      Specifies the first element in this draw call – the first vertex for non-indexed geometry, otherwise the first triangle index.

      Remarks

      Expects a Integer

    Remarks

    Every vertex and index must belong to exactly one group — groups must not share vertices or indices, and must not leave vertices or indices unused.

    Default Value

    []

    id

    id: number

    Unique number for this THREE.BufferGeometry | BufferGeometry instance.

    Remarks

    Expects a Integer

    index

    index: null | BufferAttribute

    Allows for vertices to be re-used across multiple triangles; this is called using "indexed triangles". Each triangle is associated with the indices of three vertices. This attribute therefore stores the index of each vertex for each triangular face. If this attribute is not set, the THREE.WebGLRenderer | renderer assumes that each three contiguous positions represent a single triangle.

    Default Value

    null

    ReadonlyisBufferGeometry

    isBufferGeometry: true

    Read-only flag to check if a given object is of type BufferGeometry.

    Remarks

    This is a constant value

    Default Value

    true

    morphAttributes

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

    Hashmap of THREE.BufferAttribute | BufferAttributes holding details of the geometry's morph targets.

    Remarks

    Once the geometry has been rendered, the morph attribute data cannot be changed. You will have to call .dispose(), and create a new instance of THREE.BufferGeometry | BufferGeometry.

    Default Value

    {}

    morphTargetsRelative

    morphTargetsRelative: boolean

    Used to control the morph target behavior; when set to true, the morph target data is treated as relative offsets, rather than as absolute positions/normals.

    Default Value

    false

    name

    name: string

    Optional name for this THREE.BufferGeometry | BufferGeometry instance.

    Default Value

    ''

    Readonlytype

    type: string

    A Read-only string to check if this object type.

    Remarks

    Sub-classes will update this value.

    Default Value

    BufferGeometry

    userData

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

    An object that can be used to store custom data about the BufferGeometry. It should not hold references to functions as these will not be cloned.

    Default Value

    {}

    uuid

    uuid: string

    UUID of this object instance.

    Remarks

    This gets automatically assigned and shouldn't be edited.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties