BlenderKey (jMonkeyEngine 3.1 jme3-blender Javadoc)

java.lang.Object
- com.jme3.asset.AssetKey<com.jme3.scene.Spatial>
- - com.jme3.asset.ModelKey
  - - com.jme3.asset.BlenderKey

All Implemented Interfaces:

com.jme3.export.Savable, java.lang.Cloneable
```
public class BlenderKey
extends com.jme3.asset.ModelKey
```
Blender key. Contains path of the blender file and its loading properties.

Author:

Marcin Roguski (Kaelthas)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BlenderKey.AnimationMatchMethod` This enum describes which animations should be attached to which armature.
`static interface`	`BlenderKey.FeaturesToLoad` Deprecated. this interface is deprecated and is not used anymore; to ensure the loading models consistency everything must be loaded because in blender one feature might depend on another
`static class`	`BlenderKey.MipmapGenerationMethod` This enum tells the importer if the mipmaps for textures will be generated by jme.
`static class`	`BlenderKey.SkyGeneratedTextureShape` The shape againts which the sky generated texture will be created.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BlenderKey.AnimationMatchMethod`	`animationMatchMethod` The method of matching animations to skeletons.
`protected java.lang.String`	`assetRootPath` The root path for all the assets.
`protected static int`	`DEFAULT_FPS`
`protected com.jme3.material.Material`	`defaultMaterial` User's default material that is set fo objects that have no material definition in blender.
`protected com.jme3.material.RenderState.FaceCullMode`	`faceCullMode` Face cull mode.
`protected int`	`featuresToLoad` This variable is a bitwise flag of FeatureToLoad interface values; By default everything is being loaded.
`protected boolean`	`fixUpAxis` This variable indicate if Y axis is UP axis.
`protected int`	`fps` FramesPerSecond parameter describe how many frames there are in each second.
`protected int`	`generatedTexturePPU` Generated textures resolution (PPU - Pixels Per Unit).
`protected int`	`layersToLoad` Variable describes which layers will be loaded.
`protected float`	`linesWidth` The width of edges that are loaded from the mesh and do not belong to any face.
`protected boolean`	`loadGeneratedTextures` Allows to toggle generated textures loading.
`protected boolean`	`loadObjectProperties` A variable that toggles the object custom properties loading.
`protected boolean`	`loadUnlinkedAssets` The variable that tells if content of the file (along with data unlinked to any feature on the scene) should be stored as 'user data' in the result spatial.
`protected int`	`maxTextureSize` Maximum texture size.
`protected BlenderKey.MipmapGenerationMethod`	`mipmapGenerationMethod` Tells if the mipmaps will be generated by jme or not.
`protected boolean`	`optimiseTextures` This field tells if the importer should optimise the use of textures or not.
`protected float`	`pointsSize` The size of points that are loaded and do not belong to any edge of the mesh.
`protected float`	`skyGeneratedTextureRadius` The radius of a shape that will be used while creating the generated texture for the sky.
`protected BlenderKey.SkyGeneratedTextureShape`	`skyGeneratedTextureShape` The shape against which the generated texture for the sky will be created.
`protected int`	`skyGeneratedTextureSize` If the sky has only generated textures applied then they will have the following size (both width and height).
`protected java.lang.String`	`usedWorld` The name of world settings that the importer will use.

Fields inherited from class com.jme3.asset.AssetKey
extension, folder, name

Constructor Summary

Constructors
Constructor and Description

BlenderKey()
Constructor used by serialization mechanisms.

BlenderKey(java.lang.String name)
Constructor.

Constructors
Constructor and Description
`BlenderKey()` Constructor used by serialization mechanisms.
`BlenderKey(java.lang.String name)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`void`	`excludeFromLoading(int featuresNotToLoad)` Deprecated.
`BlenderKey.AnimationMatchMethod`	`getAnimationMatchMethod()`
`java.lang.String`	`getAssetRootPath()` Deprecated.
`com.jme3.material.Material`	`getDefaultMaterial()` This method returns the default material.
`com.jme3.material.RenderState.FaceCullMode`	`getFaceCullMode()` This method returns the face cull mode.
`int`	`getFeaturesToLoad()` Deprecated.
`int`	`getFps()` This method returns frames per second amount.
`int`	`getGeneratedTexturePPU()`
`int`	`getLayersToLoad()` This method returns layers to be loaded.
`float`	`getLinesWidth()`
`int`	`getMaxTextureSize()` The default value for this parameter is the same as defined by: org.lwjgl.opengl.GL11.GL_MAX_TEXTURE_SIZE.
`BlenderKey.MipmapGenerationMethod`	`getMipmapGenerationMethod()`
`float`	`getPointsSize()`
`float`	`getSkyGeneratedTextureRadius()`
`BlenderKey.SkyGeneratedTextureShape`	`getSkyGeneratedTextureShape()`
`int`	`getSkyGeneratedTextureSize()`
`java.lang.String`	`getUsedWorld()` This mehtod returns the name of the WORLD data block taht should be used during file loading.
`int`	`hashCode()`
`void`	`includeInLoading(int featuresToLoad)` Deprecated.
`boolean`	`isFixUpAxis()` This method returns the fix up axis state.
`boolean`	`isLoadGeneratedTextures()`
`boolean`	`isLoadObjectProperties()`
`boolean`	`isLoadUnlinkedAssets()` This method determines if unlinked assets should be loaded.
`boolean`	`isOptimiseTextures()`
`void`	`read(com.jme3.export.JmeImporter e)`
`void`	`setAnimationMatchMethod(BlenderKey.AnimationMatchMethod animationMatchMethod)` Sets the way the animations will be matched with skeletons.
`void`	`setAssetRootPath(java.lang.String assetRootPath)` Deprecated.
`void`	`setDefaultMaterial(com.jme3.material.Material defaultMaterial)` This method sets the default material for objects.
`void`	`setFaceCullMode(com.jme3.material.RenderState.FaceCullMode faceCullMode)` This method sets the face cull mode.
`void`	`setFixUpAxis(boolean fixUpAxis)` This method sets the fix up axis state.
`void`	`setFps(int fps)` This method sets frames per second amount.
`void`	`setGeneratedTexturePPU(int generatedTexturePPU)` This method sets the generated textures resolution.
`void`	`setLayersToLoad(int layersToLoad)` This method sets layers to be loaded.
`void`	`setLinesWidth(float linesWidth)` Sets the width of edges that are loaded from the mesh and do not belong to any face.
`void`	`setLoadGeneratedTextures(boolean loadGeneratedTextures)` This method sets the flag that toggles the generated textures loading.
`void`	`setLoadObjectProperties(boolean loadObjectProperties)` This method sets the properies loading policy.
`void`	`setLoadUnlinkedAssets(boolean loadUnlinkedAssets)` This method sets if unlinked assets should be loaded.
`void`	`setMaxTextureSize(int maxTextureSize)` This method sets the maximum texture size.
`void`	`setMipmapGenerationMethod(BlenderKey.MipmapGenerationMethod mipmapGenerationMethod)`
`void`	`setOptimiseTextures(boolean optimiseTextures)` If set to true, then textures of the same mapping type will be merged together and textures that in the final result will never be visible - will be discarded.
`void`	`setPointsSize(float pointsSize)` Sets the size of points that are loaded and do not belong to any edge of the mesh.
`void`	`setSkyGeneratedTextureRadius(float skyGeneratedTextureRadius)`
`void`	`setSkyGeneratedTextureShape(BlenderKey.SkyGeneratedTextureShape skyGeneratedTextureShape)`
`void`	`setSkyGeneratedTextureSize(int skyGeneratedTextureSize)`
`void`	`setUsedWorld(java.lang.String usedWorld)` This mehtod sets the name of the WORLD data block taht should be used during file loading.
`boolean`	`shouldLoad(int featureToLoad)` Deprecated.
`void`	`write(com.jme3.export.JmeExporter e)`

Methods inherited from class com.jme3.asset.ModelKey
getCacheType, getProcessorType

Methods inherited from class com.jme3.asset.AssetKey
clone, getExtension, getExtension, getFolder, getFolder, getName, reducePath, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_FPS
```
protected static final int DEFAULT_FPS
```
    See Also:
    Constant Field Values
  - fps
```
protected int fps
```
    FramesPerSecond parameter describe how many frames there are in each second. It allows to calculate the time between the frames.
  - featuresToLoad
```
protected int featuresToLoad
```
    This variable is a bitwise flag of FeatureToLoad interface values; By default everything is being loaded.
  - loadUnlinkedAssets
```
protected boolean loadUnlinkedAssets
```
    The variable that tells if content of the file (along with data unlinked to any feature on the scene) should be stored as 'user data' in the result spatial.
  - assetRootPath
```
protected java.lang.String assetRootPath
```
    The root path for all the assets.
  - fixUpAxis
```
protected boolean fixUpAxis
```
    This variable indicate if Y axis is UP axis. If not then Z is up. By default set to true.
  - generatedTexturePPU
```
protected int generatedTexturePPU
```
    Generated textures resolution (PPU - Pixels Per Unit).
  - usedWorld
```
protected java.lang.String usedWorld
```
    The name of world settings that the importer will use. If not set or specified name does not occur in the file then the first world settings in the file will be used.
  - defaultMaterial
```
protected com.jme3.material.Material defaultMaterial
```
    User's default material that is set fo objects that have no material definition in blender. The default value is null. If the value is null the importer will use its own default material (gray color - like in blender).
  - faceCullMode
```
protected com.jme3.material.RenderState.FaceCullMode faceCullMode
```
    Face cull mode. By default it is disabled.
  - layersToLoad
```
protected int layersToLoad
```
    Variable describes which layers will be loaded. N-th bit set means N-th layer will be loaded. If set to -1 then the current layer will be loaded.
  - loadObjectProperties
```
protected boolean loadObjectProperties
```
    A variable that toggles the object custom properties loading.
  - maxTextureSize
```
protected int maxTextureSize
```
    Maximum texture size. Might be dependant on the graphic card. This value is taken from org.lwjgl.opengl.GL11.GL_MAX_TEXTURE_SIZE.
  - loadGeneratedTextures
```
protected boolean loadGeneratedTextures
```
    Allows to toggle generated textures loading. Disabled by default because it very often takes too much memory and needs to be used wisely.
  - mipmapGenerationMethod
```
protected BlenderKey.MipmapGenerationMethod mipmapGenerationMethod
```
    Tells if the mipmaps will be generated by jme or not. By default generation is dependant on the blender settings.
  - skyGeneratedTextureSize
```
protected int skyGeneratedTextureSize
```
    If the sky has only generated textures applied then they will have the following size (both width and height). If 2d textures are used then the generated textures will get their proper size.
  - skyGeneratedTextureRadius
```
protected float skyGeneratedTextureRadius
```
    The radius of a shape that will be used while creating the generated texture for the sky. The higher it is the larger part of the texture will be seen.
  - skyGeneratedTextureShape
```
protected BlenderKey.SkyGeneratedTextureShape skyGeneratedTextureShape
```
    The shape against which the generated texture for the sky will be created.
  - optimiseTextures
```
protected boolean optimiseTextures
```
    This field tells if the importer should optimise the use of textures or not. If set to true, then textures of the same mapping type will be merged together and textures that in the final result will never be visible - will be discarded.
  - animationMatchMethod
```
protected BlenderKey.AnimationMatchMethod animationMatchMethod
```
    The method of matching animations to skeletons. The default value is: AT_LEAST_ONE_NAME_MATCH.
  - pointsSize
```
protected float pointsSize
```
    The size of points that are loaded and do not belong to any edge of the mesh.
  - linesWidth
```
protected float linesWidth
```
    The width of edges that are loaded from the mesh and do not belong to any face.
- Constructor Detail
  - BlenderKey
```
public BlenderKey()
```
    Constructor used by serialization mechanisms.
  - BlenderKey
```
public BlenderKey(java.lang.String name)
```
    Constructor. Creates a key for the given file name.
    
    Parameters:
    name - the name (path) of a file
- Method Detail
  - getFps
```
public int getFps()
```
    This method returns frames per second amount. The default value is BlenderKey.DEFAULT_FPS = 25.
    
    Returns:
    the frames per second amount
  - setFps
```
public void setFps(int fps)
```
    This method sets frames per second amount.
    
    Parameters:
    fps - the frames per second amount
  - getFaceCullMode
```
public com.jme3.material.RenderState.FaceCullMode getFaceCullMode()
```
    This method returns the face cull mode.
    
    Returns:
    the face cull mode
  - setFaceCullMode
```
public void setFaceCullMode(com.jme3.material.RenderState.FaceCullMode faceCullMode)
```
    This method sets the face cull mode.
    
    Parameters:
    faceCullMode - the face cull mode
  - setLayersToLoad
```
public void setLayersToLoad(int layersToLoad)
```
    This method sets layers to be loaded.
    
    Parameters:
    layersToLoad - layers to be loaded
  - getLayersToLoad
```
public int getLayersToLoad()
```
    This method returns layers to be loaded.
    
    Returns:
    layers to be loaded
  - setLoadObjectProperties
```
public void setLoadObjectProperties(boolean loadObjectProperties)
```
    This method sets the properies loading policy. By default the value is true.
    
    Parameters:
    loadObjectProperties - true to load properties and false to suspend their loading
  - isLoadObjectProperties
```
public boolean isLoadObjectProperties()
```
    Returns:
    the current properties loading properties
  - getMaxTextureSize
```
public int getMaxTextureSize()
```
    The default value for this parameter is the same as defined by: org.lwjgl.opengl.GL11.GL_MAX_TEXTURE_SIZE. If by any means this is too large for user's hardware configuration use the 'setMaxTextureSize' method to change that.
    
    Returns:
    maximum texture size (width/height)
  - setMaxTextureSize
```
public void setMaxTextureSize(int maxTextureSize)
```
    This method sets the maximum texture size.
    
    Parameters:
    maxTextureSize - the maximum texture size
  - setLoadGeneratedTextures
```
public void setLoadGeneratedTextures(boolean loadGeneratedTextures)
```
    This method sets the flag that toggles the generated textures loading.
    
    Parameters:
    loadGeneratedTextures - true if generated textures should be loaded and false otherwise
  - isLoadGeneratedTextures
```
public boolean isLoadGeneratedTextures()
```
    Returns:
    tells if the generated textures should be loaded (false is the default value)
  - setAssetRootPath
```
@Deprecated
public void setAssetRootPath(java.lang.String assetRootPath)
```
    Deprecated.
    
    Not used any more. This method sets the asset root path.
    
    Parameters:
    assetRootPath - the assets root path
  - getAssetRootPath
```
@Deprecated
public java.lang.String getAssetRootPath()
```
    Deprecated.
    
    Not used any more. This method returns the asset root path.
    
    Returns:
    the asset root path
  - includeInLoading
```
@Deprecated
public void includeInLoading(int featuresToLoad)
```
    Deprecated.
    
    This method adds features to be loaded.
    
    Parameters:
    featuresToLoad - bitwise flag of FeaturesToLoad interface values
  - excludeFromLoading
```
@Deprecated
public void excludeFromLoading(int featuresNotToLoad)
```
    Deprecated.
    
    This method removes features from being loaded.
    
    Parameters:
    featuresNotToLoad - bitwise flag of FeaturesToLoad interface values
  - shouldLoad
```
@Deprecated
public boolean shouldLoad(int featureToLoad)
```
    Deprecated.
  - getFeaturesToLoad
```
@Deprecated
public int getFeaturesToLoad()
```
    Deprecated.
    
    This method returns bitwise value of FeaturesToLoad interface value. It describes features that will be loaded by the blender file loader.
    
    Returns:
    features that will be loaded by the blender file loader
  - isLoadUnlinkedAssets
```
public boolean isLoadUnlinkedAssets()
```
    This method determines if unlinked assets should be loaded. If not then only objects on selected layers will be loaded and their assets if required. If yes then all assets will be loaded even if they are on inactive layers or are not linked to anything.
    
    Returns:
    true if unlinked assets should be loaded and false otherwise
  - setLoadUnlinkedAssets
```
public void setLoadUnlinkedAssets(boolean loadUnlinkedAssets)
```
    This method sets if unlinked assets should be loaded. If not then only objects on selected layers will be loaded and their assets if required. If yes then all assets will be loaded even if they are on inactive layers or are not linked to anything.
    
    Parameters:
    loadUnlinkedAssets - true if unlinked assets should be loaded and false otherwise
  - setFixUpAxis
```
public void setFixUpAxis(boolean fixUpAxis)
```
    This method sets the fix up axis state. If set to true then Y is up axis. Otherwise the up i Z axis. By default Y is up axis.
    
    Parameters:
    fixUpAxis - the up axis state variable
  - isFixUpAxis
```
public boolean isFixUpAxis()
```
    This method returns the fix up axis state. If set to true then Y is up axis. Otherwise the up i Z axis. By default Y is up axis.
    
    Returns:
    the up axis state variable
  - setGeneratedTexturePPU
```
public void setGeneratedTexturePPU(int generatedTexturePPU)
```
    This method sets the generated textures resolution.
    
    Parameters:
    generatedTexturePPU - the generated textures resolution
  - getGeneratedTexturePPU
```
public int getGeneratedTexturePPU()
```
    Returns:
    the generated textures resolution
  - getMipmapGenerationMethod
```
public BlenderKey.MipmapGenerationMethod getMipmapGenerationMethod()
```
    Returns:
    mipmaps generation method
  - setMipmapGenerationMethod
```
public void setMipmapGenerationMethod(BlenderKey.MipmapGenerationMethod mipmapGenerationMethod)
```
    Parameters:
    mipmapGenerationMethod - mipmaps generation method
  - getSkyGeneratedTextureSize
```
public int getSkyGeneratedTextureSize()
```
    Returns:
    the size of the generated textures for the sky (used if no flat textures are applied)
  - setSkyGeneratedTextureSize
```
public void setSkyGeneratedTextureSize(int skyGeneratedTextureSize)
```
    Parameters:
    skyGeneratedTextureSize - the size of the generated textures for the sky (used if no flat textures are applied)
  - getSkyGeneratedTextureRadius
```
public float getSkyGeneratedTextureRadius()
```
    Returns:
    the radius of a shape that will be used while creating the generated texture for the sky, the higher it is the larger part of the texture will be seen
  - setSkyGeneratedTextureRadius
```
public void setSkyGeneratedTextureRadius(float skyGeneratedTextureRadius)
```
    Parameters:
    skyGeneratedTextureRadius - the radius of a shape that will be used while creating the generated texture for the sky, the higher it is the larger part of the texture will be seen
  - getSkyGeneratedTextureShape
```
public BlenderKey.SkyGeneratedTextureShape getSkyGeneratedTextureShape()
```
    Returns:
    the shape against which the generated texture for the sky will be created (by default it is a sphere).
  - setSkyGeneratedTextureShape
```
public void setSkyGeneratedTextureShape(BlenderKey.SkyGeneratedTextureShape skyGeneratedTextureShape)
```
    Parameters:
    skyGeneratedTextureShape - the shape against which the generated texture for the sky will be created
  - setOptimiseTextures
```
public void setOptimiseTextures(boolean optimiseTextures)
```
    If set to true, then textures of the same mapping type will be merged together and textures that in the final result will never be visible - will be discarded.
    
    Parameters:
    optimiseTextures - the variable that tells if the textures should be optimised or not
  - isOptimiseTextures
```
public boolean isOptimiseTextures()
```
    Returns:
    the variable that tells if the textures should be optimised or not (by default the optimisation is disabled)
  - setAnimationMatchMethod
```
public void setAnimationMatchMethod(BlenderKey.AnimationMatchMethod animationMatchMethod)
```
    Sets the way the animations will be matched with skeletons.
    
    Parameters:
    animationMatchMethod - the way the animations will be matched with skeletons
  - getAnimationMatchMethod
```
public BlenderKey.AnimationMatchMethod getAnimationMatchMethod()
```
    Returns:
    the way the animations will be matched with skeletons
  - getPointsSize
```
public float getPointsSize()
```
    Returns:
    the size of points that are loaded and do not belong to any edge of the mesh
  - setPointsSize
```
public void setPointsSize(float pointsSize)
```
    Sets the size of points that are loaded and do not belong to any edge of the mesh.
    
    Parameters:
    pointsSize - The size of points that are loaded and do not belong to any edge of the mesh
  - getLinesWidth
```
public float getLinesWidth()
```
    Returns:
    the width of edges that are loaded from the mesh and do not belong to any face
  - setLinesWidth
```
public void setLinesWidth(float linesWidth)
```
    Sets the width of edges that are loaded from the mesh and do not belong to any face.
    
    Parameters:
    linesWidth - the width of edges that are loaded from the mesh and do not belong to any face
  - setUsedWorld
```
public void setUsedWorld(java.lang.String usedWorld)
```
    This mehtod sets the name of the WORLD data block taht should be used during file loading. By default the name is not set. If no name is set or the given name does not occur in the file - the first WORLD data block will be used during loading (assumin any exists in the file).
    
    Parameters:
    usedWorld - the name of the WORLD block used during loading
  - getUsedWorld
```
public java.lang.String getUsedWorld()
```
    This mehtod returns the name of the WORLD data block taht should be used during file loading.
    
    Returns:
    the name of the WORLD block used during loading
  - setDefaultMaterial
```
public void setDefaultMaterial(com.jme3.material.Material defaultMaterial)
```
    This method sets the default material for objects.
    
    Parameters:
    defaultMaterial - the default material
  - getDefaultMaterial
```
public com.jme3.material.Material getDefaultMaterial()
```
    This method returns the default material.
    
    Returns:
    the default material
  - write
```
public void write(com.jme3.export.JmeExporter e)
           throws java.io.IOException
```
    Specified by:
    
    write in interface com.jme3.export.Savable
    
    Overrides:
    
    write in class com.jme3.asset.AssetKey<com.jme3.scene.Spatial>
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(com.jme3.export.JmeImporter e)
          throws java.io.IOException
```
    Specified by:
    
    read in interface com.jme3.export.Savable
    
    Overrides:
    
    read in class com.jme3.asset.AssetKey<com.jme3.scene.Spatial>
    
    Throws:
    
    java.io.IOException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.jme3.asset.AssetKey<com.jme3.scene.Spatial>
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class com.jme3.asset.AssetKey<com.jme3.scene.Spatial>

Class BlenderKey

Nested Class Summary

Field Summary

Fields inherited from class com.jme3.asset.AssetKey

Constructor Summary

Method Summary

Methods inherited from class com.jme3.asset.ModelKey

Methods inherited from class com.jme3.asset.AssetKey

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FPS

fps

featuresToLoad

loadUnlinkedAssets

assetRootPath

fixUpAxis

generatedTexturePPU

usedWorld

defaultMaterial

faceCullMode

layersToLoad

loadObjectProperties

maxTextureSize

loadGeneratedTextures

mipmapGenerationMethod

skyGeneratedTextureSize

skyGeneratedTextureRadius

skyGeneratedTextureShape

