com.bergerkiller.bukkit.tc.attachments.animation

Class AnimationNode

java.lang.Object

com.bergerkiller.bukkit.tc.attachments.animation.AnimationNode

public class AnimationNode
extends Object

A single keyframe of an animation

Constructor Summary

Constructors

Constructor and Description
AnimationNode(org.bukkit.util.Vector position, com.bergerkiller.bukkit.common.math.Quaternion rotationQuaternion, boolean active, double duration) Initializes a new Animation Node with a position, rotation and duration to the next node.
AnimationNode(org.bukkit.util.Vector position, org.bukkit.util.Vector rotationVector, boolean active, double duration) Initializes a new Animation Node with a position, rotation and duration to the next node.

Method Summary

Modifier and Type	Method and Description
void	apply(com.bergerkiller.bukkit.common.math.Matrix4x4 transform) Applies the position and rotation transformation of this animation node to a 4x4 transformation matrix
double	getDuration() Duration animating from this node to the next one in seconds.
org.bukkit.util.Vector	getPosition() Gets the relative position of this animation node.
com.bergerkiller.bukkit.common.math.Quaternion	getRotationQuaternion() Gets the relative rotation of this animation node as a Quaternion.
org.bukkit.util.Vector	getRotationVector() Gets the relative rotation of this animation node as a Vector.
static AnimationNode	identity() Creates an identity animation node (that does not do anything)
static AnimationNode	interpolate(AnimationNode nodeA, AnimationNode nodeB, double theta) Interpolates two nodes
boolean	isActive() Gets whether the attachment is active during the time this animation node is actively playing.
static AnimationNode[]	parseAllFromStrings(List<String> configList) Parses all nodes in a list of configurations to an array of animation nodes.
static AnimationNode	parseFromString(String config) Parses the contents of an animation node from a configuration String.
String	serializeToString() Serializes the contents of this AnimationNode to a String that parseFromString(String) accepts as input.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimationNode

public AnimationNode(org.bukkit.util.Vector position,
                     com.bergerkiller.bukkit.common.math.Quaternion rotationQuaternion,
                     boolean active,
                     double duration)

Initializes a new Animation Node with a position, rotation and duration to the next node. The rotation is initialized using a Quaternion, with the yaw/pitch/roll rotation vector initialized on first use.

Parameters:

position, - null to deactivate the attachment

rotationQuaternion -

active - whether the attachment is active (and visible) when this node is reached

duration -

AnimationNode

public AnimationNode(org.bukkit.util.Vector position,
                     org.bukkit.util.Vector rotationVector,
                     boolean active,
                     double duration)

Initializes a new Animation Node with a position, rotation and duration to the next node. The rotation is initialized using a yaw/pitch/roll vector, with the quaternion rotation initialized on first use.

Parameters:

position, - null to deactivate the attachment

rotationVector -

active - whether the attachment is active (and visible) when this node is reached

duration -

Method Detail

getPosition

public org.bukkit.util.Vector getPosition()

Gets the relative position of this animation node.

Returns:

relative position

getRotationVector

public org.bukkit.util.Vector getRotationVector()

Gets the relative rotation of this animation node as a Vector. This value is used when displayed to a human, and not for actual calculations during the animation.

Returns:

relative rotation vector (x=pitch, y=yaw, z=roll)

getRotationQuaternion

public com.bergerkiller.bukkit.common.math.Quaternion getRotationQuaternion()

Gets the relative rotation of this animation node as a Quaternion. This value is used when performing the actual calculations during the animation, and is not suitable to display to a human.

Returns:

relative rotation quaternion

getDuration

public double getDuration()

Duration animating from this node to the next one in seconds. For the last node, the duration is used when looping around to the beginning.

Returns:

duration

isActive

public boolean isActive()

Gets whether the attachment is active during the time this animation node is actively playing. An inactive attachment is generally invisible.

Returns:

active

apply

public void apply(com.bergerkiller.bukkit.common.math.Matrix4x4 transform)

Applies the position and rotation transformation of this animation node to a 4x4 transformation matrix

Parameters:

transform -

serializeToString

public String serializeToString()

Serializes the contents of this AnimationNode to a String that parseFromString(String) accepts as input.

Returns:

serialized String

parseFromString

public static AnimationNode parseFromString(String config)

Parses the contents of an animation node from a configuration String. Invalid configuration will produce an identity node.

Parameters:

config -

Returns:

animation node

parseAllFromStrings

public static AnimationNode[] parseAllFromStrings(List<String> configList)

Parses all nodes in a list of configurations to an array of animation nodes.

Parameters:

configList -

Returns:

array of animation nodes with the same length as configList

interpolate

public static AnimationNode interpolate(AnimationNode nodeA,
                                        AnimationNode nodeB,
                                        double theta)

Interpolates two nodes

Parameters:

nodeA -

nodeB -

theta -

Returns:

interpolated node

identity

public static AnimationNode identity()

Creates an identity animation node (that does not do anything)

Returns:

identity