raft.jpct.bones

Class AnimatedGroup

java.lang.Object

raft.jpct.bones.AnimatedGroup

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Animated3D>

public class AnimatedGroup
extends Object
implements Serializable, Iterable<Animated3D>, Cloneable

Helper class to group Animated3D's and manipulate them easily.

Author:

hakan eryargi (r a f t)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	MESH_DONT_REUSE Use a separate mesh.
static boolean	MESH_REUSE Re-use (share) the mesh.

Constructor Summary

Constructors

Constructor and Description
AnimatedGroup(Animated3D... objects) Creates a new AnimatedGroup out of given objects.

Method Summary

Modifier and Type	Method and Description
void	addToWorld(World world) Adds all animated objects to world.
void	animatePose(float index, int sequence) Same as animatePose(float, int, 1)
void	animatePose(float index, int sequence, float weight) Animates this group using assigned PoseClipSequence.
void	animateSkin(float index, int sequence) Animates this object group using assigned SkinClipSequence.
void	applyAnimation() Calls applyAnimation() on each of objects.
void	applySkeletonPose() calls Animated3D.applySkeletonPose() on each of objects.
AnimatedGroup	clone() Same as clone(MESH_REUSE)
AnimatedGroup	clone(boolean reuseMesh) Clones this object group.
Animated3D	get(int index) Returns the specified object
Animated3D	get(String name) Returns the first object with given name.
PoseClipSequence	getPoseClipSequence() Returns the assigned ClipSequence if any.
Object3D	getRoot() Returns root object that all animated objects are added as child.
int	getSize() returns number of objects in this group
SkinClipSequence	getSkinClipSequence() Returns the assigned ClipSequence if any.
boolean	isAutoApplyAnimation() Returns if animateXX methods are automatically applied.
Iterator<Animated3D>	iterator() Returns an iterator of Animated3D objects.
static AnimatedGroup	mergeAnimations(AnimatedGroup... groups) Merge many identical AnimatedGroups with different animations into one.
static AnimatedGroup	mergeGroups(AnimatedGroup... groups) Merge many AnimatedGroups with same animations into one.
void	removeFromWorld(World world) Removes all animated objects to world.
void	resetAnimation() calls resetAnimation() on each of objects.
void	setAutoApplyAnimation(boolean autoApplyAnimation) Sets if animateXX methods are automatically applied.
void	setPoseClipSequence(PoseClipSequence poseClipSequence) Sets the SkinClipSequence of this group.
void	setSkeletonPose(SkeletonPose currentPose) calls Animated3D.setSkeletonPose(SkeletonPose) on each of objects.
void	setSkinClipSequence(SkinClipSequence clipSequence) Sets the SkinClipSequence of this group.
void	setVisibility(boolean visible) Sets visibility of all objects in group.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

MESH_REUSE

public static final boolean MESH_REUSE

Re-use (share) the mesh.

See Also:

Constant Field Values

MESH_DONT_REUSE

public static final boolean MESH_DONT_REUSE

Use a separate mesh.

See Also:

Constant Field Values

Constructor Detail

AnimatedGroup

public AnimatedGroup(Animated3D... objects)

Creates a new AnimatedGroup out of given objects. All objects must have the same Skeleton.

Throws:

IllegalArgumentException - if object array is empty or they have different skeletons.

See Also:

Animated3D.mergeAnimations(Animated3D...)

Method Detail

getRoot

public Object3D getRoot()

Returns root object that all animated objects are added as child. Root object is a dummy object, it isn't added to world. To translate/rotate the whole group, it's enough to apply translation/rotation to root object.

get

public Animated3D get(int index)

Returns the specified object

get

public Animated3D get(String name)

Returns the first object with given name.

Throws:

NoSuchElementException - if object not found

addToWorld

public void addToWorld(World world)

Adds all animated objects to world.

See Also:

World.addObject(Object3D)

removeFromWorld

public void removeFromWorld(World world)

Removes all animated objects to world.

See Also:

World.removeObject(Object3D)

getSkinClipSequence

public SkinClipSequence getSkinClipSequence()

Returns the assigned ClipSequence if any.

setSkinClipSequence

public void setSkinClipSequence(SkinClipSequence clipSequence)

Sets the SkinClipSequence of this group. The skeleton of ClipSequence must be the same of this group.

This method is analogue of Object3D.setAnimationSequence(com.threed.jpct.Animation).

Throws:

IllegalArgumentException - if given ClipSequence has a different Skeleton

See Also:

mergeAnimations(AnimatedGroup...)

getPoseClipSequence

public PoseClipSequence getPoseClipSequence()

Returns the assigned ClipSequence if any.

setPoseClipSequence

