Class Particle

Hierarchy

Particle

Implements

IParticle

Constructors

constructor

new Particle(engine, id, container, position?, overrideOptions?, group?): Particle
Parameters
- engine: Engine
- id: number
- container: Container
- Optional position: ICoordinates
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
Returns Particle
- Defined in engine/dist/types/Core/Particle.d.ts:67

Properties

`Private` `Readonly` _calcPosition

_calcPosition: any

`Private` `Readonly` _calculateVelocity

_calculateVelocity: any

`Private` `Readonly` _checkOverlap

_checkOverlap: any

`Private` `Readonly` _engine

_engine: any

`Private` `Readonly` _getRollColor

_getRollColor: any

`Private` `Readonly` _initPosition

_initPosition: any

`Private` `Readonly` _loadShapeData

_loadShapeData: any

`Optional` backColor

backColor?: IHsl

bubble

bubble: IBubbleParticleData

close

close: boolean

`Optional` color

color?: IParticleHslAnimation

`Readonly` container

container: Container

destroyed

destroyed: boolean

direction

direction: number

fill

fill: boolean

`Optional` group

group?: string

id

id: number

ignoresResizeRatio

ignoresResizeRatio: boolean

initialPosition

initialPosition: Vector

initialVelocity

initialVelocity: Vector

interactivity

interactivity: Interactivity

lastPathTime

lastPathTime: number

misplaced

misplaced: boolean

moveCenter

moveCenter: ICenterCoordinates

moveDecay

moveDecay: number

offset

offset: Vector

pathDelay

pathDelay: number

`Optional` pathGenerator

pathGenerator?: IMovePathGenerator

pathRotation

pathRotation: boolean

position

position: Vector3d

`Optional` randomIndexData

randomIndexData?: number

retina

retina: IParticleRetinaProps

`Optional` roll

roll?: IParticleRoll

rotation

rotation: number

`Optional` shadowColor

shadowColor?: IRgb

shape

shape: string

`Optional` shapeData

shapeData?: IShapeValues

sides

sides: number

size

size: IParticleNumericValueAnimation

slow

slow: ISlowParticleData

spawning

spawning: boolean

`Optional` strokeColor

strokeColor?: IParticleHslAnimation

`Optional` strokeOpacity

strokeOpacity?: number

`Optional` strokeWidth

strokeWidth?: number

unbreakable

unbreakable: boolean

velocity

velocity: Vector

zIndexFactor

zIndexFactor: number

Methods

destroy

destroy(override?): void
Parameters
- Optional override: boolean
Returns void
- Defined in engine/dist/types/Core/Particle.d.ts:68

draw

draw(delta): void
Parameters
- delta: IDelta
Returns void
- Defined in engine/dist/types/Core/Particle.d.ts:69

getFillColor

getFillColor(): undefined | IHsl
Returns undefined | IHsl
Implementation of IParticle.getFillColor
- Defined in engine/dist/types/Core/Particle.d.ts:70

getMass

getMass(): number
Returns number
Implementation of IParticle.getMass
- Defined in engine/dist/types/Core/Particle.d.ts:71

getPosition

getPosition(): ICoordinates3d
Returns ICoordinates3d
Implementation of IParticle.getPosition
- Defined in engine/dist/types/Core/Particle.d.ts:72

getRadius

getRadius(): number
Returns number
Implementation of IParticle.getRadius
- Defined in engine/dist/types/Core/Particle.d.ts:73

getStrokeColor

getStrokeColor(): undefined | IHsl
Returns undefined | IHsl
Implementation of IParticle.getStrokeColor
- Defined in engine/dist/types/Core/Particle.d.ts:74

init

init(id, position?, overrideOptions?, group?): void
Parameters
- id: number
- Optional position: ICoordinates
- Optional overrideOptions: RecursivePartial<IParticlesOptions>
- Optional group: string
Returns void
- Defined in engine/dist/types/Core/Particle.d.ts:75

isInsideCanvas

isInsideCanvas(): boolean
Returns boolean
Implementation of IParticle.isInsideCanvas
- Defined in engine/dist/types/Core/Particle.d.ts:76

isVisible

isVisible(): boolean
Returns boolean
Implementation of IParticle.isVisible
- Defined in engine/dist/types/Core/Particle.d.ts:77

reset

reset(): void
Returns void
- Defined in engine/dist/types/Core/Particle.d.ts:78

Class Particle

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

engine: Engine

id: number

container: Container

Optional position: ICoordinates

Optional overrideOptions: RecursivePartial<IParticlesOptions>

Optional group: string

Returns Particle

Properties

Private Readonly _calcPosition

Private Readonly _calculateVelocity

Private Readonly _checkOverlap

Private Readonly _engine

Private Readonly _getRollColor

Private Readonly _initPosition

Private Readonly _loadShapeData

Optional backColor

bubble

close

Optional color

Readonly container

destroyed

direction

fill

Optional group

id

ignoresResizeRatio

initialPosition

initialVelocity

interactivity

lastPathTime

misplaced

moveCenter

moveDecay

offset

Optional opacity

options

outType

pathDelay

Optional pathGenerator

pathRotation

position

Optional randomIndexData

retina

Optional roll

rotation

Optional shadowColor

shape

Optional shapeData

sides

size

slow

spawning

Optional strokeColor

Optional strokeOpacity

Optional strokeWidth

unbreakable

velocity

zIndexFactor

Methods

destroy

Parameters

Optional override: boolean

Returns void

draw

Parameters

delta: IDelta

Returns void

getFillColor

Returns undefined | IHsl

getMass

`Optional` position: ICoordinates

`Optional` overrideOptions: RecursivePartial<IParticlesOptions>

`Optional` group: string

`Private` `Readonly` _calcPosition

`Private` `Readonly` _calculateVelocity

`Private` `Readonly` _checkOverlap

`Private` `Readonly` _engine

`Private` `Readonly` _getRollColor

`Private` `Readonly` _initPosition

`Private` `Readonly` _loadShapeData

`Optional` backColor

`Optional` color

`Readonly` container

`Optional` group

`Optional` opacity

`Optional` pathGenerator

`Optional` randomIndexData

`Optional` roll

`Optional` shadowColor

`Optional` shapeData

`Optional` strokeColor

`Optional` strokeOpacity

`Optional` strokeWidth

`Optional` override: boolean

`Optional` position: ICoordinates

`Optional` overrideOptions: RecursivePartial<IParticlesOptions>

`Optional` group: string