Leonids: Leonids Particle Systems is graphic library, which add Playful effects in applications.

Leonids

Introduction

Leonids Particle Systems is graphic library, which add Playful effects in applications. Particle systems are often used in games for a wide range of purposes: Explosions, fire, smoke, etc.

Particle System are also implemented using OPENGL, which is more complex and time consuming. Leonids is made to fill this gap, bringing particle sytems to developers that use the standard openharmony UI.

The library is extremely lightweight, having just 26Kb.

Usage Instructions

Basic usage

Creating and firing a one-shot particle system is very easy, just few lines of code.

        new ParticleSystem(mRootId, 50, ResUtil.getPixelMapElementByResId(getContext(), ResourceTable.Media_star_pink), 3000)
                .setAcceleration(0.00013f, 90)
                .setSpeedByComponentsRange(0f, 0f, 0.05f, 0.1f)
                .setFadeOut(200, Animator.CurveType.ACCELERATE)
                .emitWithGravity(component, LayoutAlignment.BOTTOM, 30);

Note that the ParticleSystem checks the position of the anchor component when oneShot (or emit) is called, so it requires the components to be measured. This means that ParticleSystem won't work properly if you call oneShot or emit during onCreate.

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 component 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(mRootId, 24, ResUtil.getPixelMapElementByResId(getContext(), ResourceTable.Media_confeti2), 10000)
                .setSpeedModuleAndAngleRange(0f, 0.1f, 180, 180)
                .setRotationSpeed(144)
                .setAcceleration(0.000017f, 90)
                .emit(mRootId.findComponentById(ResourceTable.Id_emiter_top_right), 8);

        new ParticleSystem(mRootId, 24, ResUtil.getPixelMapElementByResId(getContext(), ResourceTable.Media_confeti3), 10000)
                .setSpeedModuleAndAngleRange(0f, 0.1f, 0, 0)
                .setRotationSpeed(144)
                .setAcceleration(0.000017f, 90)
                .emit(mRootId.findComponentById(ResourceTable.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.

Constructors

All constructors use the activity, the maximum number of particles and the time to live. The difference is in how the image for the particles is specified.

Supported drawables are: PixelMapElement and FrameAnimationElement.

ParticleSystem(ComponentContainer parentComponent, int maxParticles, Element 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, CurveType curvetype): Utility method for a simple fade out effect using an curvetype
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, Curvetype curvetype)
ScaleModifier (float initialValue, float finalValue, long startMilis, long endMilis)
ScaleModifier (float initialValue, float finalValue, long startMilis, long endMilis, Curvetype curvetype)

One shot

Make one shot using from the anchor component using the number of particles specified, an interpolator is optional

oneShot(Component anchor, int numParticles)
oneShot(Component anchor, int numParticles, Curvetype curvetype)

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 (Component emitter, int particlesPerSecond)
emit (Component 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 (Component emiter, int gravity, int particlesPerSecond)
emitWithGravity (Component emiter, int gravity, int particlesPerSecond, int emitingTime)

Update, stop, and cancel

updateEmitPoint (int emitterX, int emitterY) Updates dynamically the point of emission.
updateEmitPoint (Component 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.

Installation Instructions

Method 1: Generate har package from library and add it to lib folder.
       add following code to gradle of entry
    
       implementation fileTree(dir: 'libs', include: ['*.jar', '*.har'])

Method 2: 
    allprojects{ 
        repositories{ 
            mavenCentral() 
        } 
    }
    implementation 'io.openharmony.tpc.thirdlib:Leonids:1.0.1'

HarmonyOS-TPC / Leonids

Leonids

Introduction

Usage Instructions

Basic usage

Emitters

Available Methods

Constructors

Configuration

One shot

Emitters

Basic emitters

Emit based on (x,y) coordinates

Emit with Gravity

Update, stop, and cancel

Other details

Installation Instructions

简介

发行版

贡献者

近期动态

HarmonyOS-TPC / Leonids .gitee-modal { width: 500px !important; }

Leonids

Introduction

Usage Instructions

Basic usage

Emitters

Available Methods

Constructors

Configuration

One shot

Emitters

Basic emitters

Emit based on (x,y) coordinates

Emit with Gravity

Update, stop, and cancel

Other details

Installation Instructions

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

HarmonyOS-TPC / Leonids