com.jme3.scene.plugins.blender

Class BlenderContext

java.lang.Object

com.jme3.scene.plugins.blender.BlenderContext

public class BlenderContext
extends java.lang.Object

The class that stores temporary data and manages it during loading the belnd file. This class is intended to be used in a single loading thread. It holds the state of loading operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlenderContext.LoadedDataType This enum defines what loaded data type user wants to retrieve.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<FileBlockHeader>	blocks The blocks read from the file.
protected java.util.Map<java.lang.Long,BoneContext>	boneContexts A map of bone contexts.
protected java.util.Map<java.lang.Long,java.util.List<Constraint>>	constraints A list of constraints for the specified object.

Constructor Summary

Constructors

Constructor and Description
BlenderContext()

Method Summary

Modifier and Type	Method and Description
void	addAction(BlenderAction action) Adds blender action to the context.
void	addAnimation(java.lang.Long ownerOMA, Animation animation) This method adds the animation for the specified OMA of its owner.
void	addConstraints(java.lang.Long ownerOMA, java.util.List<Constraint> constraints) This method adds a new modifier to the list.
void	addFileBlockHeader(java.lang.Long oldMemoryAddress, FileBlockHeader fileBlockHeader) This method adds a file block header to the map.
void	addLinkedFeature(java.lang.String blenderFilePath, java.lang.String featureGroup, java.lang.Object feature) Deprecated.
void	addLoadedFeatures(java.lang.Long oldMemoryAddress, BlenderContext.LoadedDataType featureDataType, java.lang.Object feature) This method adds a loaded feature to the map.
void	addMarker(java.lang.String marker, java.lang.Object feature, java.lang.Object markerValue) Adds a custom marker for scene's feature.
java.util.Map<java.lang.String,BlenderAction>	getActions()
java.util.List<Constraint>	getAllConstraints()
java.util.List<Animation>	getAnimations(java.lang.Long ownerOMA) This method returns the animation data for the specified owner.
AssetManager	getAssetManager() This method returns the asset manager.
BlenderKey	getBlenderKey() This method returns the blender key.
int	getBlenderVersion()
java.util.List<FileBlockHeader>	getBlocks()
BoneContext	getBoneByName(java.lang.Long skeletonOMA, java.lang.String name) Returns bone by given name.
BoneContext	getBoneContext(Bone bone) Returns bone context for the given bone.
BoneContext	getBoneContext(java.lang.Long boneOMA) This method returns the bone context for the given bone old memory address.
java.util.List<Constraint>	getConstraints(java.lang.Long ownerOMA) Returns constraints applied to the feature of the given OMA.
Node	getControlledNode(Skeleton skeleton) This method returns the armature node that is defined for the skeleton.
Material	getDefaultMaterial() This metod returns the default material.
DnaBlockData	getDnaBlockData() This method returns the dna block data.
FileBlockHeader	getFileBlock(java.lang.Long oldMemoryAddress) This method returns the block header of a given memory address.
java.util.List<FileBlockHeader>	getFileBlocks(FileBlockHeader.BlockCode code) This method returns a list of file blocks' headers of a specified code.
<T> T	getHelper(java.lang.Class<?> clazz)
BlenderInputStream	getInputStream() This method returns the input stream of the blend file.
java.lang.Object	getLinkedFeature(java.lang.String blenderFilePath, java.lang.String featureName) The method returns linked feature of a given name from the specified blender path.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getLinkedFeatures()
java.lang.Object	getLoadedFeature(java.lang.Long oldMemoryAddress, BlenderContext.LoadedDataType loadedFeatureDataType) This method returns the feature of a given memory address.
java.lang.Object	getMarkerValue(java.lang.String marker, java.lang.Object feature) Returns the marker value.
Structure	getSceneStructure() This method returns the scene structure data.
Skeleton	getSkeleton(java.lang.Long skeletonOMA) This method returns the skeleton for the specified OMA of its owner.
Structure	peekParent() This method retrieves the structure at the top of the parent's stack but does not remove it.
Structure	popParent() This method removes the structure from the top of the parent's stack.
void	pushParent(Structure parent) This method adds the structure to the parent stack.
<T> void	putHelper(java.lang.Class<T> clazz, AbstractBlenderHelper helper) This method adds a helper instance to the helpers' map.
void	setAssetManager(AssetManager assetManager) This method sets the asset manager.
void	setBlenderKey(BlenderKey blenderKey) This method sets the blender key.
void	setBlenderVersion(java.lang.String blenderVersion) This method sets the blender file version.
void	setBlockData(DnaBlockData dnaBlockData) This method sets the dna block data.
void	setBoneContext(java.lang.Long boneOMA, BoneContext boneContext) This method sets the bone context for the given bone old memory address.
void	setInputStream(BlenderInputStream inputStream) This method sets the input stream of the blend file.
void	setNodeForSkeleton(Skeleton skeleton, Node node) The method stores a binding between the skeleton and the proper armature node.
void	setSceneStructure(Structure sceneStructure) This method sets the scene structure data.
void	setSkeleton(java.lang.Long skeletonOMA, Skeleton skeleton) This method sets the skeleton for the specified OMA of its owner.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

