Particle

In RealFlow, fluids are represented as particles and these particle carry lots of information stored in so-called channels. With the nodes in this class you have direct access to these channels. It is also possible to add and remove particles, filter them and add forces. The latter opens a huge area of applications, because you can create force fields from images, objects, and even other particles. These forces can then be applied to an emitter's particles and act like a custom daemon.

Nodes

ArrayParticlesConcat

This node concatenates the inputs 'array0' and 'array1' into a single 'out' array.

Inputs

Outputs

ArrayParticlesConstant

This node returns a constant array.

Inputs

Outputs

ArrayParticlesFilterByMask

This node returns the elements of the input 'array' at positions specified by the 'mask' parameter.

Inputs

Outputs

ArrayParticlesFindAllElementIndices

This node returns all positions in the input 'array', which fit to the input 'element' values. .

Inputs

Outputs

ArrayParticlesFindElement

This node is executed in parallel according to its input pins size.

This node returns the first position of appearance of the input 'element' within the input 'array'. If the array does not contain the element, -1 is returned.

Inputs

Outputs

ArrayParticlesInsertElement

This node inserts all elements from the 'element' input into the input 'array' at the position specified by 'position'. If 'position' is equal or lower than 0 then the elements are inserted at the beginning of the array. If 'position' is greater or equal than the inputs 'array' size, elements are appended at the end.

Inputs

Outputs

ArrayParticlesMix

This node creates an output array based on the two inputs 'array0' and 'array1' and the input mask. If the mask value equals 0 then the value of 'array0' is used, if the mask value is 1 the value of 'array1' is used.

The size of the output is the same as mask's size.

Inputs

Outputs

ArrayParticlesPushElement

This node appends all the elements from the 'element' at the end of the input 'array'.

Inputs

Outputs

ArrayParticlesRemoveElement

This node removes all elements of the 'by_value' from the input 'array'. The returned mask has the same size as the input 'array' and is set to 0 at removed positions.

Inputs

Outputs

ArrayParticlesRemoveIndex

This node removes all input array positions by the 'index' input. .

Inputs

Outputs

ArrayParticlesRemoveRepeatedElements

This node removes all repetitions of elements from the input 'array'. The 'new_to_old' array can be used as an 'index' input for a GetArrayElement-Node to restore the original array. The returned mask has the same size as the input 'array' and is set to 0 at removed positions.

Inputs

Outputs

ArrayParticlesResize

This node resizes the input 'array'. If the result is bigger than the input array, the last value is repeated accordingly.

Inputs

Outputs

ArrayParticlesReverse

This node reverses the order of the input 'array'.

Inputs

Outputs

ArrayParticlesSlice

This node returns an array containing the range of the input 'array' from the 'first' position with the given input 'size'.Thus, the output array is a subarray or slice of the input.

Inputs

Outputs

ForceAdd

This node adds a force to the particles in the emitter.

Inputs

Outputs

GetArrayParticlesElement

This node returns the elements of the input 'array' at positions specified by the 'index' parameter.

Inputs

Outputs

GetParticles

This node gets the particles from the input scene node.

Inputs

Outputs

GetParticlesInfo

This node returns information about the input particle system.

Inputs

Outputs

ParticleAdd

This node adds particles using the position and velocity inputs.

The 'position' input is used to add the particles, i.e. the number of particles added is the size of the 'position' input. The 'velocity' input has not to be the same size than the 'position' input, in the case it is larger it will be truncated to the size of the 'position' input, in the case it is shorter the last velocity value in the array is used to set the velocity for the rest of the particles.

Inputs

Outputs

ParticleAddChannel

This node creates a new channel for the particles. The value for the new channel for both existent particles and new particles is set using the 'default value' value. The 'default value' input is necessary. Otherwise, the channel will not be created.

Please, keep in mind that channels with different types than graph types may result in data precission loss when getting and setting its values.

Inputs

Outputs

ParticleCreate

This node creates an empty Particles object inside the graph.

This way it is possible to use particles inside graphs without needing to load them from file, or getting them from an existing node.

Only the'id', 'position' and 'velocity' channels are created.

Outputs

ParticleCreateVoxelization

The algorithm to perform the operation of this node is multithreaded.

This node creates a particles voxelization.

Inputs

Outputs

ParticleDisplaceFromImage

The algorithm to perform the operation of this node is multithreaded.

This node displaces the particles using an image. The particle system must have a "normal" and "uv" channels, both of type "Vector3". In the case of the "uv" channel the component "z" of the "Vector3" is ignored.

Inputs

Outputs

ParticleFilterByVolume

This node splits the input 'inParticles' array into the two output arrays according to the positions of the particles relative to the input axis aligned bounding box.

Inputs

Outputs

ParticleFindNearestNeighbors

The algorithm to perform the operation of this node is multithreaded.

This node gets the particles that satisfied two conditions: they are inside the sphere defined by the radius 'outer radius' and centered at the 'point', and they are outside the sphere defined by the radius 'inner radius' and centered at the 'point'.

Inputs

Outputs

ParticleGetAllChannelNames

This node returns all the input 'particles' channel names and types, which are available.

The channel types are the internal storage types which might not be exactly the same as graph types. For example, the UV channel might store data of type 'Vector2' while getting the UV channel in the graph will result in an array of 'Vector3' elements.

Inputs

Outputs

ParticleGetChannel

This node extracts and copies channel data from the particles to the output channel. Because the channel type is only known at run-time you might need to use a "NumDemux" node to specialize the type of the channel, particularly, if the following connected input can have differente types.

Inputs

Outputs

ParticleMesher

The algorithm to perform the operation of this node is multithreaded.

This node computes a mesh for the input 'particles' according to the specified parameters.

The algorith used for it is the same as for the RealFlow RenderKit mesher.

Inputs

Outputs

ParticleRemoveAll

This node removes all particles from the input particle system.

Inputs

Outputs

ParticleRemoveById

This node removes particles from the input particle system.

Inputs

Outputs

ParticleSetChannel

This node sets the channel value for the particles. The size of the value array can be shorter than the number of particles. In such a case, the last element of the array is used for the rest of particles.

Inputs

Outputs

SetArrayParticlesElement

This node returns the elements of the input 'array' at positions specified by the 'index' parameter.

Inputs

Outputs

SetParticles

This node set the particles of the input RealFlow node. Channels of the current particle system are kept and initialized with default values. New channels from the new particle system are created and copied.

Inputs

Outputs