Package 

Class Party

  • All Implemented Interfaces:

    
    public final class Party
    
                        

    Configuration how to confetti should be rendered

    • Method Detail

      • getSpread

         final Integer getSpread()

        how wide the confetti will shoot in degrees. Use 1 to shoot in a straight line and 360 to form a circle

      • getSpeed

         final Float getSpeed()

        The start speed of the confetti at the time of creation. Also set maxSpeed to apply a random speed between speed and maxSpeed.

      • getMaxSpeed

         final Float getMaxSpeed()

        when maxSpeed is set a random speed between speed and maxSpeed will be chosen. Using randomness creates a more natural and realistic look to the confetti when animating.

      • getDamping

         final Float getDamping()

        The rate at which the speed will decrease right after shooting the confetti

      • getSize

         final List<Size> getSize()

        The size of the confetti. Use: Size.SMALL, MEDIUM or LARGE for default sizes or create your custom size using a new instance of Size.

      • getShapes

         final List<Shape> getShapes()

        Set the shape of the confetti. Set multiple shapes and it will be randomly assigned upon creation of the confetti. See Shape for possible shapes and custom drawables.

      • getTimeToLive

         final Long getTimeToLive()

        the amount of time in milliseconds before a particle will stop rendering or fade out if fadeOutEnabled is set to true.

      • getFadeOutEnabled

         final Boolean getFadeOutEnabled()

        If true and a confetti disappears because it ran out of time (set with timeToLive) it will slowly fade out. If set to falls it will instantly disappear from the screen.

      • getPosition

         final Position getPosition()

        the point where the confetti will spawn relative to the canvas. Use absolute coordinates with Position.Absolute or relative coordinates between 0.0 and 1.0 using Position.Relative. Spawn confetti on random positions using Position.between.

      • getDelay

         final Integer getDelay()

        the amount of milliseconds to wait before the rendering of the confetti starts

      • getRotation

         final Rotation getRotation()

        enable the 3D rotation of a Confetti. See Rotation class for the configuration options. Easily enable or disable it using Rotation.enabled() or Rotation.disabled() and control the speed of rotations.

      • getEmitter

         final EmitterConfig getEmitter()

        instructions how many and often a confetti particle should spawn. Use Emitter(duration, timeUnit).max(amount) or Emitter(duration, timeUnit).perSecond(amount) to configure the Emitter.