hmi.facegraphics.HMIFaceController.java Source code

Introduction

Here is the source code for hmi.facegraphics.HMIFaceController.java

Source

/*******************************************************************************
 * The MIT License (MIT)
 * Copyright (c) 2015 University of Twente
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *******************************************************************************/
package hmi.facegraphics;

import hmi.faceanimation.FaceController;
import hmi.faceanimation.MorphTargetHandler;
import hmi.faceanimation.model.FAP;
import hmi.faceanimation.model.MPEG4;
import hmi.faceanimation.model.MPEG4Configuration;
import hmi.graphics.opengl.scenegraph.GLScene;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;

import lombok.Delegate;

import com.google.common.collect.ImmutableMap;

/**
 * The FaceController is the access point for deforming the face of an avatar, just like VJoints are the accesspoint for deforming its body.
 * 
 * This implementation controls the face of an avatar displayed in the HMI rendering environment.
 * 
 * 
 */
public class HMIFaceController implements FaceController {

    /** Used to control morph targets... */
    private GLScene theGLScene;
    private Collection<String> possibleFaceMorphTargetNames = new ArrayList<String>();

    @Delegate
    private MorphTargetHandler morphTargetHandler = new MorphTargetHandler();

    /** store the current config, for add- and remove-mpeg4configuration */
    private MPEG4Configuration currentConfig = new MPEG4Configuration();
    private GLHead glHead;

    private ArrayList<HMIFaceControllerListener> listeners = new ArrayList<HMIFaceControllerListener>();

    /**
     * This constructor needs to get a link to the face and its morph targets! Maybe the GLScene, for setting morph targets, and some of Ronald Paul's
     * stuff, for controlling FAPs
     */
    public HMIFaceController(GLScene gls, GLHead h) {
        theGLScene = gls;
        glHead = h;
    }

    public synchronized void setMPEG4Configuration(MPEG4Configuration config) {
        currentConfig.setValues(Arrays.copyOf(config.getValues(), config.getValues().length));
        notifyFaceControllerListeners();
    }

    public synchronized void addMPEG4Configuration(MPEG4Configuration config) {
        currentConfig.addValues(config);
        notifyFaceControllerListeners();
    }

    public synchronized void removeMPEG4Configuration(MPEG4Configuration config) {
        currentConfig.removeValues(config);
        notifyFaceControllerListeners();
    }

    public Collection<String> getPossibleFaceMorphTargetNames() {
        return possibleFaceMorphTargetNames;
    }

    public void setPossibleFaceMorphTargetNames(Collection<String> names) {
        possibleFaceMorphTargetNames = names;
    }

    /**
     * NOTE: this function should be called in some synchronisation; to ensure that the values are not changed during the copy method!
     */
    public synchronized void copy() {
        if (glHead != null) {
            // send the new MPEG4 configuration
            for (FAP fap : MPEG4.getFAPs().values()) {
                Integer value = currentConfig.getValue(fap.getIndex());
                if (value == null)
                    continue;
                glHead.getDeformer(fap).setValue(value);
            }
            glHead.deformWhenScheduled();
        }

        ImmutableMap<String, Float> desiredMorphTargets = morphTargetHandler.getDesiredMorphTargets();
        String[] targetNames = new String[desiredMorphTargets.size()];
        float[] targetWeights = new float[desiredMorphTargets.size()];
        int i = 0;
        for (String targetName : desiredMorphTargets.keySet()) {
            targetNames[i] = targetName;
            targetWeights[i] = desiredMorphTargets.get(targetName);
            i++;
        }
        theGLScene.setMorphTargets(targetNames, targetWeights);
    }

    /*
     * ====================================================== Methods and attributes for maintaining a set of desired morph targets. - Add and remove
     * weight from each target using addMorphTargets() and removeMorphTargets() - have GLScene execute the current set of targets and weights by
     * calling doMorph() ==================================================
     */

    public void addFaceControllerListener(HMIFaceControllerListener fcl) {
        synchronized (listeners) {
            listeners.add(fcl);
        }
    }

    public void removeFaceControllerListener(HMIFaceControllerListener fcl) {
        synchronized (listeners) {
            listeners.remove(fcl);
        }
    }

    private void notifyFaceControllerListeners() {
        synchronized (listeners) {
            for (HMIFaceControllerListener fcl : listeners) {
                fcl.setMPEG4Configuration(currentConfig);
            }
        }
    }
}