Package toxi.physics3d

Class VerletParticle3D

java.lang.Object

toxi.geom.Vec3D

toxi.physics3d.VerletParticle3D

All Implemented Interfaces:

Comparable<ReadonlyVec3D>, ReadonlyVec3D

public class VerletParticle3D
extends Vec3D

An individual 3D particle for use by the VerletPhysics and VerletSpring classes. A particle has weight, can be locked in space and its position constrained inside an (optional) axis-aligned bounding box.

Nested Class Summary

Nested classes/interfaces inherited from class toxi.geom.Vec3D

Vec3D.Axis

Field Summary

Fields

Modifier and Type	Field	Description
List<ParticleBehavior3D>	behaviors
AABB	bounds	Bounding box, by default set to null to disable
List<ParticleConstraint3D>	constraints	An optional particle constraints, called immediately after a particle is updated (and only used if particle is unlocked (default)

Fields inherited from class toxi.geom.Vec3D

MAX_VALUE, MIN_VALUE, NEG_MAX_VALUE, x, X_AXIS, y, Y_AXIS, z, Z_AXIS, ZERO

Constructor Summary

Constructors

Constructor	Description
VerletParticle3D(float x, float y, float z)	Creates particle at position xyz
VerletParticle3D(float x, float y, float z, float w)	Creates particle at position xyz with weight w
VerletParticle3D(ReadonlyVec3D v)	Creates particle at the position of the passed in vector
VerletParticle3D(ReadonlyVec3D v, float w)	Creates particle with weight w at the position of the passed in vector
VerletParticle3D(VerletParticle3D p)	Creates a copy of the passed in particle

Method Summary

Modifier and Type	Method	Description
VerletParticle3D	addBehavior(ParticleBehavior3D behavior)
VerletParticle3D	addBehavior(ParticleBehavior3D behavior, float timeStep)
VerletParticle3D	addConstraint(ParticleConstraint3D c)	Adds the given constraint implementation to the list of constraints applied to this particle at each time step.
VerletParticle3D	addForce(Vec3D f)
VerletParticle3D	addVelocity(Vec3D v)
void	applyBehaviors()
void	applyConstraints()
VerletParticle3D	clearConstraints()	Removes any currently applied constraints from this particle.
VerletParticle3D	clearForce()
VerletParticle3D	clearVelocity()
final float	getInvWeight()
Vec3D	getPreviousPosition()	Returns the particle's position at the most recent time step.
Vec3D	getVelocity()
final float	getWeight()
final boolean	isLocked()
VerletParticle3D	lock()	Locks/immobilizes particle in space
boolean	removeBehavior(ParticleBehavior3D b)
boolean	removeConstraint(ParticleConstraint3D c)	Attempts to remove the given constraint instance from the list of active constraints.
VerletParticle3D	scaleVelocity(float scl)
VerletParticle3D	setPreviousPosition(Vec3D p)
void	setWeight(float w)
VerletParticle3D	unlock()	Unlocks particle again
void	update()

Methods inherited from class toxi.geom.Vec3D

abs, add, add, add, addSelf, addSelf, addSelf, angleBetween, angleBetween, clear, compareTo, constrain, constrain, copy, cross, cross, crossInto, crossSelf, distanceTo, distanceToSquared, dot, dot, equals, equals, equalsWithTolerance, floor, frac, fromXYTheta, fromXZTheta, fromYZTheta, getAbs, getCartesian, getClosestAxis, getComponent, getComponent, getConstrained, getFloored, getFrac, getInverted, getLimited, getMapped, getNormalized, getNormalizedTo, getReciprocal, getReflected, getRotatedAroundAxis, getRotatedX, getRotatedY, getRotatedZ, getRoundedTo, getSignum, getSpherical, hashCode, headingXY, headingXZ, headingYZ, immutable, interpolateTo, interpolateTo, interpolateTo, interpolateTo, interpolateToSelf, interpolateToSelf, invert, isInAABB, isInAABB, isMajorAxis, isZeroVector, jitter, jitter, jitter, jitter, jitter, jitter, limit, magnitude, magSquared, max, maxSelf, min, minSelf, modSelf, modSelf, normalize, normalizeTo, randomVector, randomVector, reciprocal, reflect, rotateAroundAxis, rotateX, rotateY, rotateZ, roundTo, scale, scale, scale, scale, scaleSelf, scaleSelf, scaleSelf, scaleSelf, set, set, set, setComponent, setComponent, setX, setXY, setY, setZ, shuffle, signum, snapToAxis, sub, sub, sub, subSelf, subSelf, subSelf, to2DXY, to2DXZ, to2DYZ, to4D, to4D, toArray, toArray4, toCartesian, toSpherical, toString, x, y, z

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

bounds

public AABB bounds

Bounding box, by default set to null to disable

constraints

public List<ParticleConstraint3D> constraints

An optional particle constraints, called immediately after a particle is updated (and only used if particle is unlocked (default)

behaviors

public List<ParticleBehavior3D> behaviors

Constructor Details

VerletParticle3D

public VerletParticle3D(float x,
 float y,
 float z)

Creates particle at position xyz

Parameters:

x -

y -

z -

VerletParticle3D

public VerletParticle3D(float x,
 float y,
 float z,
 float w)

Creates particle at position xyz with weight w

Parameters:

x -

y -

z -

w -

VerletParticle3D

public VerletParticle3D(ReadonlyVec3D v)

Creates particle at the position of the passed in vector

Parameters:

v - position

VerletParticle3D

public VerletParticle3D(ReadonlyVec3D v,
 float w)

Creates particle with weight w at the position of the passed in vector

Parameters:

v - position

w - weight

VerletParticle3D

public VerletParticle3D(VerletParticle3D p)

Creates a copy of the passed in particle

Parameters:

p -

Method Details

addBehavior

public VerletParticle3D addBehavior(ParticleBehavior3D behavior)

addBehavior

public VerletParticle3D addBehavior(ParticleBehavior3D behavior,
 float timeStep)

addConstraint

public VerletParticle3D addConstraint(ParticleConstraint3D c)

Adds the given constraint implementation to the list of constraints applied to this particle at each time step.

Parameters:

c - constraint instance

Returns:

itself

addForce

public VerletParticle3D addForce(Vec3D f)

addVelocity

public VerletParticle3D addVelocity(Vec3D v)

applyBehaviors

public void applyBehaviors()

applyConstraints

public void applyConstraints()

clearConstraints

public VerletParticle3D clearConstraints()

Removes any currently applied constraints from this particle.

Returns:

itself

clearForce

public VerletParticle3D clearForce()

clearVelocity

public VerletParticle3D clearVelocity()

getInvWeight

public final float getInvWeight()

Returns:

the inverse weight (1/weight)

getPreviousPosition

public Vec3D getPreviousPosition()

Returns the particle's position at the most recent time step.

Returns:

previous position

getVelocity

public Vec3D getVelocity()

getWeight

public final float getWeight()

Returns:

the weight

isLocked

public final boolean isLocked()

Returns:

true, if particle is locked

lock

public VerletParticle3D lock()

Locks/immobilizes particle in space

Returns:

itself

removeBehavior

public boolean removeBehavior(ParticleBehavior3D b)

removeConstraint

public boolean removeConstraint(ParticleConstraint3D c)

Attempts to remove the given constraint instance from the list of active constraints.

Parameters:

c - constraint to remove

Returns:

true, if successfully removed

scaleVelocity

public VerletParticle3D scaleVelocity(float scl)

setPreviousPosition

public VerletParticle3D setPreviousPosition(Vec3D p)

setWeight

public void setWeight(float w)

unlock

public VerletParticle3D unlock()

Unlocks particle again

Returns:

itself

update

public void update()