Crackersanimator
Crackersanimator is a particle system library that works with the standard Android UI. This library build from https://github.com/plattysoft/Leonids library but make some update to support for latest version of android.
Screen
Android Studio / gradle Add the following dependency to the build.gradle of your project
-
Add the Crackersanimator dependency
dependencies { implementation 'com.github.Suyash171:crackersanimator:2.1' }
Download
Gradle
- Define the jitpack remote Maven repository inside the repositories block of your root
build.gradlefile
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Creating and firing a one-shot particle system is very easy, just 3 lines of code.
Why this library? Particle systems are often used in games for a wide range of purposes: Explosions, fire, smoke, etc. This effects can also be used on normal apps to add an element of "juiciness" or Playful Design.
Precisely because its main use is games, all engines have support for particle systems, but there is no such thing for standard Android UI.
This means that if you are building an Android app and you want a particle system, you have to include a graphics engine and use OpenGL -which is quite an overkill- or you have to implement it yourself.
Crackersanimator is made to fill this gap, bringing particle sytems to developers that use the standard Android UI
Note that the ParticleSystem checks the position of the anchor view when oneShot (or emit) is called, so it requires the views to be measured. This means that ParticleSystem won't work properly if you call oneShot or emit during onCreate. For more information check the comments on issue #22.
When you create the particle system, you tell how many particles will it use as a maximum, the resourceId of the drawable you want to use for the particles and for how long the particles will live.
Then you configure the particle system. In this case we specify that the particles will have a speed between 0.2 and 0.5 pixels per milisecond (support for dips will be included in the future). Since we did not provide an angle range, it will be considered as "any angle".
Finally, we call oneShot, passing the view from which the particles will be launched and saying how many particles we want to be shot.
Usage
new ParticleSystem(this, numParticles, drawableResId, timeToLive)
.setSpeedRange(0.2f, 0.5f)
.oneShot(anchorView, numParticles);
Finally, we call oneShot, passing the view from which the particles will be launched and saying how many particles we want to be shot.
Emitters
You can configure emitters, which have a constant ratio of particles being emited per second. This is the code for the Confeti example
new ParticleSystem(this, 80, R.drawable.confeti2, 10000)
.setSpeedModuleAndAngleRange(0f, 0.3f, 180, 180)
.setRotationSpeed(144)
.setAcceleration(0.00005f, 90)
.emit(findViewById(R.id.emiter_top_right), 8);
new ParticleSystem(this, 80, R.drawable.confeti3, 10000)
.setSpeedModuleAndAngleRange(0f, 0.3f, 0, 0)
.setRotationSpeed(144)
.setAcceleration(0.00005f, 90)
.emit(findViewById(R.id.emiter_top_left), 8);
It uses an initializer for the Speed as module and angle ranges, a fixed speed rotaion and extenal acceleration.
#Available Methods
List of the methods available on the class ParticleSystem.
Supported drawables are: BitmapDrawable and AnimationDrawable.
* _ParticleSystem(Activity a, int maxParticles, int drawableRedId, long timeToLive)_
* _ParticleSystem(Activity a, int maxParticles, Drawable drawable, long timeToLive)_
* _ParticleSystem(Activity a, int maxParticles, Bitmap bitmap, long timeToLive)_
* _ParticleSystem(Activity a, int maxParticles, AnimationDrawable animation, long timeToLive)_
There are also constructors that recieve a view id to use as the parent so you can put the particle system on the background (or between any two views)
* _ParticleSystem(Activity a, int maxParticles, int drawableRedId, long timeToLive, int parentViewId)_
* _ParticleSystem(Activity a, int maxParticles, Drawable drawable, long timeToLive, int parentViewId)_
* _ParticleSystem(Activity a, int maxParticles, Bitmap bitmap, long timeToLive, int parentViewId)_
* _ParticleSystem(Activity a, int maxParticles, AnimationDrawable animation, long timeToLive, int parentViewId)_
And another constructor that receives a parent viewgroup and drawable for use in places where it is not practical to pass a reference to an Activity
* _ParticleSystem(ViewGroup parentView, int maxParticles, Drawable drawable, long timeToLive)_
### Configuration
Available methods on the Particle system for configuration are:
* _setSpeedRange(float speedMin, float speedMax)_: Uses 0-360 as the angle range
* _setSpeedModuleAndAngleRange(float speedMin, float speedMax, int minAngle, int maxAngle)_
* _setSpeedByComponentsRange(float speedMinX, float speedMaxX, float speedMinY, float speedMaxY)_
* _setInitialRotationRange (int minAngle, int maxAngle)_
* _setScaleRange(float minScale, float maxScale)_
* _setRotationSpeed(float rotationSpeed)_
* _setRotationSpeedRange(float minRotationSpeed, float maxRotationSpeed)_
* _setAcceleration(float acceleration, float angle)_
* _setFadeOut(long milisecondsBeforeEnd, Interpolator interpolator)_: Utility method for a simple fade out effect using an interpolator
* _setFadeOut(long duration)_:Utility method for a simple fade out
You can start the particle system "in the future" if you want to have the particles already created and moving using
_setStartTime(int time)_
For more complex modifiers, you can use the method _addModifier(ParticleModifier modifier)_. Available modifiers are:
* _AlphaModifier (int initialValue, int finalValue, long startMilis, long endMilis)_
* _AlphaModifier (int initialValue, int finalValue, long startMilis, long endMilis, Interpolator interpolator)_
* _ScaleModifier (float initialValue, float finalValue, long startMilis, long endMilis)_
* _ScaleModifier (float initialValue, float finalValue, long startMilis, long endMilis, Interpolator interpolator)_
### One shot
Make one shot using from the anchor view using the number of particles specified, an interpolator is optional
* _oneShot(View anchor, int numParticles)_
* _oneShot(View anchor, int numParticles, Interpolator interpolator)_
### Emitters
Emits the number of particles per second from the emitter. If emittingTime is set, the emitter stops after that time, otherwise it is continuous.
#### Basic emitters
* _emit (View emitter, int particlesPerSecond)_
* _emit (View emitter, int particlesPerSecond, int emittingTime)_
#### Emit based on (x,y) coordinates
* _emit (int emitterX, int emitterY, int particlesPerSecond)_
* _emit (int emitterX, int emitterY, int particlesPerSecond, int emitingTime)_
#### Emit with Gravity
* _emitWithGravity (View emiter, int gravity, int particlesPerSecond)_
* _emitWithGravity (View emiter, int gravity, int particlesPerSecond, int emitingTime)_
#### Update, stop, and cancel
* _updateEmitPoint (int emitterX, int emitterY)_ Updates dynamically the point of emission.
* _updateEmitPoint (View emiter, int gravity)_ Updates dynamically the point of emission using gravity.
* _stopEmitting ()_ Stops the emission of new particles, but the active ones are updated.
* _cancel ()_ Stops the emission of new particles and cancles the active ones.
## Other details
The library is Free Software, you can use it, extended with no requirement to open source your changes. You can also make paid apps using it.
Each Particle System only uses one image for the particles. If you want different particles to be emitted, you need to create a Particle System for each one of them.
# Author
[Suyash Raikar](https://github.com/Suyash171)
# Credits
https://github.com/plattysoft
948 Jan 5, 2023
3 May 8, 2022
8 Sep 1, 2022
2.2k Jan 3, 2023
3 May 7, 2021
2 Sep 21, 2021
1 Jan 9, 2022
5 Feb 2, 2022
30 Dec 16, 2022
1 Jan 20, 2022