blocks

protected java.util.List<FileBlockHeader> blocks

The blocks read from the file.

constraints

protected java.util.Map<java.lang.Long,java.util.List<Constraint>> constraints

A list of constraints for the specified object.

boneContexts

protected java.util.Map<java.lang.Long,BoneContext> boneContexts

A map of bone contexts.

Constructor Detail

BlenderContext

public BlenderContext()

Method Detail

setBlenderVersion

public void setBlenderVersion(java.lang.String blenderVersion)

This method sets the blender file version.

Parameters:

blenderVersion - the blender file version

getBlenderVersion

public int getBlenderVersion()

Returns:

the blender file version

setBlenderKey

public void setBlenderKey(BlenderKey blenderKey)

This method sets the blender key.

Parameters:

blenderKey - the blender key

getBlenderKey

public BlenderKey getBlenderKey()

This method returns the blender key.

Returns:

the blender key

setBlockData

public void setBlockData(DnaBlockData dnaBlockData)

This method sets the dna block data.

Parameters:

dnaBlockData - the dna block data

getDnaBlockData

public DnaBlockData getDnaBlockData()

This method returns the dna block data.

Returns:

the dna block data

setSceneStructure

public void setSceneStructure(Structure sceneStructure)

This method sets the scene structure data.

Parameters:

sceneStructure - the scene structure data

getSceneStructure

public Structure getSceneStructure()

This method returns the scene structure data.

Returns:

the scene structure data

getAssetManager

public AssetManager getAssetManager()

This method returns the asset manager.

Returns:

the asset manager

setAssetManager

public void setAssetManager(AssetManager assetManager)

This method sets the asset manager.

Parameters:

assetManager - the asset manager

getInputStream

public BlenderInputStream getInputStream()

This method returns the input stream of the blend file.

Returns:

the input stream of the blend file

setInputStream

public void setInputStream(BlenderInputStream inputStream)

This method sets the input stream of the blend file.

Parameters:

inputStream - the input stream of the blend file

addFileBlockHeader

public void addFileBlockHeader(java.lang.Long oldMemoryAddress,
                               FileBlockHeader fileBlockHeader)

This method adds a file block header to the map. Its old memory address is the key.

Parameters:

oldMemoryAddress - the address of the block header

fileBlockHeader - the block header to store

getBlocks

public java.util.List<FileBlockHeader> getBlocks()

Returns:

the block headers

getFileBlock

public FileBlockHeader getFileBlock(java.lang.Long oldMemoryAddress)

This method returns the block header of a given memory address. If the header is not present then null is returned.

Parameters:

oldMemoryAddress - the address of the block header

Returns:

loaded header or null if it was not yet loaded

getFileBlocks

public java.util.List<FileBlockHeader> getFileBlocks(FileBlockHeader.BlockCode code)

This method returns a list of file blocks' headers of a specified code.

Parameters:

code - the code of file blocks

Returns:

a list of file blocks' headers of a specified code

putHelper

public <T> void putHelper(java.lang.Class<T> clazz,
                          AbstractBlenderHelper helper)

This method adds a helper instance to the helpers' map.

Type Parameters:

T - the type of the helper

Parameters:

clazz - helper's class definition

helper - the helper instance

getHelper

public <T> T getHelper(java.lang.Class<?> clazz)

addLoadedFeatures

public void addLoadedFeatures(java.lang.Long oldMemoryAddress,
                              BlenderContext.LoadedDataType featureDataType,
                              java.lang.Object feature)

This method adds a loaded feature to the map. The key is its unique old memory address.

Parameters:

oldMemoryAddress - the address of the feature

featureDataType -

feature - the feature we want to store

getLoadedFeature

public java.lang.Object getLoadedFeature(java.lang.Long oldMemoryAddress,
                                         BlenderContext.LoadedDataType loadedFeatureDataType)

This method returns the feature of a given memory address. If the feature is not yet loaded then null is returned.

Parameters:

oldMemoryAddress - the address of the feature

loadedFeatureDataType - the type of data we want to retrieve it can be either filled structure or already converted feature

Returns:

loaded feature or null if it was not yet loaded

addLinkedFeature

@Deprecated
public void addLinkedFeature(java.lang.String blenderFilePath,
                                         java.lang.String featureGroup,
                                         java.lang.Object feature)

Deprecated.

The method adds linked content to the blender context.

Parameters:

blenderFilePath - the path of linked blender file

featureGroup - the linked feature group (ie. scenes, materials, meshes, etc.)

feature - the linked feature

getLinkedFeature

public java.lang.Object getLinkedFeature(java.lang.String blenderFilePath,
                                         java.lang.String featureName)

The method returns linked feature of a given name from the specified blender path.

Parameters:

blenderFilePath - the blender file path

featureName - the feature name we want to get

Returns:

linked feature or null if none was found

getLinkedFeatures

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getLinkedFeatures()

Returns:

all linked features for the current blend file

pushParent

public void pushParent(Structure parent)

This method adds the structure to the parent stack.

Parameters:

parent - the structure to be added to the stack

popParent

public Structure popParent()

This method removes the structure from the top of the parent's stack.

Returns:

the structure that was removed from the stack

peekParent

public Structure peekParent()

This method retrieves the structure at the top of the parent's stack but does not remove it.

Returns:

the structure from the top of the stack

addConstraints

public void addConstraints(java.lang.Long ownerOMA,
                           java.util.List<Constraint> constraints)

This method adds a new modifier to the list.

Parameters:

ownerOMA - the owner's old memory address

constraints - the object's constraints

getConstraints

public java.util.List<Constraint> getConstraints(java.lang.Long ownerOMA)

Returns constraints applied to the feature of the given OMA.

Parameters:

ownerOMA - the constraints' owner OMA

Returns:

a list of constraints or null if no constraints are applied to the feature

getAllConstraints

public java.util.List<Constraint> getAllConstraints()

Returns:

all available constraints

addAnimation

public void addAnimation(java.lang.Long ownerOMA,
                         Animation animation)

This method adds the animation for the specified OMA of its owner.

Parameters:

ownerOMA - the owner's old memory address

animation - the animation for the feature specified by ownerOMA

getAnimations

public java.util.List<Animation> getAnimations(java.lang.Long ownerOMA)

This method returns the animation data for the specified owner.

Parameters:

ownerOMA - the old memory address of the animation data owner

Returns:

the animation or null if none exists

setSkeleton

public void setSkeleton(java.lang.Long skeletonOMA,
                        Skeleton skeleton)

This method sets the skeleton for the specified OMA of its owner.

Parameters:

skeletonOMA - the skeleton's old memory address

skeleton - the skeleton specified by the given OMA

setNodeForSkeleton

public void setNodeForSkeleton(Skeleton skeleton,
                               Node node)

The method stores a binding between the skeleton and the proper armature node.

Parameters:

skeleton - the skeleton

node - the armature node

getControlledNode

public Node getControlledNode(Skeleton skeleton)

This method returns the armature node that is defined for the skeleton.

Parameters:

skeleton - the skeleton

Returns:

the armature node that defines the skeleton in blender

getSkeleton

public Skeleton getSkeleton(java.lang.Long skeletonOMA)

This method returns the skeleton for the specified OMA of its owner.

Parameters:

skeletonOMA - the skeleton's old memory address

Returns:

the skeleton specified by the given OMA

setBoneContext

public void setBoneContext(java.lang.Long boneOMA,
                           BoneContext boneContext)

This method sets the bone context for the given bone old memory address. If the context is already set it will be replaced.

Parameters:

boneOMA - the bone's old memory address

boneContext - the bones's context

getBoneContext

public BoneContext getBoneContext(java.lang.Long boneOMA)

This method returns the bone context for the given bone old memory address. If no context exists then null is returned.

Parameters:

boneOMA - the bone's old memory address

Returns:

bone's context

getBoneByName

public BoneContext getBoneByName(java.lang.Long skeletonOMA,
                                 java.lang.String name)

Returns bone by given name.

Parameters:

skeletonOMA - the OMA of the skeleton where the bone will be searched

name - the name of the bone

Returns:

found bone or null if none bone of a given name exists

getBoneContext

public BoneContext getBoneContext(Bone bone)

Returns bone context for the given bone.

Parameters:

bone - the bone

Returns:

the bone's bone context

getDefaultMaterial

public Material getDefaultMaterial()

This metod returns the default material.

Returns:

the default material

addMarker

public void addMarker(java.lang.String marker,
                      java.lang.Object feature,
                      java.lang.Object markerValue)

Adds a custom marker for scene's feature.

Parameters:

marker - the marker name

feature - te scene's feature (can be node, material or texture or anything else)

markerValue - the marker value

getMarkerValue

public java.lang.Object getMarkerValue(java.lang.String marker,
                                       java.lang.Object feature)

Returns the marker value. The returned value is null if no marker was defined for the given feature.

Parameters:

marker - the marker name

feature - the scene's feature

Returns:

marker value or null if it was not defined

addAction

public void addAction(BlenderAction action)

Adds blender action to the context.

Parameters:

action - the action loaded from the blend file

getActions

public java.util.Map<java.lang.String,BlenderAction> getActions()

Returns:

a map of blender actions; the key is the action name and the value is action itself

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object