optimiseTextures

animationMatchMethod

pointsSize

linesWidth

Constructor Detail

BlenderKey

BlenderKey

Method Detail

getFps

setFps

getFaceCullMode

setFaceCullMode

setLayersToLoad

getLayersToLoad

setLoadObjectProperties

isLoadObjectProperties

getMaxTextureSize

setMaxTextureSize

setLoadGeneratedTextures

isLoadGeneratedTextures

setAssetRootPath

getAssetRootPath

includeInLoading

excludeFromLoading

shouldLoad

getFeaturesToLoad

isLoadUnlinkedAssets

setLoadUnlinkedAssets

setFixUpAxis

isFixUpAxis

setGeneratedTexturePPU

getGeneratedTexturePPU

getMipmapGenerationMethod

setMipmapGenerationMethod

getSkyGeneratedTextureSize

setSkyGeneratedTextureSize

getSkyGeneratedTextureRadius

setSkyGeneratedTextureRadius

getSkyGeneratedTextureShape

setSkyGeneratedTextureShape

setOptimiseTextures

isOptimiseTextures

setAnimationMatchMethod

getAnimationMatchMethod

getPointsSize

setPointsSize

getLinesWidth

setLinesWidth

setUsedWorld

getUsedWorld

setDefaultMaterial

getDefaultMaterial