Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GeometryPLY

Hierarchy

  • Geometry
    • GeometryPLY

Index

Constructors

constructor

Properties

animation

animation: AnimationClip

animations

animations: AnimationClip[]

bones

bones: Bone[]

boundingBox

boundingBox: Box3 | null

Bounding box.

boundingSphere

boundingSphere: Sphere | null

Bounding sphere.

colors

colors: Color[]

Array of vertex colors, matching number and order of vertices. Used in ParticleSystem, Line and Ribbon. Meshes use per-face-use-of-vertex colors embedded directly in faces. To signal an update in this array, Geometry.colorsNeedUpdate needs to be set to true.

colorsNeedUpdate

colorsNeedUpdate: boolean

Set to true if the colors array has been updated.

elementsNeedUpdate

elementsNeedUpdate: boolean

Set to true if the faces array has been updated.

faceVertexUvs

faceVertexUvs: Vector2[][][]

Array of face UV layers. Each UV layer is an array of UV matching order and number of vertices in faces. To signal an update in this array, Geometry.uvsNeedUpdate needs to be set to true.

faces

faces: Face3[]

Array of triangles or/and quads. The array of faces describe how each vertex in the model is connected with each other. To signal an update in this array, Geometry.elementsNeedUpdate needs to be set to true.

groupsNeedUpdate

groupsNeedUpdate: boolean

id

id: number

Unique number of this geometry instance

isGeometry

isGeometry: true

lineDistances

lineDistances: number[]

lineDistancesNeedUpdate

lineDistancesNeedUpdate: boolean

Set to true if the linedistances array has been updated.

morphNormals

morphNormals: MorphNormals[]

Array of morph normals. Morph normals have similar structure as morph targets, each normal set is a Javascript object:

     morphNormal = { name: "NormalName", normals: [ new THREE.Vector3(), ... ] }

morphTargets

morphTargets: MorphTarget[]

Array of morph targets. Each morph target is a Javascript object:

     { name: "targetName", vertices: [ new THREE.Vector3(), ... ] }

Morph vertices match number and order of primary vertices.

name

name: string

Name for this geometry. Default is an empty string.

normalsNeedUpdate

normalsNeedUpdate: boolean

Set to true if the normals array has been updated.

skinIndices

skinIndices: Vector4[]

Array of skinning indices, matching number and order of vertices.

skinWeights

skinWeights: Vector4[]

Array of skinning weights, matching number and order of vertices.

type

type: string

useColor

useColor: boolean

uuid

uuid: string

uvsNeedUpdate

uvsNeedUpdate: boolean

Set to true if the uvs array has been updated.

vertices

vertices: Vector3[]

The array of vertices hold every position of points of the model. To signal an update in this array, Geometry.verticesNeedUpdate needs to be set to true.

verticesNeedUpdate

verticesNeedUpdate: boolean

Set to true if the vertices array has been updated.

Methods

addEventListener

  • addEventListener(type: string, listener: (event: Event) => void): void
  • Adds a listener to an event type.

    Parameters

    • type: string

      The type of event to listen to.

    • listener: (event: Event) => void

      The function that gets called when the event is fired.

        • (event: Event): void
        • Parameters

          • event: Event

          Returns void

    Returns void

applyMatrix4

  • applyMatrix4(matrix: Matrix4): Geometry
  • Bakes matrix transform directly into vertex coordinates.

    Parameters

    • matrix: Matrix4

    Returns Geometry

center

  • center(): Geometry
  • Returns Geometry

clone

  • clone(): this
  • Creates a new clone of the Geometry.

    Returns this

computeBoundingBox

  • computeBoundingBox(): void
  • Computes bounding box of the geometry, updating {@link Geometry.boundingBox} attribute.

    Returns void

computeBoundingSphere

  • computeBoundingSphere(): void
  • Computes bounding sphere of the geometry, updating Geometry.boundingSphere attribute. Neither bounding boxes or bounding spheres are computed by default. They need to be explicitly computed, otherwise they are null.

    Returns void

computeFaceNormals

  • computeFaceNormals(): void

computeFlatVertexNormals

  • computeFlatVertexNormals(): void
  • Compute vertex normals, but duplicating face normals.

    Returns void

computeMorphNormals

  • computeMorphNormals(): void

computeVertexNormals

  • computeVertexNormals(areaWeighted?: undefined | false | true): void
  • Computes vertex normals by averaging face normals. Face normals must be existing / computed beforehand.

    Parameters

    • Optional areaWeighted: undefined | false | true

    Returns void

copy

  • copy(source: Geometry): this
  • Parameters

    • source: Geometry

    Returns this

dispatchEvent

  • dispatchEvent(event: { type: string }): void
  • Fire an event type.

    Parameters

    • event: { type: string }
      • [attachment: string]: any
      • type: string

    Returns void

dispose

  • dispose(): void
  • Removes The object from memory. Don't forget to call this method when you remove an geometry because it can cuase meomory leaks.

    Returns void

fromBufferGeometry

  • fromBufferGeometry(geometry: BufferGeometry): Geometry
  • Parameters

    • geometry: BufferGeometry

    Returns Geometry

hasEventListener

  • hasEventListener(type: string, listener: (event: Event) => void): boolean
  • Checks if listener is added to an event type.

    Parameters

    • type: string

      The type of event to listen to.

    • listener: (event: Event) => void

      The function that gets called when the event is fired.

        • (event: Event): void
        • Parameters

          • event: Event

          Returns void

    Returns boolean

lookAt

  • lookAt(vector: Vector3): void
  • Parameters

    • vector: Vector3

    Returns void

merge

  • merge(geometry: Geometry, matrix?: Matrix, materialIndexOffset?: undefined | number): void
  • Parameters

    • geometry: Geometry
    • Optional matrix: Matrix
    • Optional materialIndexOffset: undefined | number

    Returns void

mergeMesh

  • mergeMesh(mesh: Mesh): void
  • Parameters

    • mesh: Mesh

    Returns void

mergeVertices

  • mergeVertices(): number
  • Checks for duplicate vertices using hashmap. Duplicated vertices are removed and faces' vertices are updated.

    Returns number

normalize

  • normalize(): Geometry
  • Returns Geometry

removeEventListener

  • removeEventListener(type: string, listener: (event: Event) => void): void
  • Removes a listener from an event type.

    Parameters

    • type: string

      The type of the listener that gets removed.

    • listener: (event: Event) => void

      The listener function that gets removed.

        • (event: Event): void
        • Parameters

          • event: Event

          Returns void

    Returns void

rotateX

  • rotateX(angle: number): Geometry
  • Parameters

    • angle: number

    Returns Geometry

rotateY

  • rotateY(angle: number): Geometry
  • Parameters

    • angle: number

    Returns Geometry

rotateZ

  • rotateZ(angle: number): Geometry
  • Parameters

    • angle: number

    Returns Geometry

scale

  • scale(x: number, y: number, z: number): Geometry
  • Parameters

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

    Returns Geometry

setFromPoints

  • setFromPoints(points: Array<Vector2> | Array<Vector3>): this
  • Parameters

    • points: Array<Vector2> | Array<Vector3>

    Returns this

sortFacesByMaterialIndex

  • sortFacesByMaterialIndex(): void

toJSON

  • toJSON(): any
  • Returns any

translate

  • translate(x: number, y: number, z: number): Geometry
  • Parameters

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

    Returns Geometry

Generated using TypeDoc