Package WildMagic.LibGraphics.Detail

Class CollapseRecordArray

java.lang.Object

WildMagic.LibGraphics.ObjectSystem.GraphicsObject

WildMagic.LibGraphics.Detail.CollapseRecordArray

All Implemented Interfaces:

java.io.Serializable

public class CollapseRecordArray
extends GraphicsObject
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CollapseRecord[]	m_akArray
protected int	m_iQuantity
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
CollapseRecordArray()
CollapseRecordArray(int iQuantity, CollapseRecord[] akArray)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Delete memory.
CollapseRecord[]	GetData()
int	GetDiskUsed(StreamVersion rkVersion)	Returns the size of this object and it's children on disk for the current StreamVersion parameter.
int	GetQuantity()
void	Link(Stream rkStream, Stream.Link pkLink)	Copies this objects children objects from the input Stream's HashTable, based on the LinkID of the child stored in the pkLink parameter.
void	Load(Stream rkStream, Stream.Link pkLink)	Loads this object from the input parameter rkStream, using the input Stream.Link to store the IDs of children objects of this object for linking after all objects are loaded from the Stream.
boolean	Register(Stream rkStream)	Registers this object with the input Stream parameter.
void	Save(Stream rkStream)	Write this object and all its children to the Stream.
StringTree	SaveStrings(java.lang.String acTitle)	Write this object into a StringTree for the scene-graph visualization.

Methods inherited from class WildMagic.LibGraphics.ObjectSystem.GraphicsObject

GetAllObjectsByName, GetID, GetName, GetNextID, GetObjectByID, GetObjectByIDBase, GetObjectByName, GetObjectByNameBase, SetName

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

m_iQuantity

protected int m_iQuantity

m_akArray

protected CollapseRecord[] m_akArray

Constructor Detail

CollapseRecordArray

public CollapseRecordArray()

CollapseRecordArray

public CollapseRecordArray(int iQuantity,
                           CollapseRecord[] akArray)

Method Detail

dispose

public void dispose()

Description copied from class: GraphicsObject

Delete memory.

Overrides:

dispose in class GraphicsObject

GetData

public CollapseRecord[] GetData()

GetDiskUsed

public int GetDiskUsed(StreamVersion rkVersion)

Description copied from class: GraphicsObject

Returns the size of this object and it's children on disk for the current StreamVersion parameter.

Overrides:

GetDiskUsed in class GraphicsObject

Parameters:

rkVersion - the current version of the Stream file being created.

Returns:

the size of this object on disk.

GetQuantity

public int GetQuantity()

Link

public void Link(Stream rkStream,
                 Stream.Link pkLink)

Description copied from class: GraphicsObject

Copies this objects children objects from the input Stream's HashTable, based on the LinkID of the child stored in the pkLink parameter.

Overrides:

Link in class GraphicsObject

Parameters:

rkStream - the Stream where the child objects are stored.

pkLink - the Link class from which the child object IDs are read.

Load

public void Load(Stream rkStream,
                 Stream.Link pkLink)

Description copied from class: GraphicsObject

Loads this object from the input parameter rkStream, using the input Stream.Link to store the IDs of children objects of this object for linking after all objects are loaded from the Stream.

Overrides:

Load in class GraphicsObject

Parameters:

rkStream - the Stream from which this object is being read.

pkLink - the Link class for storing the IDs of this object's children objects.

Register

public boolean Register(Stream rkStream)

Description copied from class: GraphicsObject

Registers this object with the input Stream parameter. All objects streamed to disk are registered with the Stream so that a unique list of objects is maintained.

Overrides:

Register in class GraphicsObject

Parameters:

rkStream - the Stream where the child objects are stored.

Returns:

true if this object is registered, false if the object has already been registered.

Save

public void Save(Stream rkStream)

Description copied from class: GraphicsObject

Write this object and all its children to the Stream.

Overrides:

Save in class GraphicsObject

Parameters:

rkStream - the Stream where the child objects are stored.

SaveStrings

public StringTree SaveStrings(java.lang.String acTitle)

Description copied from class: GraphicsObject

Write this object into a StringTree for the scene-graph visualization.

Overrides:

SaveStrings in class GraphicsObject

Parameters:

acTitle - the header for this object in the StringTree, may be null

Returns:

StringTree containing a String-based representation of this object and its children.