ZibraSmokeAndFireVoid Class Reference

Manipulator that used to remove Smoke and/or Fuel. More...

Public Types
enum	ManipulatorType {   None , Emitter , Void , ForceField ,   AnalyticCollider , NeuralCollider , GroupCollider , Detector ,   SpeciesModifier , EffectParticleEmitter , TextureEmitter , TypeNum }
	Manipulator types. More...

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

Public Attributes
float	ColorDecay = 0.95f
	Controls how quickly the amount of smoke or fuel is decreasing.
float	VelocityDecay = 0.95f
	Controls how quickly the velocity of the smoke or fire is decreasing each frame.
float	Pressure = -0.05f
	This parameter controls how much pressure to add to the given region.

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

Manipulator that used to remove Smoke and/or Fuel.

You don’t necessarily need to remove them manually, and just set up smoke/fuel to dissipate.

Voids can create negative pressure, pulling smoke/fuel inside.

Member Enumeration Documentation

ManipulatorType

enum ManipulatorType

inherited

Manipulator types.

Member Function Documentation

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.

GetManipulatorType()

override ManipulatorType GetManipulatorType ( )

inlinevirtual

Returns the manipulator type.

Reimplemented from Manipulator.

NotifyChange()

void NotifyChange ( )

inlineinherited

(Editor only) Triggers custom editor update.

Just triggers OnChanged.

Member Data Documentation

ColorDecay

float ColorDecay = 0.95f

Controls how quickly the amount of smoke or fuel is decreasing.

1.0 will have no decay, 0.5 will remove half of the total density each simulation iteration.

VelocityDecay

float VelocityDecay = 0.95f

Controls how quickly the velocity of the smoke or fire is decreasing each frame.

1.0 will have no decay, 0.5 will remove half of the velocity each simulation iteration.

Pressure

float Pressure = -0.05f

This parameter controls how much pressure to add to the given region.

Negative values will suck in the smoke, positive values will move the smoke away.

AllManipulators

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

staticinherited

List of all enabled manipulators.

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/Smoke and Fire/Scripts/Solver/Manipulators/ZibraSmokeAndFireVoid.cs