Package org.web3d.x3d.sai
Interface X3DFieldDefinition
- All Known Implementing Classes:
X3DConcreteFieldDefinition
public interface X3DFieldDefinition
Representation of a node's field definition.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). The field definition holds the static field information such as the field access type, the data type and the name of the field. The implementation of the toString() method of this class shall return the full IDL declaration of the field as per the specification, not the UTF8 or XML format. Implementation of .equals() shall return true if the two field definitions share the same access type, data type and name. It shall not include the underlying field's values at that point in time.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). The field definition holds the static field information such as the field access type, the data type and the name of the field. The implementation of the toString() method of this class shall return the full IDL declaration of the field as per the specification, not the UTF8 or XML format. Implementation of .equals() shall return true if the two field definitions share the same access type, data type and name. It shall not include the underlying field's values at that point in time.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionintGet the access type of the field.intGet the field type.Get the field type.getName()Get the name of this field.
-
Method Details
-
getName
String getName()Get the name of this field. This will be something like "children" or "translation". If the field is an exposed field then the name give will be the base name without any set_ or _changed added to the name, regardless of how the initial field was fetched.- Returns:
- The name of this field
-
getAccessType
int getAccessType()Get the access type of the field. This will be one of field, exposedField, eventIn or eventOut constants described in the X3DFieldTypes interface.- Returns:
- The access type of this node
- See Also:
-
getFieldType
int getFieldType()Get the field type. This string represents the field type such as MFNode, SFInt32. The definition of the returned int value is described in the X3DFieldType interface.- Returns:
- A constant describing the field type
- See Also:
-
getFieldTypeString
String getFieldTypeString()Get the field type. This string represents the field type such as MFNode, SFInt32, etc. A string is used to allow full extensibility.- Returns:
- A string describing the field type
-