Package xj3d.filter.node

Interface Encodable

All Known Subinterfaces:

IAppearance, IAppearanceChild, IBindable, IBounded, IChild, IColor, IComposedGeometry, ICoordinate, IGeometricProperty, IGeometry, IGrouping, IMaterial, IMetadata, INormal, IShape, ITexture, ITexture2D, ITextureCoordinate, ITextureTransform, IUrl, IViewpoint

All Known Implementing Classes:

Appearance, BaseComposedGeometry, BaseEncodable, BaseGeometry, BaseGroup, BaseMetadata, BaseTexture2D, Collision, Color, ColorRGBA, CommonEncodable, CommonScene, Coordinate, FillProperties, Group, ImageTexture, IndexedFaceSet, IndexedLineSet, IndexedTriangleFanSet, IndexedTriangleSet, IndexedTriangleStripSet, LineProperties, LineSet, Material, MatrixTransform, MetadataDouble, MetadataFloat, MetadataInteger, MetadataSet, MetadataString, MultiTexture, MultiTextureCoordinate, MultiTextureTransform, Normal, PointSet, Scene, Shape, Switch, TextureCoordinate, TextureProperties, TextureTransform, Transform, TriangleFanSet, TriangleSet, TriangleStripSet, Viewpoint

public interface Encodable

Primary interface for encoding node representations in this package.

Version:

$Revision: 1.4 $

Author:

Rex Melton

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the node fields to their initial values
Encodable	clone(boolean full)	Create and return a copy of this object.
boolean	deepEquals(Encodable enc)	Compares this appearance to another and checks if all fields are the same and that all children fields are the same.
void	encode()	Push the node contents to the ContentHandler
String	getDefName()	Return the DEF name of the node
String	getNodeName()	Return the name of the node
String	getUseName()	Return the USE name of the node
void	setContentHandler(ContentHandler handler)	Set the content handler.
void	setDefName(String defName)	Set the DEF name of the node
void	setFieldReader(VRMLFieldReader fieldReader)	Set the reader to use for parsing field values.
void	setUseName(String useName)	Set the USE name of the node
void	setValue(String name, Object value)	Set the value of the named field.
void	setValue(String name, Object value, int len)	Set the value of the named field.

Method Details

getNodeName

String getNodeName()

Return the name of the node

Returns:

the name of the node

getDefName

String getDefName()

Return the DEF name of the node

Returns:

the DEF name of the node

setDefName

void setDefName(String defName)

Set the DEF name of the node

Parameters:

defName - the DEF name of the node

getUseName

String getUseName()

Return the USE name of the node

Returns:

the USE name of the node

setUseName

void setUseName(String useName)

Set the USE name of the node

Parameters:

useName - the USE name of the node

clear

void clear()

Clear the node fields to their initial values

encode

void encode()

Push the node contents to the ContentHandler

setValue

void setValue(String name,
 Object value)

Set the value of the named field.

Parameters:

name - The name of the field to set.

value - The value of the field.

setValue

void setValue(String name,
 Object value,
 int len)

Set the value of the named field.

Parameters:

name - The name of the field to set.

value - The value of the field.

len - The number of values in the array.

setContentHandler

void setContentHandler(ContentHandler handler)

Set the content handler.

Parameters:

handler - The ContentHandler instance to use

setFieldReader

void setFieldReader(VRMLFieldReader fieldReader)

Set the reader to use for parsing field values.

Parameters:

fieldReader - The reader

clone

Encodable clone(boolean full)

Create and return a copy of this object.

Parameters:

full - true if the clone should contain a copy of the complete contents of this node and it's children. false if the clone should be a new instance of this node type. Typically a full clone is done when the contents of the node will require subsequent modification. A shallow clone is done when a USE function is required.

Returns:

a copy of this.

deepEquals

boolean deepEquals(Encodable enc)

Compares this appearance to another and checks if all fields are the same and that all children fields are the same.

Returns: