C# desktop renderer and Unity renderer for NeutrinoParticles
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist-unity
dist
samples
LICENSE
README.md

README.md

neutrinoparticles.cs

This library allows you to load and simulate particle effects exported from NeutrinoParticles Editor.

The library is designed to be integrated in any engine/framework with C# environment and it doesn't use any system-dependent features.

The library is distributed with a single Neutrino.dll file.

Below you will find samples on how to use it with clean OpenGL API.

Currently available integrations:

Introduction

NeutrinoParticles Editor exports effects to generic .cs file, which contains effect's properties and algorithms of particles' behaviour.

Neutrino.dll library contains all the code shared between effects (like mathematics and some algorithms).

Exported effect file has no textures inside it, but only their file names. All images loading you will need to handle on the application side. Usually, for that you will use capabilities of the framework/engine where you integrate this library.

Effect is divided into two parts: model and instance. Model is described as a class in exported from the editor .cs file. So, in general, to render effect you need to make next steps:

  1. Attach effect's .cs file to the project in any suitable way.
  2. Create effect's model described in that class.
  3. Load textures described in the model.
  4. Create effect's instances. Each instance has own position and life time and will be simulated independently.
  5. On each frame, update and render the effect's instances.

To make fully fledged integration of Neutrino effect to any engine/framework you will need to write custom code which makes these steps above.

As a reference, you can use sample reference.OpenGL. It shows you how to make such code for clean OpenGL environment (without any external texture loader, shaders loader etc.). You can find this sample in /samples/reference.OpenGL directory of the repository. And below you can find it's description.

samples/reference.OpenGL

This sample uses OpenGL to render effects. It is based on the OpenGLTutorial6 code from here. There you can find video tutorial and source code for OpenGL programming on C#. It shows you how to load textures, create shaders and render geometry with loaded textures.

Additionaly, several classes were made. These classes make all that five steps from above.

  • NeutrinoGl.Materials - manages shaders and switches OpenGL state between different materials (blending modes).
  • NeutrinoGl.Context - shared context for all effects. Holds single object of Materials and prefix path for textures.
  • NeutrinoGl.RenderBuffers - inherits from Neutrino.RenderBuffer interface and receives geometry from effect. Before the rendering udpates OpenGL geometry buffers with received geometry.
  • NeutrinoGl.EffectModel - wraps generic Neutrino.EffectModel and loads textures for it.
  • NeutrinoGl.Effect - wraps generic Neutrino.Effect. Contains RenderBuffers which is passed to Neutrino.Effect to receive geometry.

Instant effect position change (jump)

When you moving your effect by changing it's position, the library thinks that effect is moved to new position linearly. In this case effects which generate particles from passed distance will form trail of particles to the new position.

If you want to jump to the new position and avoid such trails, you need to reset effect's position. For that you can use Neutrino.Effect.resetPosition(_math.vec3 position) method of the effect.

Changing emitter's properties

Particle emitters in the NeutrinoParticles Editor have "Emitter's property" blocks (on top of emitter scheme). These blocks allow to pass parameters from parent to attached emitters (like particle color, size etc.). Also these blocks are exposed by the NeutrinoParticles library in the effect instances and you can programmatically change these properties in standalone emitters (not attached to particles). So, you can easily change effect's color or anything you planned while creating the effect.

To make that, you can use Neutrino.Effect.setEmitterPropertyValue(string emitterName, string propName, [float|_math.vec2|_math.vec3|_math.quat] value).

If you want to set value of a property with specific name in all emitters of effect, just pass null instead of emitterName.