SFFloatObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.fields.X3DConcreteField
- - org.web3d.x3d.jsail.fields.SFFloatObject

All Implemented Interfaces:

SFFloat, X3DField
```
public class SFFloatObject
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: MFFloatObject

See Also:

X3D Tooltips: type SFFloat, 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 and Description
`static float`	`DEFAULT_VALUE` Default value for this field type is 0.0.
`static java.lang.String`	`DEFAULT_VALUE_STRING` Default string value for this field type is "0.0".
`static java.lang.String`	`NAME` String constant NAME provides name of this element: SFFloat
`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 and Description
`SFFloatObject()` Constructor for SFFloatObject performs value initialization.
`SFFloatObject(double newValue)` Constructor using double as new initial value.
`SFFloatObject(float newValue)` Constructor for SFFloatObject using a corresponding Java primitive float as new initial value.
`SFFloatObject(int newValue)` Constructor using int as new initial value.
`SFFloatObject(SFFloatObject newValue)` Constructor to copy an SFFloatObject value as initial value for this new field object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getPrimitiveValue()` Provides current value of the field as a Java primitive type.
`float`	`getValue()` Get the current value.
`void`	`initialize()` Initialization for SFFloatObject applies default initial value.
`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.
`SFFloatObject`	`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.
`SFFloatObject`	`setValue(int newValue)` Apply an int value to this float field type, note change in precision.
`SFFloatObject`	`setValue(SFFloatObject newValue)` Apply an SFFloatObject value to this field.
`SFFloatObject`	`setValueByString(java.lang.String newValue)` Utility accessor for SFFloatObject using String value (which must pass parsing validation checks).
`java.lang.String`	`stripTrailingZeroes()` Utility method to strip trailing fractional zeroes from String representations of the current object's value.
`static java.lang.String`	`stripTrailingZeroes(float value)` Utility method to always strip trailing fractional zeroes from String value of any given float.
`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 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

Methods inherited from interface org.web3d.x3d.sai.X3DField
addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: SFFloat
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
public static final float DEFAULT_VALUE
```
    Default value for this field type is 0.0.
    
    See Also:
    
    Java Tutorials: Primitive Data Types, Constant Field Values
  - DEFAULT_VALUE_STRING
```
public static final java.lang.String DEFAULT_VALUE_STRING
```
    Default string value for this field type is "0.0".
    
    See Also:
    
    Constant Field Values
  - TUPLE_SIZE
```
public 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).
    
    See Also:
    
    Constant Field Values
  - REGEX
```
public static final java.lang.String REGEX
```
    Default regular expression (regex) pattern for this field type is (\s)*([+-]?((0|[1-9][0-9]*)(\.[0-9]*)?|\.[0-9]+)([Ee][+-]?[0-9]+)?)(\s)*
    
    See Also:
    
    PATTERN, matches(), matches(String), validate(), X3D Regular Expressions: SFFloat, Constant Field Values
  - PATTERN
```
public static final java.util.regex.Pattern PATTERN
```
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    
    See Also:
    
    REGEX, matches(), matches(String), validate(), java.util.regex.Pattern
- Constructor Detail
  - SFFloatObject
```
public SFFloatObject()
```
    Constructor for SFFloatObject performs value initialization.
  - SFFloatObject
```
public SFFloatObject(SFFloatObject newValue)
```
    Constructor to copy an SFFloatObject value as initial value for this new field object.
    
    Parameters:
    
    newValue - The newValue to apply
  - SFFloatObject
```
public SFFloatObject(float newValue)
```
    Constructor for SFFloatObject using a corresponding Java primitive float as new initial value.
    
    Parameters:
    
    newValue - is new value to assign setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
  - SFFloatObject
```
public SFFloatObject(double newValue)
```
    Constructor using double as new initial value.
    
    Parameters:
    
    newValue - is new value to assign
  - SFFloatObject
```
public SFFloatObject(int newValue)
```
    Constructor using int as new initial value.
    
    Parameters:
    
    newValue - is new value to assign
- Method Detail
  - initialize
```
public void initialize()
```
    Initialization for SFFloatObject 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
  - validate
```
public final java.lang.String validate()
```
    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(), 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 SFFloatObject setValueByString(java.lang.String newValue)
                               throws InvalidFieldValueException
```
    Utility accessor for SFFloatObject 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:
    
    X3DLoaderObject.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
    
    See Also:
    
    X3D Tooltips: type
  - 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 java.lang.String toString()
```
    Provides current value as a String.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String version of the provided value
    
    See Also:
    
    X3D Tooltips: type SFFloat
  - 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:
    
    X3DConcreteField.getTupleSize(String)
  - setValue
```
public SFFloatObject setValue(double newValue)
```
    Apply a double value to this float field type, note change in precision.
    
    Parameters:
    
    newValue - The double newValue to apply
    
    Returns:
    
    SFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setValue
```
public SFFloatObject setValue(int newValue)
```
    Apply an int value to this float field type, note change in precision.
    
    Parameters:
    
    newValue - The int newValue to apply
    
    Returns:
    
    SFFloatObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - stripTrailingZeroes
```
public java.lang.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:
    
    StackOverflow: Remove trailing zero in Java, StackOverflow: Remove trailing zeros from double (String manipulation solution), StackOverflow: How to nicely format floating numbers to String without unnecessary decimal 0? ("In short" solution), Regular Expressions Cookbook, 6.6. Strip Leading Zeros, by Jan Goyvaerts, Steven Levithan
  - stripTrailingZeroes
```
public static java.lang.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:
    
    stripTrailingZeroes(float)
  - setValue
```
public SFFloatObject setValue(SFFloatObject newValue)
```
    Apply an SFFloatObject value to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    SFFloatObject - 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

Class SFFloatObject

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

DEFAULT_VALUE

DEFAULT_VALUE_STRING

TUPLE_SIZE

REGEX

PATTERN

Constructor Detail

SFFloatObject

SFFloatObject

SFFloatObject

SFFloatObject

SFFloatObject

Method Detail

initialize

validate

matches

matches

setValueByString

toString

getValue

getPrimitiveValue

toString

setValue

setValue

setValue

stripTrailingZeroes

stripTrailingZeroes

setValue

isDefaultValue