Class Mesh2<TGeometry, TMaterial>

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

assetType children clone copy dispatchEvent dispose geometry getObjectById getObjectByName getObjectByProperty material materials parent refreshUi remove setDirty traverse traverseAncestors traverseVisible userData

Accessors

modelObject

Constructors

constructor

Properties

assetType

assetType: "model" = ...

children

children: IObject3D[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

clone

clone: (recursive?: boolean) => this

Returns a clone of this object and optionally all descendants.

Type declaration

    • (recursive?: boolean): this

    • Parameters

      • Optionalrecursive: boolean

        If true, descendants of the object are also cloned. Default true

      Returns this

copy

copy: (source: IObject3D | Mesh2, recursive?: boolean, ...args: any[]) => this

dispatchEvent

dispatchEvent: (event: ILightEvent) => void

Fire an event type.

Type declaration

dispose

dispose: (removeFromParent?: boolean) => void

Type declaration

    • (removeFromParent?: boolean): void

    • Parameters

      • OptionalremoveFromParent: boolean

        remove from parent. Default true

      Returns void

geometry

geometry: TGeometry

An instance of BufferGeometry (or derived classes), defining the object's structure.

Default Value

new THREE.BufferGeometry().

getObjectById

getObjectById: <T extends IObject3D = IObject3D>(id: number) => undefined | T

Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

Type declaration

    • <T extends IObject3D = IObject3D>(id: number): undefined | T

    • Type Parameters

      Parameters

      • id: number

        Unique number of the object instance. Expects a Integer

      Returns undefined | T

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See

id

getObjectByName

getObjectByName: <T extends IObject3D = IObject3D>(
    name: string,
) => undefined | T

Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

Type declaration

Remarks

Note that for most objects the name is an empty string by default

getObjectByProperty

getObjectByProperty: <T extends IObject3D = IObject3D>(
    name: string,
    value: string,
) => undefined | T

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Type declaration

    • <T extends IObject3D = IObject3D>(name: string, value: string): undefined | T

    • Type Parameters

      Parameters

      • name: string

        the property name to search for.

      • value: string

        value of the given property.

      Returns undefined | T

material

material: TMaterial

An instance of material derived from the Material base class or an array of materials, defining the object's appearance.

Default Value

new THREE.MeshBasicMaterial().

Readonlymaterials

materials: IMaterial[]

Same as material but always returns an array. To set, just set material property

parent

parent: null | IObject3D

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

refreshUi

refreshUi: (this: IObject3D) => void = iObjectCommons.refreshUi

remove

remove: (...object: IObject3D[]) => this

Removes a Object3D as child of this Object3D.

Remarks

An arbitrary number of objects may be removed.

See

Group for info on manually grouping objects.

setDirty

setDirty: (
    this: IObject3D,
    options?: IObjectSetDirtyOptions,
    ...args: any[],
) => void = iObjectCommons.setDirty

Dispatches 'objectUpdate' event on object.

traverse

traverse: (callback: (object: IObject3D) => void) => void

Executes the callback on this object and all descendants.

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

traverseAncestors

traverseAncestors: (callback: (object: IObject3D) => void) => void

Executes the callback on all ancestors.

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

traverseVisible

traverseVisible: (callback: (object: IObject3D) => void) => void

Like traverse, but the callback will only be executed for visible objects

Type declaration

    • (callback: (object: IObject3D) => void): void

    • Parameters

      • callback: (object: IObject3D) => void

        A function with as first argument an Object3D object.

      Returns void

Remarks

Descendants of invisible objects are not traversed.

userData

userData: IObject3DUserData

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

modelObject

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors