engine/src/ogre/com/jme3/scene/plugins/ogre/matext/OgreMaterialKey.java

/*
 * Copyright (c) 2009-2012 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.scene.plugins.ogre.matext;

import com.jme3.asset.AssetKey;
import com.jme3.material.MaterialList;

/**
 * <code>OgreMaterialKey</code> allows specifying material extensions,
 * which map from Ogre3D base materials to jME3 materials
 */
public class OgreMaterialKey extends AssetKey<MaterialList> {

    private MaterialExtensionSet matExts;

    public OgreMaterialKey(String name){
        super(name);
    }

    public OgreMaterialKey(){
        super();
    }

    /**
     * Set the {@link MaterialExtensionSet} to use for mapping
     * base materials to jME3 matdefs when loading.
     * Set to <code>null</code> to disable this functionality.
     *
     * @param matExts The {@link MaterialExtensionSet} to use
     */
    public void setMaterialExtensionSet(MaterialExtensionSet matExts){
        this.matExts = matExts;
    }

    /**
     * Returns the {@link MaterialExtensionSet} previously set using
     * {@link OgreMaterialKey#setMaterialExtensionSet(com.jme3.scene.plugins.ogre.matext.MaterialExtensionSet) } method.
     * @return
     */
    public MaterialExtensionSet getMaterialExtensionSet() {
        return matExts;
    }
}