Xj3D 2.0 VRML/X3D Code API

org.web3d.vrml.scripting.jsai
Interface FieldFactory

All Known Implementing Classes:
JSAIFieldFactory

public interface FieldFactory

Factory abstract interface for generating fields from a given node.

The idea of this factory is to break a circular compile dependency between JSAINode and JSAISFNode/JSAIMFNode.

Version:
$Revision: 1.2 $
Author:
Justin Couch

Method Summary
 ConstField createConstField(VRMLNodeType node, java.lang.String field)
          Create a constant field that represents an eventOut.
 Field createField(VRMLNodeType node, java.lang.String field, boolean checkEventIn)
          Create a field given a name from the node.
 

Method Detail

createField

Field createField(VRMLNodeType node,
                  java.lang.String field,
                  boolean checkEventIn)
Create a field given a name from the node.

Parameters:
node - The node to create the field from
field - The name of the field to fetch
checkEventIn - true if we should check for an event in
Returns:
An instance of the field class representing the field
Throws:
InvalidEventInException - The field is not an eventIn
InvalidExposedFieldException - The field is not an exposedField

createConstField

ConstField createConstField(VRMLNodeType node,
                            java.lang.String field)
Create a constant field that represents an eventOut.

Parameters:
node - The node to create the field from
field - The name of the field to fetch
Returns:
An instance of the field class representing the field
Throws:
InvalidEventInException - The field is not an eventOut

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium