Package foundry.veil.api.quasar.data.module.force

Class VortexForceData

java.lang.Object

foundry.veil.api.quasar.data.module.force.VortexForceData

All Implemented Interfaces:

EditorAttributeProvider, ParticleModuleData

public final class VortexForceData
extends Object
implements ParticleModuleData, EditorAttributeProvider

A force that applies a vortex force to a particle.

Vortex forces are forces that are applied in a circular motion around a center point. They are useful for simulating whirlpools or tornadoes. The strength of the force is determined by the strength parameter. The falloff parameter determines how quickly the force falls off with distance. (unused)

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<VortexForceData>	CODEC

Fields inherited from interface foundry.veil.api.quasar.data.module.ParticleModuleData

DIRECT_CODEC, INIT_CODEC, INIT_DIRECT_CODEC, RENDER_CODEC, RENDER_DIRECT_CODEC, UPDATE_CODEC, UPDATE_DIRECT_CODEC

Constructor Summary

Constructors

Constructor	Description
VortexForceData(org.joml.Vector3dc vortexAxis, org.joml.Vector3dc vortexCenter, boolean localPosition, double range, float strength)

Method Summary

Modifier and Type	Method	Description
void	addModules(ParticleModuleSet.Builder builder)
ModuleType<?>	getType()
boolean	localPosition()
double	range()
void	renderImGuiAttributes()	Renders all ImGui attributes into the current editor panel.
float	strength()
org.joml.Vector3dc	vortexAxis()
org.joml.Vector3dc	vortexCenter()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<VortexForceData> CODEC

Constructor Details

VortexForceData

public VortexForceData(org.joml.Vector3dc vortexAxis,
 org.joml.Vector3dc vortexCenter,
 boolean localPosition,
 double range,
 float strength)

Method Details

addModules

public void addModules(ParticleModuleSet.Builder builder)

Specified by:

addModules in interface ParticleModuleData

getType

public ModuleType<?> getType()

Specified by:

getType in interface ParticleModuleData

renderImGuiAttributes

public void renderImGuiAttributes()

Description copied from interface: EditorAttributeProvider

Renders all ImGui attributes into the current editor panel.

Specified by:

renderImGuiAttributes in interface EditorAttributeProvider

vortexAxis

public org.joml.Vector3dc vortexAxis()

vortexCenter

public org.joml.Vector3dc vortexCenter()

localPosition

public boolean localPosition()

range

public double range()

strength

public float strength()