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 (View Summary)

Cloner
- RadialCloner

Index

Constructors

constructor

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

Properties

_clones

_clones: CMesh[]

_count

_count: undefined | number

_effectors

_effectors: IEffector[] = []

_frame

_frame: number

_index

_index: number

_mesh

_mesh: Mesh[] = []

_rootNode

_rootNode: null | Mesh = null

_scene

_scene: Scene

`Static`instance_nr

instance_nr: number

`Static`vOne

vOne: Vector3 = ...

`Static`vZero

vZero: Vector3 = ...

Accessors

align

get align(): boolean
Returns boolean
- Defined in src/Cloner/radialCloner.ts:236
set align(a: boolean): void
Parameters
- a: boolean
Returns void
- Defined in src/Cloner/radialCloner.ts:232

count

get count(): undefined | number
Returns undefined | number
- Defined in src/Cloner/radialCloner.ts:204
set count(scnt: undefined | number): void
Parameters
- scnt: undefined | number
Returns void
- Defined in src/Cloner/radialCloner.ts:189

effectors

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

endangle

get endangle(): number
Returns number
- Defined in src/Cloner/radialCloner.ts:252
set endangle(se: number): void
Parameters
- se: number
Returns void
- Defined in src/Cloner/radialCloner.ts:248

offset

get offset(): number
Returns number
- Defined in src/Cloner/radialCloner.ts:212
set offset(off: number): void
Parameters
- off: number
Returns void
- Defined in src/Cloner/radialCloner.ts:208

plane

set plane(p: Vector3): void
Parameters
- p: Vector3
Returns void
- Defined in src/Cloner/radialCloner.ts:256

radius

get radius(): number
Returns number
- Defined in src/Cloner/radialCloner.ts:228
set radius(r: number): void
Parameters
- r: number
Returns void
- Defined in src/Cloner/radialCloner.ts:224

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 src/Cloner/radialCloner.ts:220

startangle

get startangle(): number
Returns number
- Defined in src/Cloner/radialCloner.ts:244
set startangle(sa: number): void
Parameters
- sa: number
Returns void
- Defined in src/Cloner/radialCloner.ts:240

Methods

addEffector

addEffector(effector: RandomEffector, sensitivity: number): 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 src/Cloner/core.ts:90

createClone

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

createClones

createClones(start?: number): void
Parameters
- start: number = 0
Returns void
- Defined in src/Cloner/radialCloner.ts:92

delete

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

Returns void
Overrides Cloner.delete
- Defined in src/Cloner/radialCloner.ts:173

ePosition

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

eReset

eReset(): void
Returns void
Inherited from Cloner.eReset
- Defined in src/Cloner/core.ts:124

eRotate

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

eScale

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

getScene

getScene(): Scene
Returns Scene
Inherited from Cloner.getScene
- Defined in src/Cloner/core.ts:129

recalc

recalc(): void
Returns void
- Defined in src/Cloner/radialCloner.ts:183

setEnabled

setEnabled(enabled: boolean): 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 src/Cloner/core.ts:75

setScaling

setScaling(ix: number, sc: Vector3): void
Parameters
- ix: number
- sc: Vector3
Returns void
- Defined in src/Cloner/radialCloner.ts:261

toMatrix

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

Returns Matrix[]
Inherited from Cloner.toMatrix
- Defined in src/Cloner/core.ts:223

toThin

toThin(addSelf?: boolean, rootName?: string): 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
- OptionaladdSelf: boolean
  If true, adds the source mesh to the matrix. Default false.
- OptionalrootName: 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 src/Cloner/core.ts:142

toThinOriginals

toThinOriginals(addSelf?: boolean): 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
- OptionaladdSelf: 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 src/Cloner/core.ts:191

update

update(): void
Returns void
Overrides Cloner.update
- Defined in src/Cloner/radialCloner.ts:164

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 (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RadialCloner

Properties

_clones

_count

_effectors

_frame

_index

_mesh

_rootNode

_scene

Staticinstance_nr

StaticvOne

StaticvZero

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

Returns null | Mesh

startangle

Returns number

Parameters

Returns void

Methods

addEffector

Parameters

Returns void

createClone

Parameters

Returns null | Mesh

createClones

Parameters

Returns void

delete

Returns void

ePosition

`Static`instance_nr

`Static`vOne

`Static`vZero