• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2009-2010 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 java.util.HashMap;
36 
37 /**
38  * <code>MaterialExtension</code> defines a mapping from an Ogre3D "base" material
39  * to a jME3 material definition.
40  */
41 public class MaterialExtension {
42 
43     private String baseMatName;
44     private String jmeMatDefName;
45     private HashMap<String, String> textureMappings = new HashMap<String, String>();
46 
47     /**
48      * Material extension defines a mapping from an Ogre3D "base" material
49      * to a jME3 material definition.
50      *
51      * @param baseMatName The base material name for Ogre3D
52      * @param jmeMatDefName The material definition name for jME3
53      */
MaterialExtension(String baseMatName, String jmeMatDefName)54     public MaterialExtension(String baseMatName, String jmeMatDefName) {
55         this.baseMatName = baseMatName;
56         this.jmeMatDefName = jmeMatDefName;
57     }
58 
getBaseMaterialName()59     public String getBaseMaterialName() {
60         return baseMatName;
61     }
62 
getJmeMatDefName()63     public String getJmeMatDefName() {
64         return jmeMatDefName;
65     }
66 
67     /**
68      * Set mapping from an Ogre3D base material texture alias to a
69      * jME3 texture param
70      * @param ogreTexAlias The texture alias in the Ogre3D base material
71      * @param jmeTexParam The texture param name in the jME3 material definition.
72      */
setTextureMapping(String ogreTexAlias, String jmeTexParam)73     public void setTextureMapping(String ogreTexAlias, String jmeTexParam){
74         textureMappings.put(ogreTexAlias, jmeTexParam);
75     }
76 
77     /**
78      * Retreives a mapping from an Ogre3D base material texture alias
79      * to a jME3 texture param
80      * @param ogreTexAlias The texture alias in the Ogre3D base material
81      * @return The texture alias in the Ogre3D base material
82      */
getTextureMapping(String ogreTexAlias)83     public String getTextureMapping(String ogreTexAlias){
84         return textureMappings.get(ogreTexAlias);
85     }
86 }
87