ZibraLiquidSpeciesModifier Class Reference

Modifies particle species of particles. More...

Public Types
enum	InteractionMode { AllParticleSpecies , OnlySelectedParticleSpecies , ExceptSelectedParticleSpecies }
	See CurrentInteractionMode. More...
enum	ManipulatorType {   Emitter , Void , ForceField , AnalyticCollider ,   NeuralCollider , GroupCollider , Detector , SpeciesModifier ,   HeightmapCollider , TypeNum }
	Manipulator types. More...

Public Member Functions
override ManipulatorType	GetManipulatorType ()
	Returns manipulator type.
override Color	GetGizmosColor ()
	(Editor only) Returns gizmo color that should be used with current manipulator.
void	NotifyChange ()
	(Editor only) Triggers custom editor update.

Public Attributes
int	TargetSpecie = 0
	New specie particles will get.
float	Probability = 1.0f
	Probability of change per frame.
InteractionMode	CurrentInteractionMode = InteractionMode.AllParticleSpecies
	Defines which particle species will interact with manipulator.
int	ParticleSpecies = 0
	Selects particle species for CurrentInteractionMode.

Static Public Attributes
static readonly List< Manipulator >	AllManipulators = new List<Manipulator>()
	List of all enabled manipulators.

Events
Action	OnChanged
	(Editor only) Event that is triggered when state of manipulator changes to trigger update of custom editor.

Detailed Description

Modifies particle species of particles.

Particle that enters species modifiers shape, changes its species to selected one.

Member Enumeration Documentation

InteractionMode

enum InteractionMode

inherited

See CurrentInteractionMode.

ManipulatorType

enum ManipulatorType

inherited

Manipulator types.

Member Function Documentation

GetManipulatorType()

override ManipulatorType GetManipulatorType ( )

inlinevirtual

Returns manipulator type.

Implements Manipulator.

GetGizmosColor()

override Color GetGizmosColor ( )

inlinevirtual

(Editor only) Returns gizmo color that should be used with current manipulator.

This is needed since SDFs can be used with any manipulators, but we don't want SDFs to draw gizmos in same color for different types of manipulators.

Implements Manipulator.

NotifyChange()

void NotifyChange ( )

inlineinherited

(Editor only) Triggers custom editor update.

Just triggers OnChanged.

Member Data Documentation

TargetSpecie

int TargetSpecie = 0

New specie particles will get.

Probability

float Probability = 1.0f

Probability of change per frame.

AllManipulators

readonly List<Manipulator> AllManipulators = new List<Manipulator>()

staticinherited

List of all enabled manipulators.

CurrentInteractionMode

InteractionMode CurrentInteractionMode = InteractionMode.AllParticleSpecies

inherited

Defines which particle species will interact with manipulator.

ParticleSpecies

int ParticleSpecies = 0

inherited

Selects particle species for CurrentInteractionMode.

Has no effect when CurrentInteractionMode is set to AllParticleSpecies.

Event Documentation

OnChanged

Action OnChanged

inherited

(Editor only) Event that is triggered when state of manipulator changes to trigger update of custom editor.

This is only intended to update custom editors, You can trigger it when you change some state to update custom editor. But using it for anything else is a bad idea.

---

The documentation for this class was generated from the following file:

• Assets/Plugins/Zibra/Liquid/Scripts/Solver/Manipulators/ZibraLiquidSpeciesModifier.cs