com.jme3.scene.plugins.blender.file

Class FileBlockHeader

java.lang.Object

com.jme3.scene.plugins.blender.file.FileBlockHeader

public class FileBlockHeader
extends java.lang.Object

A class that holds the header data of a file block. The file block itself is not implemented. This class holds its start position in the stream and using this the structure can fill itself with the proper data.

Author:

Marcin Roguski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileBlockHeader.BlockCode

Constructor Summary

Constructors

Constructor and Description
FileBlockHeader(BlenderInputStream inputStream, BlenderContext blenderContext) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBlockPosition() This method returns the start position of the data block in the blend file stream.
FileBlockHeader.BlockCode	getCode() This method returns the code of this data block.
int	getCount() This data returns the number of structure stored in the data block after this header.
int	getSdnaIndex() This method returns the sdna index.
int	getSize() This method returns the size of the data stored in this block.
Structure	getStructure(BlenderContext blenderContext) This method returns the structure described by the header filled with appropriate data.
boolean	isDnaBlock() This method indicates if the block is the SDNA block.
boolean	isLastBlock() This method indicates if the block is the last block in the file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBlockHeader

public FileBlockHeader(BlenderInputStream inputStream,
               BlenderContext blenderContext)
                throws BlenderFileException

Constructor. Loads the block header from the given stream during instance creation.

Parameters:

inputStream - the stream we read the block header from

blenderContext - the blender context

Throws:

BlenderFileException - this exception is thrown when the pointer size is neither 4 nor 8

Method Detail

getStructure

public Structure getStructure(BlenderContext blenderContext)
                       throws BlenderFileException

This method returns the structure described by the header filled with appropriate data.

Parameters:

blenderContext - the blender context

Returns:

structure filled with data

Throws:

BlenderFileException

getCode

public FileBlockHeader.BlockCode getCode()

This method returns the code of this data block.

Returns:

the code of this data block

getSize

public int getSize()

This method returns the size of the data stored in this block.

Returns:

the size of the data stored in this block

getSdnaIndex

public int getSdnaIndex()

This method returns the sdna index.

Returns:

the sdna index

getCount

public int getCount()

This data returns the number of structure stored in the data block after this header.

Returns:

the number of structure stored in the data block after this header

getBlockPosition

public int getBlockPosition()

This method returns the start position of the data block in the blend file stream.

Returns:

the start position of the data block

isLastBlock

public boolean isLastBlock()

This method indicates if the block is the last block in the file.

Returns:

true if this block is the last one in the file nad false otherwise

isDnaBlock

public boolean isDnaBlock()

This method indicates if the block is the SDNA block.

Returns:

true if this block is the SDNA block and false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object