com.openinventor.inventor.misc

Class SoByteStream

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoByteStream

public class SoByteStream
extends Inventor

Converts scene graph objects to character byte streams. This class creates a byte stream representation of a scene graph, using an SoWriteAction to write path lists to an in-memory buffer. Byte streams are commonly used to transfer data in copy and paste operations. (The SoWinClipboard class passes SoByteStream data during copy and paste.)

See also:

SoWinClipboard

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoByteStream() Constructor.

Method Summary

Modifier and Type	Method and Description
void	convert(SoNode node) Calls convert(node, true).
void	convert(SoNode node, boolean binaryFormat) Converts the passed scene graph object(s) into a byte stream.
void	convert(SoPath path) Calls convert(path, true).
void	convert(SoPath path, boolean binaryFormat) Converts the passed scene graph object(s) into a byte stream.
java.nio.ByteBuffer	getData() Returns the data from the last convert() operation.
long	getNumBytes() Returns the number of bytes from the last convert() operation.
static java.util.Vector<SoPath>	unconvert(SoByteStream byteStream) Takes byte stream data and unconverts it back to scene graph objects.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Constructor Detail

SoByteStream

public SoByteStream()

Constructor.

Method Detail

convert

public void convert(SoNode node)

Calls convert(node, true).

convert

public void convert(SoPath path)

Calls convert(path, true).

convert

public void convert(SoPath path,
                    boolean binaryFormat)

Converts the passed scene graph object(s) into a byte stream. The object(s) are passed by path. The caller may specify whether the byte stream is written in binary (true) or ASCII (false) format. The converted data can be accessed through getData() and getNumBytes().

getNumBytes

public long getNumBytes()

Returns the number of bytes from the last convert() operation. This byte stream format is well suited to data transfers, like copy and paste.

unconvert

public static java.util.Vector<SoPath> unconvert(SoByteStream byteStream)

Takes byte stream data and unconverts it back to scene graph objects. The objects are returned in a path list.

getData

public java.nio.ByteBuffer getData()

Returns the data from the last convert() operation. This byte stream format is well suited to data transfers, like copy and paste.

convert

public void convert(SoNode node,
                    boolean binaryFormat)

Converts the passed scene graph object(s) into a byte stream. The object(s) are passed by node. The caller may specify whether the byte stream is written in binary (true) or ASCII (false) format. The converted data can be accessed through getData() and getNumBytes().