Class RadialCloner

The RadialCloner distributes given meshes in a radial manner. If more than one meshes are provided, then the clones will be placed alternatively. Several parameters controls the position, angle, type and orientation of the clones.

Param: mesh

mesh to clone

Param: scene

Param: options

all optional: count, offset, radius, startangle, endangle, useInstances, plane

Param: count

The number of instances/clones. Default 3.

Param: radius

The radius in world units. Default 3.

Param: align

Flag if clones are aligned against the middle position of the cloner. Default true

Param: startangle

The angle in degrees. Default 0.

Param: endangle

The angle in degrees. Default 360.

Param: offset

The angle in degrees.

Param: useInstances

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

Param: plane

The object {x,y,z} describing the cloners orientation. Default { x: 1, y: 0, z: 1 }.

Param: isPickable

Flag true if Cloner meshes should be pickable. Default false.

Hierarchy

Cloner
- RadialCloner

Index

Constructors

constructor

new RadialCloner(mesh, scene, __namedParameters?): RadialCloner
Parameters
- mesh: Mesh[]
- scene: Scene
- __namedParameters: {
      align: undefined | boolean;
      count: undefined | number;
      endangle: undefined | number;
      isPickable: undefined | boolean;
      offset: undefined | number;
      plane: undefined | {
          x: number;
          y: number;
          z: number;
      };
      radius: undefined | number;
      startangle: undefined | number;
      useInstances: undefined | boolean;
  } = {}
  - align: undefined | boolean
  - count: undefined | number
  - endangle: undefined | number
  - isPickable: undefined | boolean
  - offset: undefined | number
  - plane: undefined | {
        x: number;
        y: number;
        z: number;
    }
  - radius: undefined | number
  - startangle: undefined | number
  - useInstances: undefined | boolean
Returns RadialCloner
Overrides Cloner.constructor
- Defined in radialCloner.ts:35

Properties

`Private` _align

_align: boolean

_clones

_clones: CMesh[]

_count

_count: undefined | number

_effectors

_effectors: IEffector[] = []

`Private` _endangle

_endangle: number

_frame

_frame: number

_index

_index: number

`Private` _instance_nr

_instance_nr: number

_mesh

_mesh: Mesh[] = []

`Private` _offset

_offset: number

`Private` _plane

_plane: Vector3

`Private` _radius

_radius: number

_rootNode

_rootNode: null | Mesh = null

_scene

_scene: Scene

`Private` _startangle

_startangle: number

`Private` _useInstances

_useInstances: boolean

`Private` isPickable

isPickable: boolean

`Static` instance_nr

instance_nr: number

`Static` vOne

vOne: Vector3 = ...

`Static` vZero

vZero: Vector3 = ...

Accessors

align

get align(): boolean
Returns boolean
- Defined in radialCloner.ts:272
set align(a): void
Parameters
- a: boolean
Returns void
- Defined in radialCloner.ts:268

count

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

effectors

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

endangle

get endangle(): number
Returns number
- Defined in radialCloner.ts:288
set endangle(se): void
Parameters
- se: number
Returns void
- Defined in radialCloner.ts:284

offset

get offset(): number
Returns number
- Defined in radialCloner.ts:248
set offset(off): void
Parameters
- off: number
Returns void
- Defined in radialCloner.ts:244

plane

set plane(p): void
Parameters
- p: Vector3
Returns void
- Defined in radialCloner.ts:292

radius

get radius(): number
Returns number
- Defined in radialCloner.ts:264
set radius(r): void
Parameters
- r: number
Returns void
- Defined in radialCloner.ts:260

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 radialCloner.ts:256

startangle

get startangle(): number
Returns number
- Defined in radialCloner.ts:280
set startangle(sa): void
Parameters
- sa: number
Returns void
- Defined in radialCloner.ts:276

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 radialCloner.ts:158

`Private` calcRot

calcRot(): void
Returns void
- Defined in radialCloner.ts:118

`Private` calcSize

calcSize(): void
Returns void
- Defined in radialCloner.ts:150

createClone

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

createClones

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

delete

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

Returns void
Overrides Cloner.delete
- Defined in radialCloner.ts:210

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 radialCloner.ts:219

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

setScaling

setScaling(ix, sc): void
Parameters
- ix: number
- sc: Vector3
Returns void
- Defined in radialCloner.ts:297

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 radialCloner.ts:201

Class RadialCloner

Param: mesh

Param: scene

Param: options

Param: count

Param: radius

Param: align

Param: startangle

Param: endangle

Param: offset

Param: useInstances

Param: plane

Param: isPickable

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

align: undefined | boolean

count: undefined | number

endangle: undefined | number

isPickable: undefined | boolean

offset: undefined | number

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

radius: undefined | number

startangle: undefined | number

useInstances: undefined | boolean

Returns RadialCloner

Properties

Private _align

_clones

_count

_effectors

Private _endangle

_frame

_index

Private _instance_nr

_mesh

Private _offset

Private _plane

Private _radius

_rootNode

_scene

Private _startangle

Private _useInstances

Private isPickable

Static instance_nr

Static vOne

Static vZero

Accessors

align

Returns boolean

Parameters

Returns void

count

Returns undefined | number

Parameters

Returns void

effectors

Returns IEffector[]

endangle

Returns number

Parameters

Returns void

offset

Returns number

Parameters

Returns void

plane

Parameters

Returns void

radius

Returns number

Parameters

Returns void

root

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

`Private` _align

`Private` _endangle

`Private` _instance_nr

`Private` _offset

`Private` _plane

`Private` _radius

`Private` _startangle

`Private` _useInstances

`Private` isPickable

`Static` instance_nr

`Static` vOne

`Static` vZero

`Private` calcPos

`Private` calcRot

`Private` calcSize