Class AbsorberInstance

Constructors

constructor

Properties

_calcPosition _updateParticlePosition absorbers color container dragging initialPosition? limit mass name? opacity options position size

Methods

attract draw resize

Constructors

constructor

  • new AbsorberInstance(absorbers, container, options, position?): AbsorberInstance

  • The absorber constructor, initializes the absorber based on the given options and position

    Parameters

    • absorbers: Absorbers

      the Absorbers collection manager that will contain this absorber

    • container: Container

      the Container engine using the absorber plugin, containing the particles that will interact with this Absorber

    • options: RecursivePartial<IAbsorber>

      the Absorber source options

    • Optional position: ICoordinates

      the Absorber optional position, if not given, it will be searched in options, and if not available also there, a random one will be used

    Returns AbsorberInstance

Properties

Private Readonly _calcPosition

_calcPosition: (() => Vector) = ...

Type declaration

    • (): Vector
    • Internal

      This method calculate the absorber position, using the provided options and position

      Returns Vector

      the calculated position for the absorber

Private Readonly _updateParticlePosition

_updateParticlePosition: ((particle, v) => void) = ...

Type declaration

    • (particle, v): void
    • Internal

      Updates the particle position, if the particle needs a new position

      Parameters

      • particle: OrbitingParticle

        the particle to update

      • v: Vector

        the vector used for calculating the distance between the Absorber and the particle

      Returns void

Private Readonly absorbers

absorbers: Absorbers

the Absorbers collection manager that will contain this absorber

color

color: IRgb

The absorber color

Private Readonly container

container: Container

the Container engine using the absorber plugin, containing the particles that will interact with this Absorber

Private Internal dragging

dragging: boolean

Sets if the absorber can be moved with mouse drag&drop

Private Optional Readonly Internal initialPosition

initialPosition?: Vector

Gets the absorber initial position

limit

limit: IAbsorberSizeLimit

The absorber size limit

mass

mass: number

The absorber mass, this increases the attraction force

Optional Readonly name

name?: string

The absorber name, useful when retrieving it manually

opacity

opacity: number

The absorber opacity

Private Readonly Internal options

options: Absorber

Gets the absorber options

position

position: Vector

The absorber position

size

size: number

The absorber size, great size doesn't mean great mass, it depends also on the density

Methods

attract

  • attract(particle): void

  • Absorber attraction interaction, attract the particle to the absorber

    Parameters

    • particle: OrbitingParticle

      the particle to attract to the absorber

    Returns void

draw

  • draw(context): void

  • The draw method, for drawing the absorber in the canvas

    Parameters

    • context: CanvasRenderingContext2D

      the canvas 2d context used for drawing

    Returns void

resize

Settings

Member Visibility

Theme

On This Page