Package org.jbox2d.serialization

Interface JbSerializer

All Known Implementing Classes:

PbSerializer

public interface JbSerializer

Serializer for jbox2d, used to serialize any aspect of the physics world

Author:

Daniel Murphy

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JbSerializer.ObjectSigner	Interface that allows the serializer to look up tags for each object, which can be used later during deserializing by the developer.

Method Summary

Modifier and Type	Method	Description
SerializationResult	serialize(Shape shape)	Serializes a shape
SerializationResult	serialize(Body body)	Serializes a body
SerializationResult	serialize(Fixture fixture)	Serializes a fixture
SerializationResult	serialize(Joint joint, Map<Body,Integer> bodyIndexMap, Map<Joint,Integer> jointIndexMap)	Serializes joints.
SerializationResult	serialize(World world)	Serializes the world
void	setObjectSigner(JbSerializer.ObjectSigner signer)	Sets the object signer for the serializer.
void	setUnsupportedListener(UnsupportedListener listener)	Sets a listener for unsupported exception instead of stopping the whole serialization process by throwing and exception.

Method Details

setObjectSigner

void setObjectSigner(JbSerializer.ObjectSigner signer)

Sets the object signer for the serializer. This allows the user to specify a 'tag' for each main physics object, which is then referenced later at deserialization for the user.

setUnsupportedListener

void setUnsupportedListener(UnsupportedListener listener)

Sets a listener for unsupported exception instead of stopping the whole serialization process by throwing and exception.

serialize

SerializationResult serialize(World world)
                       throws UnsupportedObjectException

Serializes the world

Parameters:

world - * @throws UnsupportedObjectException if a physics object is unsupported by this library.

Throws:

UnsupportedObjectException

See Also:

• setUnsupportedListener(UnsupportedListener)

serialize

SerializationResult serialize(Body body)
                       throws UnsupportedObjectException

Serializes a body

Parameters:

body - * @throws UnsupportedObjectException if a physics object is unsupported by this library.

Throws:

UnsupportedObjectException

See Also:

• setUnsupportedListener(UnsupportedListener)

serialize

SerializationResult serialize(Fixture fixture)
                       throws UnsupportedObjectException

Serializes a fixture

Parameters:

fixture - * @throws UnsupportedObjectException if a physics object is unsupported by this library.

Throws:

UnsupportedObjectException

See Also:

• setUnsupportedListener(UnsupportedListener)

serialize

SerializationResult serialize(Shape shape)
                       throws UnsupportedObjectException

Serializes a shape

Parameters:

shape - * @throws UnsupportedObjectException if a physics object is unsupported by this library.

Throws:

UnsupportedObjectException

See Also:

• setUnsupportedListener(UnsupportedListener)

serialize

SerializationResult serialize(Joint joint,
 Map<Body,Integer> bodyIndexMap,
 Map<Joint,Integer> jointIndexMap)

Serializes joints. Joints need to reference bodies and sometimes other joints.