Package org.web3d.x3d.sai

Interface X3DFieldDefinition

All Known Implementing Classes:
X3DConcreteFieldDefinition
public interface X3DFieldDefinition
Representation of a node's field definition.


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:
SAI Java Specification: B.4.4 X3DFieldDefinition, SAI Abstract Specification: 6.3.10 SAIFieldDefinition, X3D Tooltips, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    int getAccessType()
    Get the access type of the field.
    int getFieldType()
    Get the field type.
    java.lang.String getFieldTypeString()
    Get the field type.
    java.lang.String getName()
    Get the name of this field.

  • Method Details

    • getName

      java.lang.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:
      X3DFieldTypes

    • 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:
      X3DFieldTypes

    • getFieldTypeString

      java.lang.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