engine/src/blender/com/jme3/scene/plugins/blender/BlenderLoader.java - platform/external/jmonkeyengine - Git at Google

 /*
  * Copyright (c) 2009-2010 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.blender;

 import com.jme3.asset.AssetInfo;
 import com.jme3.asset.BlenderKey;
 import com.jme3.asset.BlenderKey.FeaturesToLoad;
 import com.jme3.asset.BlenderKey.LoadingResults;
 import com.jme3.asset.BlenderKey.WorldData;
 import com.jme3.asset.ModelKey;
 import com.jme3.light.Light;
 import com.jme3.renderer.Camera;
 import com.jme3.scene.Node;
 import com.jme3.scene.Spatial;
 import com.jme3.scene.plugins.blender.animations.ArmatureHelper;
 import com.jme3.scene.plugins.blender.animations.IpoHelper;
 import com.jme3.scene.plugins.blender.cameras.CameraHelper;
 import com.jme3.scene.plugins.blender.constraints.ConstraintHelper;
 import com.jme3.scene.plugins.blender.curves.CurvesHelper;
 import com.jme3.scene.plugins.blender.exceptions.BlenderFileException;
 import com.jme3.scene.plugins.blender.file.BlenderInputStream;
 import com.jme3.scene.plugins.blender.file.FileBlockHeader;
 import com.jme3.scene.plugins.blender.file.Structure;
 import com.jme3.scene.plugins.blender.lights.LightHelper;
 import com.jme3.scene.plugins.blender.materials.MaterialHelper;
 import com.jme3.scene.plugins.blender.meshes.MeshHelper;
 import com.jme3.scene.plugins.blender.modifiers.ModifierHelper;
 import com.jme3.scene.plugins.blender.objects.ObjectHelper;
 import com.jme3.scene.plugins.blender.particles.ParticlesHelper;
 import com.jme3.scene.plugins.blender.textures.TextureHelper;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;

 /**
  * This is the main loading class. Have in notice that asset manager needs to have loaders for resources like textures.
  * @author Marcin Roguski (Kaelthas)
  */
 public class BlenderLoader extends AbstractBlenderLoader {

 	private static final Logger		LOGGER	= Logger.getLogger(BlenderLoader.class.getName());

 	/** The blocks read from the file. */
 	protected List<FileBlockHeader>	blocks;

 	@Override
 	public Spatial load(AssetInfo assetInfo) throws IOException {
 		try {
 			this.setup(assetInfo);

 			BlenderKey blenderKey = blenderContext.getBlenderKey();
 			LoadingResults loadingResults = blenderKey.prepareLoadingResults();
 			WorldData worldData = null;// a set of data used in different scene aspects
 			for (FileBlockHeader block : blocks) {
 				switch (block.getCode()) {
 					case FileBlockHeader.BLOCK_OB00:// Object
 						Object object = this.toObject(block.getStructure(blenderContext));
 						if (object instanceof Node) {
 							if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.OBJECTS) != 0) {
 								LOGGER.log(Level.INFO, "{0}: {1}--> {2}", new Object[] { ((Node) object).getName(), ((Node) object).getLocalTranslation().toString(), ((Node) object).getParent() == null ? "null" : ((Node) object).getParent().getName() });
 								if (this.isRootObject(loadingResults, (Node)object)) {
 									loadingResults.addObject((Node) object);
 								}
 							}
 						} else if (object instanceof Camera) {
 							if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.CAMERAS) != 0) {
 								loadingResults.addCamera((Camera) object);
 							}
 						} else if (object instanceof Light) {
 							if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.LIGHTS) != 0) {
 								loadingResults.addLight((Light) object);
 							}
 						}
 						break;
 					case FileBlockHeader.BLOCK_MA00:// Material
 						if (blenderKey.isLoadUnlinkedAssets() && (blenderKey.getFeaturesToLoad() & FeaturesToLoad.MATERIALS) != 0) {
 							loadingResults.addMaterial(this.toMaterial(block.getStructure(blenderContext)));
 						}
 						break;
 					case FileBlockHeader.BLOCK_SC00:// Scene
 						if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.SCENES) != 0) {
 							loadingResults.addScene(this.toScene(block.getStructure(blenderContext)));
 						}
 						break;
 					case FileBlockHeader.BLOCK_WO00:// World
 						if (blenderKey.isLoadUnlinkedAssets() && worldData == null) {// onlu one world data is used
 							Structure worldStructure = block.getStructure(blenderContext);
 							String worldName = worldStructure.getName();
 							if (blenderKey.getUsedWorld() == null || blenderKey.getUsedWorld().equals(worldName)) {
 								worldData = this.toWorldData(worldStructure);
 								if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.LIGHTS) != 0) {
 									loadingResults.addLight(worldData.getAmbientLight());
 								}
 							}
 						}
 						break;
 				}
 			}
 			blenderContext.dispose();
 			return loadingResults;
 		} catch (BlenderFileException e) {
 			LOGGER.log(Level.SEVERE, e.getMessage(), e);
 		}
 		return null;
 	}

 	/**
 	 * This method indicates if the given spatial is a root object. It means it
 	 * has no parent or is directly attached to one of the already loaded scene
 	 * nodes.
 	 *
 	 * @param loadingResults
 	 *        loading results containing the scene nodes
 	 * @param spatial
 	 *        spatial object
 	 * @return <b>true</b> if the given spatial is a root object and
 	 *         <b>false</b> otherwise
 	 */
 	protected boolean isRootObject(LoadingResults loadingResults, Spatial spatial) {
 		if(spatial.getParent() == null) {
 			return true;
 		}
 		for(Node scene : loadingResults.getScenes()) {
 			if(spatial.getParent().equals(scene)) {
 				return true;
 			}
 		}
 		return false;
 	}

 	/**
 	 * This method sets up the loader.
 	 * @param assetInfo
 	 *        the asset info
 	 * @throws BlenderFileException
 	 *         an exception is throw when something wrong happens with blender file
 	 */
 	protected void setup(AssetInfo assetInfo) throws BlenderFileException {
 		// registering loaders
 		ModelKey modelKey = (ModelKey) assetInfo.getKey();
 		BlenderKey blenderKey;
 		if (modelKey instanceof BlenderKey) {
 			blenderKey = (BlenderKey) modelKey;
 		} else {
 			blenderKey = new BlenderKey(modelKey.getName());
 			blenderKey.setAssetRootPath(modelKey.getFolder());
 		}

 		// opening stream
 		BlenderInputStream inputStream = new BlenderInputStream(assetInfo.openStream(), assetInfo.getManager());

 		// reading blocks
 		blocks = new ArrayList<FileBlockHeader>();
 		FileBlockHeader fileBlock;
 		blenderContext = new BlenderContext();
 		blenderContext.setBlenderVersion(inputStream.getVersionNumber());
 		blenderContext.setAssetManager(assetInfo.getManager());
 		blenderContext.setInputStream(inputStream);
 		blenderContext.setBlenderKey(blenderKey);

 		// creating helpers
 		blenderContext.putHelper(ArmatureHelper.class, new ArmatureHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(TextureHelper.class, new TextureHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(MeshHelper.class, new MeshHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(ObjectHelper.class, new ObjectHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(CurvesHelper.class, new CurvesHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(LightHelper.class, new LightHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(CameraHelper.class, new CameraHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(ModifierHelper.class, new ModifierHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(MaterialHelper.class, new MaterialHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(ConstraintHelper.class, new ConstraintHelper(inputStream.getVersionNumber(), blenderContext, blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(IpoHelper.class, new IpoHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
 		blenderContext.putHelper(ParticlesHelper.class, new ParticlesHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));

 		// setting additional data to helpers
 		MaterialHelper materialHelper = blenderContext.getHelper(MaterialHelper.class);
 		materialHelper.setFaceCullMode(blenderKey.getFaceCullMode());

 		// reading the blocks (dna block is automatically saved in the blender context when found)//TODO: zmienić to
 		FileBlockHeader sceneFileBlock = null;
 		do {
 			fileBlock = new FileBlockHeader(inputStream, blenderContext);
 			if (!fileBlock.isDnaBlock()) {
 				blocks.add(fileBlock);
 				// save the scene's file block
 				if (fileBlock.getCode() == FileBlockHeader.BLOCK_SC00 && blenderKey.getLayersToLoad() < 0) {
 					sceneFileBlock = fileBlock;
 				}
 			}
 		} while (!fileBlock.isLastBlock());
 		// VERIFY LAYERS TO BE LOADED BEFORE LOADING FEATURES
 		if (sceneFileBlock != null) {
 			int lay = ((Number) sceneFileBlock.getStructure(blenderContext).getFieldValue("lay")).intValue();
 			blenderContext.getBlenderKey().setLayersToLoad(lay);// load only current layer
 		}
 	}
 }
	/*
	* Copyright (c) 2009-2010 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.blender;

	import com.jme3.asset.AssetInfo;
	import com.jme3.asset.BlenderKey;
	import com.jme3.asset.BlenderKey.FeaturesToLoad;
	import com.jme3.asset.BlenderKey.LoadingResults;
	import com.jme3.asset.BlenderKey.WorldData;
	import com.jme3.asset.ModelKey;
	import com.jme3.light.Light;
	import com.jme3.renderer.Camera;
	import com.jme3.scene.Node;
	import com.jme3.scene.Spatial;
	import com.jme3.scene.plugins.blender.animations.ArmatureHelper;
	import com.jme3.scene.plugins.blender.animations.IpoHelper;
	import com.jme3.scene.plugins.blender.cameras.CameraHelper;
	import com.jme3.scene.plugins.blender.constraints.ConstraintHelper;
	import com.jme3.scene.plugins.blender.curves.CurvesHelper;
	import com.jme3.scene.plugins.blender.exceptions.BlenderFileException;
	import com.jme3.scene.plugins.blender.file.BlenderInputStream;
	import com.jme3.scene.plugins.blender.file.FileBlockHeader;
	import com.jme3.scene.plugins.blender.file.Structure;
	import com.jme3.scene.plugins.blender.lights.LightHelper;
	import com.jme3.scene.plugins.blender.materials.MaterialHelper;
	import com.jme3.scene.plugins.blender.meshes.MeshHelper;
	import com.jme3.scene.plugins.blender.modifiers.ModifierHelper;
	import com.jme3.scene.plugins.blender.objects.ObjectHelper;
	import com.jme3.scene.plugins.blender.particles.ParticlesHelper;
	import com.jme3.scene.plugins.blender.textures.TextureHelper;
	import java.io.IOException;
	import java.util.ArrayList;
	import java.util.List;
	import java.util.logging.Level;
	import java.util.logging.Logger;

	/**
	* This is the main loading class. Have in notice that asset manager needs to have loaders for resources like textures.
	* @author Marcin Roguski (Kaelthas)
	*/
	public class BlenderLoader extends AbstractBlenderLoader {

	private static final Logger LOGGER = Logger.getLogger(BlenderLoader.class.getName());

	/** The blocks read from the file. */
	protected List<FileBlockHeader> blocks;

	@Override
	public Spatial load(AssetInfo assetInfo) throws IOException {
	try {
	this.setup(assetInfo);

	BlenderKey blenderKey = blenderContext.getBlenderKey();
	LoadingResults loadingResults = blenderKey.prepareLoadingResults();
	WorldData worldData = null;// a set of data used in different scene aspects
	for (FileBlockHeader block : blocks) {
	switch (block.getCode()) {
	case FileBlockHeader.BLOCK_OB00:// Object
	Object object = this.toObject(block.getStructure(blenderContext));
	if (object instanceof Node) {
	if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.OBJECTS) != 0) {
	LOGGER.log(Level.INFO, "{0}: {1}--> {2}", new Object[] { ((Node) object).getName(), ((Node) object).getLocalTranslation().toString(), ((Node) object).getParent() == null ? "null" : ((Node) object).getParent().getName() });
	if (this.isRootObject(loadingResults, (Node)object)) {
	loadingResults.addObject((Node) object);
	}
	}
	} else if (object instanceof Camera) {
	if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.CAMERAS) != 0) {
	loadingResults.addCamera((Camera) object);
	}
	} else if (object instanceof Light) {
	if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.LIGHTS) != 0) {
	loadingResults.addLight((Light) object);
	}
	}
	break;
	case FileBlockHeader.BLOCK_MA00:// Material
	if (blenderKey.isLoadUnlinkedAssets() && (blenderKey.getFeaturesToLoad() & FeaturesToLoad.MATERIALS) != 0) {
	loadingResults.addMaterial(this.toMaterial(block.getStructure(blenderContext)));
	}
	break;
	case FileBlockHeader.BLOCK_SC00:// Scene
	if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.SCENES) != 0) {
	loadingResults.addScene(this.toScene(block.getStructure(blenderContext)));
	}
	break;
	case FileBlockHeader.BLOCK_WO00:// World
	if (blenderKey.isLoadUnlinkedAssets() && worldData == null) {// onlu one world data is used
	Structure worldStructure = block.getStructure(blenderContext);
	String worldName = worldStructure.getName();
	if (blenderKey.getUsedWorld() == null \|\| blenderKey.getUsedWorld().equals(worldName)) {
	worldData = this.toWorldData(worldStructure);
	if ((blenderKey.getFeaturesToLoad() & FeaturesToLoad.LIGHTS) != 0) {
	loadingResults.addLight(worldData.getAmbientLight());
	}
	}
	}
	break;
	}
	}
	blenderContext.dispose();
	return loadingResults;
	} catch (BlenderFileException e) {
	LOGGER.log(Level.SEVERE, e.getMessage(), e);
	}
	return null;
	}

	/**
	* This method indicates if the given spatial is a root object. It means it
	* has no parent or is directly attached to one of the already loaded scene
	* nodes.
	*
	* @param loadingResults
	* loading results containing the scene nodes
	* @param spatial
	* spatial object
	* @return <b>true</b> if the given spatial is a root object and
	* <b>false</b> otherwise
	*/
	protected boolean isRootObject(LoadingResults loadingResults, Spatial spatial) {
	if(spatial.getParent() == null) {
	return true;
	}
	for(Node scene : loadingResults.getScenes()) {
	if(spatial.getParent().equals(scene)) {
	return true;
	}
	}
	return false;
	}

	/**
	* This method sets up the loader.
	* @param assetInfo
	* the asset info
	* @throws BlenderFileException
	* an exception is throw when something wrong happens with blender file
	*/
	protected void setup(AssetInfo assetInfo) throws BlenderFileException {
	// registering loaders
	ModelKey modelKey = (ModelKey) assetInfo.getKey();
	BlenderKey blenderKey;
	if (modelKey instanceof BlenderKey) {
	blenderKey = (BlenderKey) modelKey;
	} else {
	blenderKey = new BlenderKey(modelKey.getName());
	blenderKey.setAssetRootPath(modelKey.getFolder());
	}

	// opening stream
	BlenderInputStream inputStream = new BlenderInputStream(assetInfo.openStream(), assetInfo.getManager());

	// reading blocks
	blocks = new ArrayList<FileBlockHeader>();
	FileBlockHeader fileBlock;
	blenderContext = new BlenderContext();
	blenderContext.setBlenderVersion(inputStream.getVersionNumber());
	blenderContext.setAssetManager(assetInfo.getManager());
	blenderContext.setInputStream(inputStream);
	blenderContext.setBlenderKey(blenderKey);

	// creating helpers
	blenderContext.putHelper(ArmatureHelper.class, new ArmatureHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(TextureHelper.class, new TextureHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(MeshHelper.class, new MeshHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(ObjectHelper.class, new ObjectHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(CurvesHelper.class, new CurvesHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(LightHelper.class, new LightHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(CameraHelper.class, new CameraHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(ModifierHelper.class, new ModifierHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(MaterialHelper.class, new MaterialHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(ConstraintHelper.class, new ConstraintHelper(inputStream.getVersionNumber(), blenderContext, blenderKey.isFixUpAxis()));
	blenderContext.putHelper(IpoHelper.class, new IpoHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));
	blenderContext.putHelper(ParticlesHelper.class, new ParticlesHelper(inputStream.getVersionNumber(), blenderKey.isFixUpAxis()));

	// setting additional data to helpers
	MaterialHelper materialHelper = blenderContext.getHelper(MaterialHelper.class);
	materialHelper.setFaceCullMode(blenderKey.getFaceCullMode());

	// reading the blocks (dna block is automatically saved in the blender context when found)//TODO: zmienić to
	FileBlockHeader sceneFileBlock = null;
	do {
	fileBlock = new FileBlockHeader(inputStream, blenderContext);
	if (!fileBlock.isDnaBlock()) {
	blocks.add(fileBlock);
	// save the scene's file block
	if (fileBlock.getCode() == FileBlockHeader.BLOCK_SC00 && blenderKey.getLayersToLoad() < 0) {
	sceneFileBlock = fileBlock;
	}
	}
	} while (!fileBlock.isLastBlock());
	// VERIFY LAYERS TO BE LOADED BEFORE LOADING FEATURES
	if (sceneFileBlock != null) {
	int lay = ((Number) sceneFileBlock.getStructure(blenderContext).getFieldValue("lay")).intValue();
	blenderContext.getBlenderKey().setLayersToLoad(lay);// load only current layer
	}
	}
	}