Xj3D 2.0 VRML/X3D Code API

org.web3d.vrml.sav
Interface BinaryContentHandler

All Superinterfaces:
ContentHandler
All Known Subinterfaces:
SceneBuilder
All Known Implementing Classes:
BaseRetainedExporter, CRExternProtoBuilder, CRMainSceneBuilder, NRExternProtoBuilder, NRVRMLSceneBuilder, NullExporter, OGLExternProtoBuilder, OGLVRMLSceneBuilder, ProtoBuilder, X3DBinaryRetainedDirectExporter, X3DBinaryRetainedExporter, X3DClassicRetainedExporter, X3DRetainedSAXExporter, X3DXMLRetainedExporter

public interface BinaryContentHandler
extends ContentHandler

Receiver of notifications from the VRML document about node declaration information. All field values are sent as binary bits.

Version:
$Revision: 1.2 $
Author:
Alan Hudson

Method Summary
 void fieldValue(boolean value)
          Set the value of the field at the given index as an boolean.
 void fieldValue(boolean[] value, int len)
          Set the value of the field at the given index as an array of boolean.
 void fieldValue(double value)
          Set the value of the field at the given index as an double.
 void fieldValue(double[] value, int len)
          Set the value of the field at the given index as an array of doubles.
 void fieldValue(float value)
          Set the value of the field at the given index as a float.
 void fieldValue(float[] value, int len)
          Set the value of the field at the given index as an array of floats.
 void fieldValue(int value)
          Set the value of the field at the given index as an integer.
 void fieldValue(int[] value, int len)
          Set the value of the field at the given index as an array of integers.
 void fieldValue(long value)
          Set the value of the field at the given index as an long.
 void fieldValue(long[] value, int len)
          Set the value of the field at the given index as an array of longs.
 void fieldValue(java.lang.String value)
          Set the value of the field at the given index as a string.
 void fieldValue(java.lang.String[] value, int len)
          Set the value of the field at the given index as an array of strings.
 
Methods inherited from interface org.web3d.vrml.sav.ContentHandler
componentDecl, endDocument, endField, endNode, exportDecl, importDecl, metaDecl, profileDecl, setDocumentLocator, startDocument, startField, startNode, useDecl
 

Method Detail

fieldValue

void fieldValue(int value)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an integer. This would be used to set SFInt32 field types.

Parameters:
value - The new value to use for the node
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(int[] value,
                int len)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an array of integers. This would be used to set MFInt32 field types.

Parameters:
value - The new value to use for the node
len - The number of valid entries in the value array
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(boolean value)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an boolean. This would be used to set SFBool field types.

Parameters:
value - The new value to use for the node
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(boolean[] value,
                int len)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an array of boolean. This would be used to set MFBool field types.

Parameters:
value - The new value to use for the node
len - The number of valid entries in the value array
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(float value)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Parameters:
value - The new value to use for the node
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(float[] value,
                int len)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation field types.

Parameters:
value - The new value to use for the node
len - The number of valid entries in the value array
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(long value)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an long. This would be used to set SFTime field types.

Parameters:
value - The new value to use for the node
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(long[] value,
                int len)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an array of longs. This would be used to set MFTime field types.

Parameters:
value - The new value to use for the node
len - The number of valid entries in the value array
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(double value)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an double. This would be used to set SFDouble field types.

Parameters:
value - The new value to use for the node
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(double[] value,
                int len)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an array of doubles. This would be used to set MFDouble, SFVec2d and SFVec3d field types.

Parameters:
value - The new value to use for the node
len - The number of valid entries in the value array
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(java.lang.String value)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as a string. This would be used to set SFString field types.

Parameters:
value - The new value to use for the node
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

fieldValue

void fieldValue(java.lang.String[] value,
                int len)
                throws SAVException,
                       VRMLException
Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Parameters:
value - The new value to use for the node
len - The number of valid entries in the value array
Throws:
SAVException - This call is taken at the wrong time in the structure of the document.
VRMLException - This call is taken at the wrong time in the structure of the document.

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium