org.jmol.util

Class Vibration

java.lang.Object

javajs.util.T3

javajs.util.V3

org.jmol.util.Vibration

All Implemented Interfaces:

java.io.Serializable, javajs.api.JSONEncodable

Direct Known Subclasses:

ModulationSet

public class Vibration
extends javajs.util.V3

A class to allow for more complex vibrations and associated phenomena, such as modulated crystals. In the case of modulations, ModulationSet extends Vibration and is implemented that way, and, as well, magnetic spin is also a form of Vibration that may have an associated ModulationSet, as indicated here

Author:

Bob Hanson hansonr@stolaf.edu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	modDim modDim will be > 0 for modulation
float	modScale
protected static double	twoPI
static int	TYPE_SPIN
static int	TYPE_VIBRATION

Fields inherited from class javajs.util.T3

x, y, z

Constructor Summary

Constructors

Constructor and Description
Vibration()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
void	getInfo(java.util.Map<java.lang.String,java.lang.Object> info)
boolean	isNonzero()
void	setTempPoint(javajs.util.T3 pt, javajs.util.T3 t456, float scale, float modulationScale)
Vibration	setType(int type)
void	setXYZ(javajs.util.T3 vib)

Methods inherited from class javajs.util.V3

angle, new3, newV, newVsub

Methods inherited from class javajs.util.T3

add, add2, add3, ave, cross, distance, distanceSquared, dot, equals, floatToIntBits0, hashCode, length, lengthSquared, normalize, scale, scaleAdd2, scaleT, set, setA, setT, sub, sub2, toJSON, toString

Methods inherited from class java.lang.Object

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

Field Detail

twoPI

protected static final double twoPI

See Also:

Constant Field Values

TYPE_VIBRATION

public static final int TYPE_VIBRATION

See Also:

Constant Field Values

TYPE_SPIN

public static final int TYPE_SPIN

See Also:

Constant Field Values

modDim

public int modDim

modDim will be > 0 for modulation

modScale

public float modScale

Constructor Detail

Vibration

public Vibration()

Method Detail

setTempPoint

public void setTempPoint(javajs.util.T3 pt,
                         javajs.util.T3 t456,
                         float scale,
                         float modulationScale)

Parameters:

pt -

t456 -

scale -

modulationScale -

getInfo

public void getInfo(java.util.Map<java.lang.String,java.lang.Object> info)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setXYZ

public void setXYZ(javajs.util.T3 vib)

setType

public Vibration setType(int type)

isNonzero

public boolean isNonzero()