Class RadialVelocity

Sets the velocity property on initialized particles.

Hierarchy

default
- RadialVelocity

Index

Constructors

Properties

_useV dir dirVec isEnabled radiusPan tha type

Methods

init initialize normalize reset fromJSON requiresWebGlApi

Constructors

constructor

new RadialVelocity(
    radius: number | Span<number> | undefined,
    vector3d: Vector3D,
    theta?: number,
    isEnabled?: boolean,
): RadialVelocity
Constructs a RadialVelocity initializer.
Parameters
- radius: number | Span<number> | undefined
  The velocity radius
- vector3d: Vector3D
  The directional vector for the velocity
- Optionaltheta: number
  The theta angle to use
- isEnabled: boolean = true
Returns RadialVelocity
Overrides Velocity.constructor
- Defined in src/initializer/Velocity/RadialVelocity.ts:28

Properties

_useV

_useV: boolean

dir

dirVec

dirVec: Vector3D

isEnabled

isEnabled: boolean

radiusPan

radiusPan: Span<number>

tha

tha: number

type

type: string

Methods

init

init(emitter: Emitter, particle?: Particle): void
Initializes the property on the emitter or particle.
Parameters
- emitter: Emitter
- Optionalparticle: Particle
Returns void
Inherited from Velocity.init
- Defined in src/initializer/Initializer.ts:25

initialize

initialize(particle: Particle | Emitter): void
Sets the particle's initial velocity.
Parameters
- particle: Particle | Emitter
  the particle to initialize the property on
Returns void
Inherited from Velocity.initialize
- Defined in src/initializer/Velocity/Velocity.ts:44

normalize

normalize(vr: number): number
Parameters
- vr: number
Returns number
Inherited from Velocity.normalize
- Defined in src/initializer/Velocity/Velocity.ts:35

`Abstract`reset

reset(): void
Returns void
Inherited from Velocity.reset
- Defined in src/initializer/Initializer.ts:42

`Static`fromJSON

fromJSON(json: RadialVelocityJSON): RadialVelocity
Creates a RadialVelocity initializer from JSON.
Parameters
- json: RadialVelocityJSON
  The JSON to construct the instance from.
Returns RadialVelocity
Overrides Velocity.fromJSON
- Defined in src/initializer/Velocity/RadialVelocity.ts:64

`Static`requiresWebGlApi

requiresWebGlApi(): boolean
Determines if the initializer requires a WebGL API to be provided to its constructor.

Returns boolean
Inherited from Velocity.requiresWebGlApi
- Defined in src/initializer/Initializer.ts:55