gophergfx
    Preparing search index...

    Class Particles2

    Represents a 2D particle system

    Hierarchy (View Summary)

    Index
    constructor
    _localBoundingBox _localBoundingCircle _position _rotation _scale _shear _worldBoundingBox _worldBoundingCircle baseParticle boundingBox boundingCircle children layer localBoundsDirty localMatrixDirty localMatrixUpdated localToParentMatrix localToWorldMatrix numParticles parent particlePositions particleSizes visible worldBoundsDirty worldMatrixDirty shader
    localBoundingBox localBoundingCircle localBoundingSphere position rotation scale shear worldBoundingBox worldBoundingCircle worldBoundingSphere
    add composeLocalMatrix decomposeLocalMatrix draw getBaseParticle getLocalToParentMatrix intersects lookAt remove removeChild setLocalToParentMatrix traverseSceneGraph update updateLocalBounds updateWorldBounds updateWorldMatrix

    _localBoundingBox

    _localBoundingBox: BoundingBox2

    Bounding box in this transform's local coordinate space

    _localBoundingCircle

    _localBoundingCircle: BoundingCircle

    Bounding circle in this transform's local coordinate space

    Protected_position

    _position: Vector2

    Vector2 representing the position

    Protected_rotation

    _rotation: number

    Rotation of the transform in radians

    Protected_scale

    _scale: Vector2

    Vector2 representing the scale

    Protected_shear

    _shear: Vector2 | null

    _worldBoundingBox

    _worldBoundingBox: BoundingBox2

    Bounding box in the world coordinate space

    _worldBoundingCircle

    _worldBoundingCircle: BoundingCircle

    Bounding box in the world coordinate space

    baseParticle: Mesh2

    The template shape used to render each particle.

    boundingBox: BoundingBox2

    Bounding box in vertex coordinate space

    boundingCircle: BoundingCircle

    Bounding circle in vertex coordinate space

    children: Node2[]

    Array of children for this transform

    layer: number

    Integer representing the layer of this transform

    localBoundsDirty: boolean
    localMatrixDirty: boolean
    localMatrixUpdated: boolean
    localToParentMatrix: Matrix3

    Matrix3 representing the transformation matrix in local space

    localToWorldMatrix: Matrix3

    Matrix3 representing the transformation matrix in world space

    numParticles: number

    The number of particles to render.

    parent: Node2 | null

    Parent transform for this transform

    particlePositions: Vector2[]

    Array containing positions for each particle instance.

    particleSizes: number[]

    Array containing sizes for each particle instance.

    visible: boolean

    Boolean indicating whether this transform should be rendered

    worldBoundsDirty: boolean
    worldMatrixDirty: boolean
    shader: ShaderProgram = ...
    • get rotation(): number

      Returns number

    • set rotation(value: number): void

      Parameters

      • value: number

      Returns void

    • Adds a child Node2 to the current Node2

      Parameters

      • child: Node2

        The child Node2 to add

      Returns void

    • Checks if this Node2 intersects another Node2, using either a BoundingCircle or AxisAlignedBoundingBox

      Parameters

      • other: Node2

        The Node2 to check for intersection with

      • mode: IntersectionMode2 = IntersectionMode2.BOUNDING_CIRCLE

        The IntersectionMode2 to use for the comparison (default: BOUNDING_CIRCLE)

      • space: CoordinateSpace2 = CoordinateSpace2.LOCAL_SPACE

        The CoordinateSpace2 to use for the comparison (default: LOCAL_SPACE)

      Returns boolean

      A boolean indicating whether the two objects intersect

    • Looks at a target vector with the given look vector

      Parameters

      • target: Vector2

        The vector to look at

      • lookVector: Vector2 = Vector2.UP

        The vector used to determine the look direction (defaults to Vector2.UP)

      • coordinateSpace: CoordinateSpace2 = CoordinateSpace2.LOCAL_SPACE

      Returns void

    • Removes the current Node2 from its parent

      Returns boolean

      True if the Node2 was successfully removed, false otherwise

    • Removes the specified child Node2 from the current Node2

      Parameters

      • child: Node2

        The child Node2 to remove

      Returns Node2 | null

      The removed Node2, or null if it was not found

    • Traverses the scene graph starting from the current Node2 object

      Parameters

      • parentMatrixDirty: boolean = false

      Returns void

    • Update the particle positions and/or sizes

      Parameters

      • updatePositions: boolean = true

        Whether to update the particle positions (defaults to true)

      • updateSizes: boolean = false

        Whether to update the particle sizes (defaults to false)

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods