Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class Vertex

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.Vertex

All Implemented Interfaces:

ConstJoltPhysicsObject, ConstVertex, AutoCloseable, Comparable<JoltPhysicsObject>

public class Vertex
extends JoltPhysicsObject
implements ConstVertex

Attributes of a particle, for use during the creation of a soft body. (native type: SoftBodySharedSettings::Vertex)

Constructor Summary

Constructors

Constructor	Description
Vertex()	Instantiate a default vertex.
Vertex(ConstVertex original)	Instantiate a copy of the specified vertex.

Method Summary

Modifier and Type	Method	Description
float	getInvMass()	Return the inverse mass.
Float3	getPosition()	Copy the initial location.
Float3	getVelocity()	Copy the initial velocity.
Vertex	set(ConstVertex source)	Copy the argument to the current vertex.
Vertex	setInvMass(float invMass)	Alter the inverse mass.
Vertex	setPosition(float x, float y, float z)	Alter the initial location of the vertex.
Vertex	setPosition(ConstFloat3 location)	Alter the initial location of the vertex.
Vertex	setPosition(Vec3Arg location)	Alter the initial location of the vertex.
Vertex	setVelocity(float x, float y, float z)	Alter the initial velocity of the vertex.
Vertex	setVelocity(ConstFloat3 velocity)	Alter the initial velocity of the vertex.
Vertex	setVelocity(Vec3Arg velocity)	Alter the initial velocity of the vertex.
String	toString()	Return a string representation of the vertex, which is unaffected.

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Constructor Details

Vertex

public Vertex()

Instantiate a default vertex.

Vertex

public Vertex(ConstVertex original)

Instantiate a copy of the specified vertex.

Parameters:

original - the vertex to copy (not null, unaffected)

Method Details

set

public Vertex set(ConstVertex source)

Copy the argument to the current vertex.

Parameters:

source - the vertex to copy (not null, unaffected)

Returns:

the modified current vertex, for chaining

setInvMass

public Vertex setInvMass(float invMass)

Alter the inverse mass. (native attribute: mInvMass)

Parameters:

invMass - the desired inverse mass (in 1/kilograms, default=1)

Returns:

the modified vertex, for chaining

setPosition

public Vertex setPosition(ConstFloat3 location)

Alter the initial location of the vertex. (native attribute: mPosition)

Parameters:

location - the desired location (not null, unaffected default=(0,0,0))

Returns:

the modified vertex, for chaining

setPosition

public Vertex setPosition(float x,
 float y,
 float z)

Alter the initial location of the vertex. (native attribute: mPosition)

Parameters:

x - the desired X coordinate (default=0)

y - the desired Y coordinate (default=0)

z - the desired Z coordinate (default=0)

Returns:

the modified vertex, for chaining

setPosition

public Vertex setPosition(Vec3Arg location)

Alter the initial location of the vertex. (native attribute: mPosition)

Parameters:

location - the desired location (not null, unaffected default=(0,0,0))

Returns:

the modified vertex, for chaining

setVelocity

public Vertex setVelocity(ConstFloat3 velocity)

Alter the initial velocity of the vertex. (native attribute: mVelocity)

Parameters:

velocity - the desired velocity (in meters per second, not null, unaffected default=(0,0,0))

Returns:

the modified vertex, for chaining

setVelocity

public Vertex setVelocity(float x,
 float y,
 float z)

Alter the initial velocity of the vertex. (native attribute: mVelocity)

Parameters:

x - the desired X component (default=0)

y - the desired Y component (default=0)

z - the desired Z component (default=0)

Returns:

the modified vertex, for chaining

setVelocity

public Vertex setVelocity(Vec3Arg velocity)

Alter the initial velocity of the vertex. (native attribute: mVelocity)

Parameters:

velocity - the desired velocity (in meters per second, not null, unaffected, default=(0,0,0))

Returns:

the modified vertex, for chaining

getInvMass

public float getInvMass()

Return the inverse mass. The vertex is unaffected. (native attribute: mInvMass)

Specified by:

getInvMass in interface ConstVertex

Returns:

the inverse of the mass (in 1/kilograms)

getPosition

public Float3 getPosition()

Copy the initial location. The vertex is unaffected. (native attribute: mPosition)

Specified by:

getPosition in interface ConstVertex

Returns:

a new location vector

getVelocity

public Float3 getVelocity()

Copy the initial velocity. The vertex is unaffected. (native attribute: mVelocity)

Specified by:

getVelocity in interface ConstVertex

Returns:

a new velocity vector (in meters per second)

toString

public String toString()

Return a string representation of the vertex, which is unaffected. For example:

 Vertex{(0.0 2.0 0.0) v(0.0 -1.0 0.0) im=0.5}
 

Overrides:

toString in class JoltPhysicsObject

Returns:

the string representation (not null, not empty)