public void setPoseClipSequence(PoseClipSequence poseClipSequence)

Sets the SkinClipSequence of this group. The skeleton of ClipSequence must be the same of this group.

This method is analogue of Object3D.setAnimationSequence(com.threed.jpct.Animation).

Throws:

IllegalArgumentException - if given ClipSequence has a different Skeleton

See Also:

mergeAnimations(AnimatedGroup...)

animateSkin

public void animateSkin(float index,
                        int sequence)

Animates this object group using assigned SkinClipSequence. Updates curentPose once and if "auto apply animation" is enabled calls Animated3D.applySkeletonPose() on each of objects.

This method behaves similar to Object3D.animate(float, int).

See Also:

SkinClipSequence, Animated3D.animateSkin(float, int), setAutoApplyAnimation(boolean), Object3D.animate(float, int)

applySkeletonPose

public void applySkeletonPose()

calls Animated3D.applySkeletonPose() on each of objects.

See Also:

Animated3D.applySkeletonPose()

setSkeletonPose

public void setSkeletonPose(SkeletonPose currentPose)

calls Animated3D.setSkeletonPose(SkeletonPose) on each of objects.

See Also:

Animated3D.setSkeletonPose(SkeletonPose)

isAutoApplyAnimation

public boolean isAutoApplyAnimation()

Returns if animateXX methods are automatically applied.

See Also:

animatePose(float, int), animateSkin(float, int)

setAutoApplyAnimation

public void setAutoApplyAnimation(boolean autoApplyAnimation)

Sets if animateXX methods are automatically applied. Also calls setAutoApplyAnimation on each of objects. Default is true.

To enable animation blending automatic applying must be disabled.

See Also:

animatePose(float, int), animateSkin(float, int)

setVisibility

public void setVisibility(boolean visible)

Sets visibility of all objects in group.

applyAnimation

public void applyAnimation()

Calls applyAnimation() on each of objects.

See Also:

Animated3D.applyAnimation()

resetAnimation

public void resetAnimation()

calls resetAnimation() on each of objects.

See Also:

Animated3D.resetAnimation()

animatePose

public void animatePose(float index,
                        int sequence)

Same as animatePose(float, int, 1)

animatePose

public void animatePose(float index,
                        int sequence,
                        float weight)

Animates this group using assigned PoseClipSequence. Updates curentPose and if "auto apply animation" is enabled calls applySkeletonPose()

Pose animations are cumulative if "auto apply animation" is disabled. Each call to this method cancels previous skin animation.

Parameters:

sequence - the number of PoseClip in PoseClipSequence. 1 is the first sequence. 0 means whole PoseClipSequence

index - time index

weight - how much animation will be applied. 1 means as it is

See Also:

SkinClipSequence, Object3D.animate(float, int), setAutoApplyAnimation(boolean)

iterator

public Iterator<Animated3D> iterator()

Returns an iterator of Animated3D objects.

Specified by:

iterator in interface Iterable<Animated3D>

getSize

public int getSize()

returns number of objects in this group

mergeAnimations

public static AnimatedGroup mergeAnimations(AnimatedGroup... groups)

Merge many identical AnimatedGroups with different animations into one. This method does not require all AnimatedGroups share the same Skeleton but skeletons are almost identical.

If many AnimatedGroups are loaded from different files, their skeleton objects will be different even if they are identical. This method is meant to help such cases.

This method always uses the skeleton of first group.

See Also:

Animated3D.mergeAnimations(Animated3D...), SkinClipSequence.merge(SkinClipSequence...)

mergeGroups

public static AnimatedGroup mergeGroups(AnimatedGroup... groups)

Merge many AnimatedGroups with same animations into one. This method does not require all AnimatedGroups share the same Skeleton but skeletons are almost identical.

This method does not actually check animations are the same but only checks Skeleton's are identical. So if animations differ the merged group will behave strange.

This method is used to merge groups where animations are identical. If you want to merge AnimetedGroup's instead of animations use mergeGroups(AnimatedGroup...).

This method always uses the skeleton and animations of first group.

See Also:

Animated3D.mergeAnimations(Animated3D...), SkinClipSequence.merge(SkinClipSequence...)

clone

public AnimatedGroup clone()

Same as clone(MESH_REUSE)

Overrides:

clone in class Object

See Also:

clone(boolean)

clone

public AnimatedGroup clone(boolean reuseMesh)

Clones this object group. Skeleton, SkeletonPose, SkinClipSequence PoseClipSequence will be shared. If the mesh is reused, the clone and master will inherit animations from each other.

See Also:

Animated3D.Animated3D(Animated3D, boolean), MESH_REUSE, MESH_DONT_REUSE