Package xj3d.filter.node

Class BaseGroup

java.lang.Object

xj3d.filter.node.BaseEncodable

xj3d.filter.node.BaseGroup

All Implemented Interfaces:

Encodable, IChild, IGrouping

Direct Known Subclasses:

Collision, Group, MatrixTransform, Switch, Transform

public abstract class BaseGroup
extends BaseEncodable
implements IChild, IGrouping

Base abstract impl wrapper for an X3D grouping nodes.

Version:

$Revision: 1.2 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<Encodable>	children	The root nodes

Fields inherited from class xj3d.filter.node.BaseEncodable

bch, defName, fieldReader, handler, HANDLER_BINARY, HANDLER_NULL, HANDLER_STRING, handlerType, nodeName, sch, useName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseGroup(String name, String defName)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addChild(Encodable enc)	Add a child to this grouping node.
void	addChildren(Encodable[] enc)	Add children to this grouping node.
void	clear()	Clear the node fields to their initial values
protected void	copy(BaseEncodable enc, boolean deep)	Copy the working objects of this into the argument.
void	encode()	Push the node contents to the ContentHandler
Encodable[]	getChildren()	Return the children of this grouping node.
void	setChildren(Encodable[] enc)	Clear and set the children of this grouping 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.

Methods inherited from class xj3d.filter.node.BaseEncodable

clone, deepEquals, getDefName, getMetadata, getNodeName, getUseName, setContentHandler, setDefName, setFieldReader, setMetadata, setUseName

Methods inherited from class java.lang.Object

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

Methods inherited from interface xj3d.filter.node.Encodable

clone, deepEquals, getDefName, getNodeName, getUseName, setContentHandler, setDefName, setFieldReader, setUseName

Field Details

children

protected ArrayList<Encodable> children

The root nodes

Constructor Details

BaseGroup

protected BaseGroup(String name,
 String defName)

Constructor

Parameters:

name - The node name

defName - The node's DEF name

Method Details

clear

public void clear()

Clear the node fields to their initial values

Specified by:

clear in interface Encodable

Overrides:

clear in class BaseEncodable

encode

public void encode()

Push the node contents to the ContentHandler

Specified by:

encode in interface Encodable

Overrides:

encode in class BaseEncodable

setValue

public void setValue(String name,
 Object value)

Set the value of the named field.

Specified by:

setValue in interface Encodable

Overrides:

setValue in class BaseEncodable

Parameters:

name - The name of the field to set.

value - The value of the field.

setValue

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

Set the value of the named field.

Specified by:

setValue in interface Encodable

Overrides:

setValue in class BaseEncodable

Parameters:

name - The name of the field to set.

value - The value of the field.

len - The number of values in the array.

copy

protected void copy(BaseEncodable enc,
 boolean deep)

Copy the working objects of this into the argument. Used by subclasses to initialize a clone.

Overrides:

copy in class BaseEncodable

Parameters:

enc - The encodable to initialize.

deep - true to initialize this nodes fields, false otherwise.

setChildren

public void setChildren(Encodable[] enc)

Clear and set the children of this grouping node.

Parameters:

enc - The Child nodes to set as children of this grouping node. A value of null just performs a clear.

getChildren

public Encodable[] getChildren()

Return the children of this grouping node.

Returns:

The Child nodes of this grouping node.

addChildren

public void addChildren(Encodable[] enc)

Add children to this grouping node.

Parameters:

enc - The Child nodes to add to this grouping node.

addChild

public void addChild(Encodable enc)

Add a child to this grouping node.

Parameters:

enc - A Child node to add to this grouping node.