Class MFFloatObject

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.MFFloatObject
All Implemented Interfaces:
MFFloat, MField, X3DField

public class MFFloatObject
extends X3DConcreteField
implements MFFloat
This utility class provides a concrete implementation corresponding to MFFloat X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFFloat is an array of SFFloat values, meaning a single-precision floating-point array type. Array values are optionally separated by commas.

Related field object: SFFloatObject
See Also:
X3D Tooltips: type MFFloat, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFFloatAndMFFloat, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static float[] DEFAULT_VALUE
    Default value for this field type is an empty array.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "".
    static java.lang.String NAME
    String constant NAME provides name of this element: MFFloat
    static java.util.regex.Pattern PATTERN
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static java.lang.String REGEX
    Default regular expression (regex) pattern for this field type is (\s)*(([+-]?
    static int TUPLE_SIZE
    Default tuple size for this field type is 1 (i.e. number of component values making up a single-field SF object).

    Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    MFFloatObject()
    Constructor for MFFloatObject performs value initialization.
    MFFloatObject​(double newValue)
    Utility constructor for MFFloatObject to assign a single double as new initial array value.
    MFFloatObject​(double[] newValue)
    Utility constructor for MFFloatObject using an alternatively typed Java double[] array as new initial value.
    MFFloatObject​(float newValue)
    Utility constructor for MFFloatObject to assign a single float as new initial array value.
    MFFloatObject​(float[] newValue)
    Constructor for MFFloatObject using a corresponding Java primitive float[] array as new initial value.
    MFFloatObject​(MFFloatObject newValue)
    Constructor to copy an MFFloatObject value as initial value for this new field object.
    MFFloatObject​(SFFloatObject newValue)
    Utility constructor for MFFloatObject using a corresponding SFFloatObject as new initial value (which must pass parsing validation checks).
  • Method Summary

    Modifier and Type Method Description
    void append​(float newValue)
    Places new value(s) at the end of the existing value array, increasing the field length accordingly.
    void append​(float[] newValue)
    Appends another array at the end of the existing value array, increasing the field length accordingly.
    MFFloatObject append​(MFFloatObject newValue)
    Appends a new MFFloatObject to the end of the existing value array, increasing the field length accordingly.
    MFFloatObject append​(SFFloatObject newValue)
    Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
    void clear()
    Removes all values in the field array, changing the array size to zero.
    boolean equals​(MFFloatObject comparisonMFFloatObject)
    Determine whether two objects contain equal values.
    float get1Value​(int index)
    Get an individual value from the existing field array.
    float[] getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    void getValue​(float[] valueDestination)
    Get the current value of this MFFloatObject by copying it into the valueDestination array, leaving the current object unchanged.
    void initialize()
    Initialization for MFFloatObject applies default initial value.
    void insertValue​(int index, float newValue)
    Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
    static boolean isArray()
    Whether or not this field type is an array (true)
    boolean isDefaultValue()
    Determine whether current value matches DEFAULT_VALUE
    boolean matches()
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static boolean matches​(java.lang.String value)
    Test PATTERN match with regular expression (regex) of provided value.
    MFFloatObject multiply​(float scaleFactor)
    Multiply scaleFactor times all values in this field type.
    void remove​(int index)
    Remove one SFFloat element of the field array at index position, if found.
    void set1Value​(int index, float newValue)
    Replace a single value at the appropriate location in the existing value array.
    MFFloatObject setValue​(double[] newValue)
    Assign a double-precision array value to this single-precision field.
    void setValue​(float newValue)
    Assign a single float value as new array (of length 1).
    void setValue​(float[] newValue)
    Assign a new float[] value to this field.
    void setValue​(int size, float[] newValue)
    Assign an array subset to this field.
    MFFloatObject setValue​(MFFloatObject newValue)
    Apply an MFFloatObject value to this field.
    MFFloatObject setValue​(SFFloatObject newValue)
    Assign a single-field SFFloatObject as new array value.
    MFFloatObject setValueByString​(java.lang.String newValue)
    Utility accessor for MFFloatObject using String value (which must pass parsing validation checks).
    int size()
    Get the size of the underlying data array, meaning the number of simple SFFloat elements for the given data type.
    float[] toFloatArray()
    Provide float array for this field type.
    java.lang.String toString()
    Provides current value as a String.
    static java.lang.String toString​(float[] value)
    Static utility method to provide String representation of a correctly typed input value.
    java.lang.String validate()
    Validate current value via get/set comparison tests
    java.lang.String validateRegex()
    Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.web3d.x3d.sai.X3DField

    addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener
  • Field Details

  • Constructor Details

    • MFFloatObject

      public MFFloatObject()
      Constructor for MFFloatObject performs value initialization.
    • MFFloatObject

      public MFFloatObject​(float newValue)
      Utility constructor for MFFloatObject to assign a single float as new initial array value.
      Parameters:
      newValue - is new value to assign
    • MFFloatObject

      public MFFloatObject​(SFFloatObject newValue)
      Utility constructor for MFFloatObject using a corresponding SFFloatObject as new initial value (which must pass parsing validation checks).
      Parameters:
      newValue - is new value to assign
    • MFFloatObject

      public MFFloatObject​(MFFloatObject newValue)
      Constructor to copy an MFFloatObject value as initial value for this new field object.
      Parameters:
      newValue - The newValue to apply
    • MFFloatObject

      public MFFloatObject​(float[] newValue)
      Constructor for MFFloatObject using a corresponding Java primitive float[] array as new initial value.
      Parameters:
      newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
    • MFFloatObject

      public MFFloatObject​(double newValue)
      Utility constructor for MFFloatObject to assign a single double as new initial array value.
      Parameters:
      newValue - is new value to assign
    • MFFloatObject

      public MFFloatObject​(double[] newValue)
      Utility constructor for MFFloatObject using an alternatively typed Java double[] array as new initial value.
      Parameters:
      newValue - is new value to assign
  • Method Details

    • isArray

      public static final boolean isArray()
      Whether or not this field type is an array (true)
    • initialize

      public final void initialize()
      Initialization for MFFloatObject applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.
      Specified by:
      initialize in class X3DConcreteField
      See Also:
      Stack Overflow: How to check if a given Regex is valid?, DEFAULT_VALUE
    • equals

      public boolean equals​(MFFloatObject comparisonMFFloatObject)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonMFFloatObject - field type to compare
      Returns:
      true if equivalent, false otherwise
    • validate

      public final java.lang.String validate()
      Validate current value via get/set comparison tests
      Returns:
      empty string if get/set testing passes, warning otherwise
      See Also:
      validate(), validateRegex()
    • validateRegex

      public final java.lang.String validateRegex()
      Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.
      Returns:
      empty string if PATTERN matches, warning otherwise
      See Also:
      REGEX, PATTERN, matches(), matches(String), validate(), validate(), java.util.regex.Pattern
    • matches

      public final boolean matches()
      Test PATTERN match via regular expression (regex) check of current object's toString() value.
      Returns:
      true if PATTERN matches, false otherwise
      See Also:
      REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
    • matches

      public static final boolean matches​(java.lang.String value)
      Test PATTERN match with regular expression (regex) of provided value.
      Parameters:
      value - String to check against regex pattern for successful match
      Returns:
      true if PATTERN matches, false otherwise
      See Also:
      REGEX, PATTERN, matches(), matches(String), validate(), java.util.regex.Pattern
    • setValueByString

      public MFFloatObject setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for MFFloatObject using String value (which must pass parsing validation checks).

      Warning: this method is not type safe at compile time! Best practice for X3DJSAIL programmers is to use strongly typed methods instead, in order to avoid potential for run-time errors.
      Parameters:
      newValue - is new value to assign, if empty then assign DEFAULT_VALUE
      Returns:
      MFMatrix4dObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
      Throws:
      InvalidFieldValueException
      See Also:
      X3DLoaderDOM.toX3dObjectTree(org.w3c.dom.Node)
    • toString

      public static java.lang.String toString​(float[] value)
      Static utility method to provide String representation of a correctly typed input value.
      Parameters:
      value - The value to convert to a String
      Returns:
      String version of the provided value, with trailing zeroes and decimal points omitted.
      See Also:
      X3D Tooltips: type, SFFloatObject.stripTrailingZeroes(float)
    • getValue

      public void getValue​(float[] valueDestination)
      Get the current value of this MFFloatObject by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface MFFloat
      Parameters:
      valueDestination - The array to be filled in with current field values.
    • getPrimitiveValue

      public float[] getPrimitiveValue()
      Provides current value of the field as a Java primitive type.
      Returns:
      current value
    • toString

      public java.lang.String toString()
      Provides current value as a String.
      Overrides:
      toString in class java.lang.Object
      Returns:
      String version of the provided value, with trailing zeroes and decimal points omitted.
      See Also:
      X3D Tooltips: type MFFloat, SFFloatObject.stripTrailingZeroes(float)
    • get1Value

      public float get1Value​(int index)

      Get an individual value from the existing field array.

      If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

      Specified by:
      get1Value in interface MFFloat
      Parameters:
      index - is position of selected value in current array
      Returns:
      The selected value
      Throws:
      java.lang.ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.
    • setValue

      public void setValue​(int size, float[] newValue)
      Assign an array subset to this field.
      Specified by:
      setValue in interface MFFloat
      Parameters:
      size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
      newValue - The replacement value array to (potentially) slice and then assign.
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public void setValue​(float[] newValue)
      Assign a new float[] value to this field.
      Parameters:
      newValue - is replacement value array to assign
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public MFFloatObject setValue​(double[] newValue)
      Assign a double-precision array value to this single-precision field.

      Warning: this method casts type of input values from higher precision to lower precision.

      Parameters:
      newValue - is replacement value array to assign
      Returns:
      MFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValue

      public void setValue​(float newValue)
      Assign a single float value as new array (of length 1).
      Parameters:
      newValue - The replacement value to assign.
    • setValue

      public MFFloatObject setValue​(SFFloatObject newValue)
      Assign a single-field SFFloatObject as new array value.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      MFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    • set1Value

      public void set1Value​(int index, float newValue) throws java.lang.ArrayIndexOutOfBoundsException
      Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change.
      Specified by:
      set1Value in interface MFFloat
      Parameters:
      index - is position of selected value in current array
      newValue - provides new value to apply
      Throws:
      java.lang.ArrayIndexOutOfBoundsException
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public void append​(float newValue)
      Places new value(s) at the end of the existing value array, increasing the field length accordingly.
      Specified by:
      append in interface MFFloat
      Parameters:
      newValue - The newValue to append
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public void append​(float[] newValue)
      Appends another array at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec4f tuple size of 4.
      Parameters:
      newValue - The newValue to append
      See Also:
      X3DConcreteField.getTupleSize(String)
    • append

      public MFFloatObject append​(SFFloatObject newValue)
      Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.
      Parameters:
      newValue - The newValue to append
      Returns:
      MFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • append

      public MFFloatObject append​(MFFloatObject newValue)
      Appends a new MFFloatObject to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.
      Parameters:
      newValue - The newValue to append
      Returns:
      MFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • insertValue

      public void insertValue​(int index, float newValue)
      Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
      Specified by:
      insertValue in interface MFFloat
      Parameters:
      index - The position for the inserted value in the current array
      newValue - The newValue to insert
      See Also:
      X3DConcreteField.getTupleSize(String)
    • size

      public int size()
      Get the size of the underlying data array, meaning the number of simple SFFloat elements for the given data type.
      Specified by:
      size in interface MField
      Returns:
      The number of SFFloat elements in this field array.
    • clear

      public void clear()
      Removes all values in the field array, changing the array size to zero.
      Specified by:
      clear in interface MField
    • remove

      public void remove​(int index)
      Remove one SFFloat element of the field array at index position, if found. Initial element is at index 0.
      Specified by:
      remove in interface MField
      Parameters:
      index - position of element in field array that gets removed
    • toFloatArray

      public float[] toFloatArray()
      Provide float array for this field type.
      Returns:
      Array of floats in this field array.
    • setValue

      public MFFloatObject setValue​(MFFloatObject newValue)
      Apply an MFFloatObject value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      MFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • multiply

      public MFFloatObject multiply​(float scaleFactor)
      Multiply scaleFactor times all values in this field type.
      Parameters:
      scaleFactor - scalar value for vector multiplication
      Returns:
      MFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • isDefaultValue

      public boolean isDefaultValue()
      Determine whether current value matches DEFAULT_VALUE
      Returns:
      whether current value matches DEFAULT_VALUE
      See Also:
      DEFAULT_VALUE