Class RotationBySpeedModule

Rotation by speed module

Export

RotationBySpeedModule

Date

2024.4.3

Author

yisky

Hierarchy (view full)

ParticleModule
- RotationBySpeedModule

Index

Constructors

constructor

new RotationBySpeedModule(): RotationBySpeedModule
Returns RotationBySpeedModule
Inherited from ParticleModule.constructor

Properties

`Protected`_enable

_enable: boolean = false

`Protected`_system

_system: ParticleSystem

range

range: Vector2 = ...

Set the minimum and maximum speeds that this module applies the rotation curve between.

Memberof

RotationBySpeedModule

separateAxes

separateAxes: boolean = false

Set the rotation by speed on each axis separately.

Memberof

RotationBySpeedModule

x

x: MinMaxCurve = ...

Rotation by speed curve for the x-axis.

Memberof

RotationBySpeedModule

y

y: MinMaxCurve = ...

Rotation by speed curve for the y-axis.

Memberof

RotationBySpeedModule

z

z: MinMaxCurve = ...

Rotation by speed curve for the z-axis.

Memberof

RotationBySpeedModule

Accessors

angularVelocity

get angularVelocity(): MinMaxCurve
Curve to control particle angular velocity base on speeds.

Returns MinMaxCurve
Memberof
RotationBySpeedModule
set angularVelocity(value): void
Curve to control particle angular velocity base on speeds.
Parameters
- value: MinMaxCurve
Returns void
Memberof
RotationBySpeedModule

enable

get enable(): boolean
Specifies whether enable the module.

Returns boolean
Memberof
ParticleModule

Inherited from ParticleModule.enable
set enable(value): void
Specifies whether enable the module.
Parameters
- value: boolean
Returns void
Memberof
ParticleModule

Inherited from ParticleModule.enable

system

get system(): ParticleSystem
Get the particle system.

Returns ParticleSystem
Memberof
ParticleModule

Inherited from ParticleModule.system

xMultiplier

get xMultiplier(): number
Speed multiplier along the x-axis.

Returns number
Memberof
RotationBySpeedModule
set xMultiplier(value): void
Speed multiplier along the x-axis.
Parameters
- value: number
Returns void
Memberof
RotationBySpeedModule

yMultiplier

get yMultiplier(): number
Speed multiplier along the y-axis.

Returns number
Memberof
RotationBySpeedModule
set yMultiplier(value): void
Speed multiplier along the y-axis.
Parameters
- value: number
Returns void
Memberof
RotationBySpeedModule

zMultiplier

get zMultiplier(): number
Speed multiplier along the z-axis.

Returns number
Memberof
RotationBySpeedModule
set zMultiplier(value): void
Speed multiplier along the z-axis.
Parameters
- value: number
Returns void
Memberof
RotationBySpeedModule

Methods

`Protected`_onDisable

_onDisable(): void
Protected
Disable callback

Returns void
Memberof
ParticleModule

Inherited from ParticleModule._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
Enable callback

Returns void
Memberof
ParticleModule

Inherited from ParticleModule._onEnable

`Protected`_serialize

_serialize(meta): void
Protected
Serialize
Parameters
- meta: {
  [key: string]: any;
  }
  - [key: string]: any
Returns void
Memberof
RotationBySpeedModule

Overrides ParticleModule._serialize

dispose

dispose(): void
Dispose module.

Returns void
Memberof
ParticleModule

Inherited from ParticleModule.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from ParticleModule.emit

fromJSON

fromJSON(json): void
Deserialize
Parameters
- json: {
  [key: string]: any;
  }
  - [key: string]: any
Returns void
Memberof
RotationBySpeedModule

Overrides ParticleModule.fromJSON

off

off(type, callback?): void
Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.
Parameters
- type: string
- Optionalcallback: SubscriberCallbackFn
  subscriber callback
Returns void
Memberof
EventDispatcher

Inherited from ParticleModule.off

on

on(type, callback, options?): void
Subscribe a event
Parameters
- type: string
  event type
- callback: SubscriberCallbackFn
  callback functions
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  }
  options
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from ParticleModule.on

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  }
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from ParticleModule.once

toJSON

toJSON(): {
[key: string]: any;
}
Serialize

Returns {
[key: string]: any;
}
- [key: string]: any
Memberof
ParticleModule

Inherited from ParticleModule.toJSON

Class RotationBySpeedModule

Export

Date

Author

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RotationBySpeedModule

Properties

Protected_enable

Protected_system

range

Memberof

separateAxes

Memberof

x

Memberof

y

Memberof

z

Memberof

Accessors

angularVelocity

Returns MinMaxCurve

Memberof

Parameters

Returns void

Memberof

enable

Returns boolean

Memberof

Parameters

Returns void

Memberof

system

Returns ParticleSystem

Memberof

xMultiplier

Returns number

Memberof

Parameters

Returns void

Memberof

yMultiplier

Returns number

Memberof

Parameters

Returns void

Memberof

zMultiplier

Returns number

Memberof

Parameters

Returns void

Memberof

Methods

Protected_onDisable

Returns void

Memberof

Protected_onEnable

Returns void

Memberof

Protected_serialize

Parameters

[key: string]: any

Returns void

Memberof

dispose

Returns void

Memberof

emit

Parameters

[key: string]: any

type: string

Returns void

`Protected`_enable

`Protected`_system

`Protected`_onDisable

`Protected`_onEnable

`Protected`_serialize

`Optional`priority?: Priority

`Optional`target?: any

`Optional`priority?: Priority

`Optional`target?: any

Returns {
[key: string]: any;
}