Class SFFloat

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFFloat
All Implemented Interfaces:
SFFloat, X3DField
public class SFFloat extends X3DConcreteField implements SFFloat
This utility class provides a concrete implementation corresponding to SFFloat X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFFloat is a single-precision floating-point type.

Related field object: MFFloat
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final float
    DEFAULT_VALUE
    Default value for this field type is 0.0.
    static final String
    DEFAULT_VALUE_STRING
    Default string value for this field type is "0.0".
    static final String
    NAME
    String constant NAME provides name of this element: SFFloat
    static final Pattern
    PATTERN
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static final String
    REGEX
    Default regular expression (regex) pattern for this field type is \s*([+-]?
    static final 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
    SFFloat()
    Constructor for SFFloat performs value initialization.
    SFFloat(double newValue)
    Constructor using double as new initial value.
    SFFloat(float newValue)
    Constructor for SFFloat using a corresponding Java primitive float as new initial value.
    SFFloat(int newValue)
    Constructor using int as new initial value.
    SFFloat(SFFloat newValue)
    Constructor to copy an SFFloat value as initial value for this new field object.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(float comparisonValue)
    Determine whether current SFFloat object and float contain equal values.
    boolean
    equals(SFFloat comparisonSFFloat)
    Determine whether current object and another SFFloat object contain equal values.
    float
    getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    float
    getValue()
    Get the current value.
    final void
    initialize()
    Initialization for SFFloat applies default initial value.
    static final boolean
    isArray()
    Whether or not this field type is an array (false)
    boolean
    isDefaultValue()
    Determine whether current value matches DEFAULT_VALUE
    final boolean
    matches()
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static final boolean
    matches(String value)
    Test PATTERN match with regular expression (regex) of provided value.
    SFFloat
    setValue(double newValue)
    Apply a double value to this float field type, note change in precision.
    void
    setValue(float newValue)
    Assign a new value to this field.
    SFFloat
    setValue(int newValue)
    Apply an int value to this float field type, note change in precision.
    SFFloat
    setValue(SFFloat newValue)
    Apply an SFFloat value to this field.
    SFFloat
    setValueByString(String newValue)
    Utility accessor for SFFloat using String value (which must pass parsing validation checks).
    String
    stripTrailingZeroes()
    Utility method to strip trailing fractional zeroes from String representations of the current object's value.
    static String
    stripTrailingZeroes(float value)
    Utility method to always strip trailing fractional zeroes from String value of any given float.
    String
    toString()
    Provides current value as a String.
    static String
    toString(float value)
    Static utility method to provide String representation of a correctly typed input value.
    final String
    validate()
    Validate current value via get/set comparison tests
    final 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 org.web3d.x3d.jsail.fields.X3DConcreteField

    addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • SFFloat

      public SFFloat()
      Constructor for SFFloat performs value initialization.

    • SFFloat

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

    • SFFloat

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

    • SFFloat

      public SFFloat(double newValue)
      Constructor using double as new initial value.
      Parameters:
      newValue - is new value to assign

    • SFFloat

      public SFFloat(int newValue)
      Constructor using int 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 (false)
      Returns:
      true if array type

    • initialize

      public final void initialize()
      Initialization for SFFloat 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:

    • equals

      public boolean equals(SFFloat comparisonSFFloat)
      Determine whether current object and another SFFloat object contain equal values.
      Parameters:
      comparisonSFFloat - field type to compare
      Returns:
      true if equivalent, false otherwise

    • equals

      public boolean equals(float comparisonValue)
      Determine whether current SFFloat object and float contain equal values.
      Parameters:
      comparisonValue - float[] array to compare
      Returns:
      true if equivalent, false otherwise

    • validate

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

    • validateRegex

      public final 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:

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

    • matches

      public static final boolean matches(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:

    • setValueByString

      public SFFloat setValueByString(String newValue) throws InvalidFieldValueException
      Utility accessor for SFFloat 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:
      MFMatrix4d - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
      Throws:
      InvalidFieldValueException
      See Also:

    • toString

      public static 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
      See Also:

    • getValue

      public float getValue()
      Get the current value.
      Specified by:
      getValue in interface SFFloat
      Returns:
      current value

    • getPrimitiveValue

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

    • toString

      public String toString()
      Provides current value as a String.
      Overrides:
      toString in class Object
      Returns:
      String version of the provided value
      See Also:

    • setValue

      public void setValue(float newValue)
      Assign a new value to this field.
      Specified by:
      setValue in interface SFFloat
      Parameters:
      newValue - The replacement value to assign.
      See Also:

    • setValue

      public SFFloat setValue(double newValue)
      Apply a double value to this float field type, note change in precision.
      Parameters:
      newValue - The double newValue to apply
      Returns:
      SFFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

      public SFFloat setValue(int newValue)
      Apply an int value to this float field type, note change in precision.
      Parameters:
      newValue - The int newValue to apply
      Returns:
      SFFloat - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • stripTrailingZeroes

      public String stripTrailingZeroes()
      Utility method to strip trailing fractional zeroes from String representations of the current object's value. Applicability: first converting an integer (such as 100) to float and then String results in trailing decimal point and zero (such as 100.0). Functionality can be globally enabled/disabled by ConfigurationProperties.setStripTrailingZeroes(boolean).
      Returns:
      string value with trailing zeros and decimal points stripped
      See Also:

    • stripTrailingZeroes

      public static String stripTrailingZeroes(float value)
      Utility method to always strip trailing fractional zeroes from String value of any given float. Applicability: first converting an integer (such as 100) to float and then String results in trailing decimal point and zero (such as 100.0). Note: not affected by ConfigurationProperties.setStripTrailingZeroes(boolean).
      Parameters:
      value - a single-precision number
      Returns:
      string value with trailing zeros and decimal points stripped
      See Also:

    • setValue

      public SFFloat setValue(SFFloat newValue)
      Apply an SFFloat value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      SFFloat - 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: