Class LinearCloner

The LinearCloner instances/clones and distributes given meshes in a linear manner. If more than one mesh is provided, then the corresponding clones will be placed subsequently one after another. The LinearCloner can instantiated in two different interpolation-modes: absolute and relative. In the first mode the values of the input parameters (scale/rotation/position) can be seen as the difference from the first to the last clone, whereas in the relative mode those values are the difference from clone to clone. The LinearCloner returns an object with an important property: root. It is an invisible mesh, it's the anchor and parent of all generated clones, its position is the position of the first clone. Transforming this root affects all underlying clones (childs) at once but independently of the interpolation mode. Most of the input parameters are also available as properties and they are very suitable for animation (tweening). The given input meshes will be made inactive during construction. Input meshes may be other Cloners as well.

Param: mesh

The array of meshes/cloners to be cloned, meshes will be made inactive after construction.

Param: scene

Babylon scene.

Param: count

The number of instances/clones. Default 3.

Param: offset

The offset in world units in the direction of the transform position vector. Default 0.

Param: growth

The weight factor for all transform parameters in percent/100. Default 1.

Param: P

The position transform vector. Default { x: 0, y: 2, z: 0 }.

Param: S

The scaling transform vector. Default { x: 1, y: 1, z: 1}.

Param: R

The rotation transform vector. Default { x: 0, y: 0, z: 0 }.

Param: iModeRelative

The interpolation mode. Default false (absolute).

Param: useInstances

Flag if clones should be technical "clones" or "instances". Default true.

Hierarchy

Cloner
- LinearCloner

Constructors

constructor

new LinearCloner(mesh, scene, __namedParameters?): LinearCloner
Parameters
- mesh: Mesh[]
- scene: Scene
- __namedParameters: {
      P: undefined | {
          x: number;
          y: number;
          z: number;
      };
      R: undefined | {
          x: number;
          y: number;
          z: number;
      };
      S: undefined | {
          x: number;
          y: number;
          z: number;
      };
      count: undefined | number;
      growth: undefined | number;
      iModeRelative: undefined | boolean;
      isPickable: undefined | boolean;
      offset: undefined | number;
      useInstances: undefined | boolean;
  } = {}
  - P: undefined | {
        x: number;
        y: number;
        z: number;
    }
  - R: undefined | {
        x: number;
        y: number;
        z: number;
    }
  - S: undefined | {
        x: number;
        y: number;
        z: number;
    }
  - count: undefined | number
  - growth: undefined | number
  - iModeRelative: undefined | boolean
  - isPickable: undefined | boolean
  - offset: undefined | number
  - useInstances: undefined | boolean
Returns LinearCloner
Overrides Cloner.constructor
- Defined in linearCloner.ts:41

Properties

`Private` _P

_P: Vector3

`Private` _R

_R: Vector3

`Private` _S

_S: Vector3

_clones

_clones: CMesh[]

_count

_count: undefined | number

`Private` _countNumberGen

_countNumberGen: null | number = null

_effectors

_effectors: IEffector[] = []

_frame

_frame: number

`Private` _growth

_growth: number

`Private` _iModeRelative

_iModeRelative: boolean

_index

_index: number

`Private` _instance_nr

_instance_nr: number

_mesh

_mesh: Mesh[] = []

`Private` _offset

_offset: number

_rootNode

_rootNode: null | Mesh = null

_scene

_scene: Scene

`Private` _useInstances

_useInstances: boolean

`Private` isPickable

isPickable: boolean

`Static` instance_nr

instance_nr: number

`Static` vOne

vOne: Vector3 = ...

`Static` vZero

vZero: Vector3 = ...

Accessors

count

get count(): undefined | number
Returns undefined | number
- Defined in linearCloner.ts:240
set count(scnt): void
Parameters
- scnt: undefined | number
Returns void
- Defined in linearCloner.ts:223

effectors

get effectors(): IEffector[]
Returns IEffector[]
Inherited from Cloner.effectors
- Defined in core.ts:109

growth

get growth(): number
Returns number
- Defined in linearCloner.ts:200
set growth(g): void
Parameters
- g: number
Returns void
- Defined in linearCloner.ts:204

iModeRel

set iModeRel(mode): void
Parameters
- mode: boolean
Returns void
- Defined in linearCloner.ts:244

meshes

get meshes(): Mesh[]
Gets the array of source meshes used in Cloner.

Returns Mesh[]
- Defined in linearCloner.ts:320

offset

get offset(): number
Returns number
- Defined in linearCloner.ts:306
set offset(o): void
Parameters
- o: number
Returns void
- Defined in linearCloner.ts:302

position

get position(): {
    x: number;
    y: number;
    z: number;
}
Returns {
    x: number;
    y: number;
    z: number;
}
- x: number
- y: number
- z: number
- Defined in linearCloner.ts:264
set position(pos): void
Parameters
- pos: {
      x: number;
      y: number;
      z: number;
  }
  - x: number
  - y: number
  - z: number
Returns void
- Defined in linearCloner.ts:258

root

get root(): null | Mesh
Gets Cloner's root - an invisible mesh, the anchor and parent of all generated instances/clones. Transforming this root affects all underlying clones (childs) at once.

Returns null | Mesh
- Defined in linearCloner.ts:314

rotation

get rotation(): {
    x: number;
    y: number;
    z: number;
}
Returns {
    x: number;
    y: number;
    z: number;
}
- x: number
- y: number
- z: number
- Defined in linearCloner.ts:284
set rotation(r): void
Parameters
- r: {
      x: number;
      y: number;
      z: number;
  }
  - x: number
  - y: number
  - z: number
Returns void
- Defined in linearCloner.ts:278

rotation3

get rotation3(): Vector3
Returns Vector3
- Defined in linearCloner.ts:292
set rotation3(vec): void
Parameters
- vec: Vector3
Returns void
- Defined in linearCloner.ts:295

scale

get scale(): {
    x: number;
    y: number;
    z: number;
}
Returns {
    x: number;
    y: number;
    z: number;
}
- x: number
- y: number
- z: number
- Defined in linearCloner.ts:274
set scale(s): void
Parameters
- s: {
      x: number;
      y: number;
      z: number;
  }
  - x: number
  - y: number
  - z: number
Returns void
- Defined in linearCloner.ts:268

Methods

addEffector

addEffector(effector, sensitivity): void
Adds an effector to this Cloner and sets the sensitivity (1=full sensitivity, 0=no sensitivity ==ignore effector)
Parameters
- effector: RandomEffector
- sensitivity: number
Returns void
Inherited from Cloner.addEffector
- Defined in core.ts:100

`Private` calcPos

calcPos(): void
Returns void
- Defined in linearCloner.ts:158

`Private` calcRot

calcRot(): void
Returns void
- Defined in linearCloner.ts:173

`Private` calcSize

calcSize(): void
Returns void
- Defined in linearCloner.ts:146

createClone

createClone(parent): null | Mesh
Parameters
- parent: CMesh
Returns null | Mesh
Overrides Cloner.createClone
- Defined in linearCloner.ts:103

`Private` createClones

createClones(start?): void
Parameters
- start: number = 0
Returns void
- Defined in linearCloner.ts:126

delete

delete(): void
Deletes all Cloner's children and disposes the root Node.

Returns void
Overrides Cloner.delete
- Defined in linearCloner.ts:212

ePosition

ePosition(vec): Vector3
Parameters
- vec: Vector3
Returns Vector3
Inherited from Cloner.ePosition
- Defined in core.ts:135

eReset

eReset(): void
Returns void
Inherited from Cloner.eReset
- Defined in core.ts:146

eRotate

eRotate(vec): Vector3
Parameters
- vec: Vector3
Returns Vector3
Inherited from Cloner.eRotate
- Defined in core.ts:124

eScale

eScale(vec): Vector3
Parameters
- vec: Vector3
Returns Vector3
Inherited from Cloner.eScale
- Defined in core.ts:113

getScene

getScene(): Scene
Returns Scene
Inherited from Cloner.getScene
- Defined in core.ts:151

recalc

recalc(): void
Returns void
- Defined in linearCloner.ts:195

setEnabled

setEnabled(enabled): void
set the cloner's root node to the state of the flag (true=enabled)
Parameters
- enabled: boolean
Returns void
Inherited from Cloner.setEnabled
- Defined in core.ts:85

toMatrix

toMatrix(): Matrix[]
Returns an array of matrices (scaling, rotation, position) of the Cloner meshes.

Returns Matrix[]
Inherited from Cloner.toMatrix
- Defined in core.ts:245

toThin

toThin(addSelf?, rootName?): Mesh[]
Converts the Cloner to thin instances, then deletes this Cloner and returns an array of Cloner meshes. The source meshes are cloned, their clones set enabled. To display them use addSelf = true. All cloned source meshes get the new parent with the rootName. Be aware that the original Cloner will be disposed, so Cloner methods will not work anymore. Use the root node and its individual child meshes for further processing.
Parameters
- Optional addSelf: boolean
  If true, adds the source mesh to the matrix. Default false.
- Optional rootName: string
  Allow to define the name of the root mesh which will be the parent of cloned source meshes and all thin instances. If empty, Cloner class name will be used for the name.
Returns Mesh[]
Inherited from Cloner.toThin
- Defined in core.ts:164

toThinOriginals

toThinOriginals(addSelf?): Mesh[]
Converts all Cloner meshes to thin instances from the original meshes, then deletes this Cloner and returns an array of Cloner meshes. Be aware that instances of all those original meshes become disabled as well, so if they are used in other Cloners one may want to use toThin() method instead. If you don't need animations and so on you may convert Cloner to thin instances. It greatly reduces the number of objects iterating in the render loop.
Parameters
- Optional addSelf: boolean
  If true, adds the source mesh to the matrix. Default false.
Returns Mesh[]
The array of original meshes: Mesh[]
Inherited from Cloner.toThinOriginals
- Defined in core.ts:213

update

update(): void
Returns void
Overrides Cloner.update
- Defined in linearCloner.ts:187

Class LinearCloner

Param: mesh

Param: scene

Param: count

Param: offset

Param: growth

Param: P

Param: S

Param: R

Param: iModeRelative

Param: useInstances

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

P: undefined | { x: number; y: number; z: number; }

R: undefined | { x: number; y: number; z: number; }

S: undefined | { x: number; y: number; z: number; }

count: undefined | number

growth: undefined | number

iModeRelative: undefined | boolean

isPickable: undefined | boolean

offset: undefined | number

useInstances: undefined | boolean

Returns LinearCloner

Properties

Private _P

Private _R

Private _S

_clones

_count

Private _countNumberGen

_effectors

_frame

Private _growth

Private _iModeRelative

_index

Private _instance_nr

_mesh

Private _offset

_rootNode

_scene

Private _useInstances

Private isPickable

Static instance_nr

Static vOne

Static vZero

Accessors

count

Returns undefined | number

Parameters

Returns void

effectors

Returns IEffector[]

growth

Returns number

Parameters

Returns void

iModeRel

Parameters

Returns void

meshes

Returns Mesh[]

offset

Returns number

Parameters

Returns void

position

Returns { x: number; y: number; z: number; }

x: number

y: number

z: number

Parameters

x: number

y: number

P: undefined | {
x: number;
y: number;
z: number;
}

R: undefined | {
x: number;
y: number;
z: number;
}

S: undefined | {
x: number;
y: number;
z: number;
}

`Private` _P

`Private` _R

`Private` _S

`Private` _countNumberGen

`Private` _growth

`Private` _iModeRelative

`Private` _instance_nr

`Private` _offset

`Private` _useInstances

`Private` isPickable

`Static` instance_nr

`Static` vOne

`Static` vZero

Returns {
x: number;
y: number;
z: number;
}

Returns {
x: number;
y: number;
z: number;
}

Returns {
x: number;
y: number;
z: number;
}

`Private` calcPos

`Private` calcRot

`Private` calcSize

`Private` createClones