com.jme3.anim.ArmatureMask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jme3-core Show documentation
jMonkeyEngine is a 3-D game engine for adventurous Java developers
The newest version!
/*
 * Copyright (c) 2009-2023 jMonkeyEngine
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jme3.anim;

import java.util.BitSet;

/**
 * An AnimationMask to select joints from a single Armature.
 */
public class ArmatureMask implements AnimationMask {

    final private BitSet affectedJoints = new BitSet();

    /**
     * Instantiate a mask that affects no joints.
     */
    public ArmatureMask() {
        // do nothing
    }

    /**
     * Instantiate a mask that affects all joints in the specified Armature.
     *
     * @param armature the Armature containing the joints (not null, unaffected)
     */
    public ArmatureMask(Armature armature) {
        int numJoints = armature.getJointCount();
        affectedJoints.set(0, numJoints);
    }

    /**
     * Remove all joints affected by the specified ArmatureMask.
     *
     * @param removeMask the set of joints to remove (not null, unaffected)
     * @return this
     */
    public ArmatureMask remove(ArmatureMask removeMask) {
        BitSet removeBits = removeMask.getAffectedJoints();
        affectedJoints.andNot(removeBits);

        return this;
    }

    private BitSet getAffectedJoints() {
        return affectedJoints;
    }

    /**
     * Remove the named joints.
     *
     * @param armature the Armature containing the joints (not null, unaffected)
     * @param jointNames the names of the joints to be removed
     * @return this
     *
     * @throws IllegalArgumentException if it can not find the joint
     *          with the specified name on the provided armature
     */
    public ArmatureMask removeJoints(Armature armature, String... jointNames) {
        for (String jointName : jointNames) {
            Joint joint = findJoint(armature, jointName);
            int jointId = joint.getId();
            affectedJoints.clear(jointId);
        }

        return this;
    }

    @Override
    public boolean contains(Object target) {
        return affectedJoints.get(((Joint) target).getId());
    }

    /**
     * Create an ArmatureMask that selects the named Joint and all its
     * descendants.
     *
     * @param armature the Armature containing the joints (not null)
     * @param fromJoint the name of the ancestor joint
     * @return a new mask
     *
     * @throws IllegalArgumentException if it can not find the joint
     *          with the specified name on the provided armature
     */
    public static ArmatureMask createMask(Armature armature, String fromJoint) {
        ArmatureMask mask = new ArmatureMask();
        mask.addFromJoint(armature, fromJoint);
        return mask;
    }

    /**
     * Create an ArmatureMask that selects the named joints.
     *
     * @param armature the Armature containing the joints (not null)
     * @param joints the names of the joints to be included
     * @return a new mask
     *
     * @throws IllegalArgumentException if it can not find the joint
     *          with the specified name on the provided armature
     */
    public static ArmatureMask createMask(Armature armature, String... joints) {
        ArmatureMask mask = new ArmatureMask();
        mask.addBones(armature, joints);
        return mask;
    }

    /**
     * Add joints to be influenced by this animation mask.
     * 
     * @param armature the Armature containing the joints
     * @param jointNames the names of the joints to be influenced
     *
     * @throws IllegalArgumentException if it can not find the joint
     *          with the specified name on the provided armature
     */
    public void addBones(Armature armature, String... jointNames) {
        for (String jointName : jointNames) {
            Joint joint = findJoint(armature, jointName);
            affectedJoints.set(joint.getId());
        }
    }

    private Joint findJoint(Armature armature, String jointName) {
        Joint joint = armature.getJoint(jointName);
        if (joint == null) {
            throw new IllegalArgumentException("Cannot find joint " + jointName);
        }
        return joint;
    }

    /**
     * Add a joint and all its sub armature joints to be influenced by this animation mask.
     * 
     * @param armature the Armature containing the ancestor joint
     * @param jointName the names of the ancestor joint
     *
     * @throws IllegalArgumentException if it can not find the joint
     *          with the specified name on the provided armature
     */
    public void addFromJoint(Armature armature, String jointName) {
        Joint joint = findJoint(armature, jointName);
        recurseAddJoint(joint);
    }

    private void recurseAddJoint(Joint joint) {
        affectedJoints.set(joint.getId());
        for (Joint j : joint.getChildren()) {
            recurseAddJoint(j);
        }
    }

    /**
     * Add the specified Joint and all its ancestors.
     *
     * @param start the starting point (may be null, unaffected)
     * @return this
     */
    public ArmatureMask addAncestors(Joint start) {
        for (Joint cur = start; cur != null; cur = cur.getParent()) {
            int jointId = cur.getId();
            affectedJoints.set(jointId);
        }

        return this;
    }

    /**
     * Remove the specified Joint and all its ancestors.
     *
     * @param start the starting point (may be null, unaffected)
     * @return this
     */
    public ArmatureMask removeAncestors(Joint start) {
        for (Joint cur = start; cur != null; cur = cur.getParent()) {
            int jointId = cur.getId();
            affectedJoints.clear(jointId);
        }

        return this;
    }
}