Home | History | Annotate | Download | only in matext 
      1 /*
      2  * Copyright (c) 2009-2012 jMonkeyEngine
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are
      7  * met:
      8  *
      9  * * Redistributions of source code must retain the above copyright
     10  *   notice, this list of conditions and the following disclaimer.
     11  *
     12  * * Redistributions in binary form must reproduce the above copyright
     13  *   notice, this list of conditions and the following disclaimer in the
     14  *   documentation and/or other materials provided with the distribution.
     15  *
     16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
     17  *   may be used to endorse or promote products derived from this software
     18  *   without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
     24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 package com.jme3.scene.plugins.ogre.matext;
     34 
     35 import com.jme3.asset.AssetKey;
     36 import com.jme3.material.MaterialList;
     37 
     38 /**
     39  * <code>OgreMaterialKey</code> allows specifying material extensions,
     40  * which map from Ogre3D base materials to jME3 materials
     41  */
     42 public class OgreMaterialKey extends AssetKey<MaterialList> {
     43 
     44     private MaterialExtensionSet matExts;
     45 
     46     public OgreMaterialKey(String name){
     47         super(name);
     48     }
     49 
     50     public OgreMaterialKey(){
     51         super();
     52     }
     53 
     54     /**
     55      * Set the {@link MaterialExtensionSet} to use for mapping
     56      * base materials to jME3 matdefs when loading.
     57      * Set to <code>null</code> to disable this functionality.
     58      *
     59      * @param matExts The {@link MaterialExtensionSet} to use
     60      */
     61     public void setMaterialExtensionSet(MaterialExtensionSet matExts){
     62         this.matExts = matExts;
     63     }
     64 
     65     /**
     66      * Returns the {@link MaterialExtensionSet} previously set using
     67      * {@link OgreMaterialKey#setMaterialExtensionSet(com.jme3.scene.plugins.ogre.matext.MaterialExtensionSet) } method.
     68      * @return
     69      */
     70     public MaterialExtensionSet getMaterialExtensionSet() {
     71         return matExts;
     72     }
     73 }
     74