Class SFVec4f

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


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFVec4f is a 4-tuple set of single-precision floating-point values, specifying a 3D homogeneous vector. Warning: comma characters within singleton values do not pass strict XML validation.

Related field object: MFVec4f
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final float[]
    DEFAULT_VALUE
    Default value for this field type contains values of 0 0 0 0.
    static final String
    DEFAULT_VALUE_STRING
    Default string value for this field type is "0.0 0.0 0.0 1.0".
    static DecimalFormat
    formatPrecision
    DecimalFormat matching local number of significant digits for floating-point and double-precision String output
    static final String
    NAME
    String constant NAME provides name of this field type: SFVec4f
    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 4 (i.e. number of component values making up a single-field SF object).

    Fields inherited from class X3DConcreteField

    validationResult
    Modifier and Type
    Field
    Description
    protected static StringBuilder
    validationResult
    Results log of local validation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SFVec4f()
    Constructor for SFVec4f performs value initialization.
    SFVec4f(double[] newValue)
    Utility constructor for SFVec4f using an alternatively typed Java double[] array as new initial value.
    SFVec4f(double x, double y, double z, double t)
    Utility constructor for SFVec4f using double values.
    SFVec4f(float[] newValue)
    Constructor for SFVec4f using a corresponding Java primitive float[] array as new initial value.
    SFVec4f(float x, float y, float z, float w)
    Utility constructor for SFVec4f using individual primitive values.
    SFVec4f(SFVec4f newValue)
    Constructor to copy an SFVec4f value as initial value for this new field object.

  • Method Summary

    Modifier and Type
    Method
    Description
    SFVec4f
    add(SFVec4f secondValue)
    Add second set of values to corresponding values in this field type.
    boolean
    equals(float[] comparisonValue)
    Determine whether current SFVec4f object and float array contain equal values.
    boolean
    equals(SFVec4f comparisonSFVec4f)
    Determine whether current object and another SFVec4f object contain equal values.
    float
    getEpsilon()
    Current error bound for numerical comparison of values for equality
    float[]
    getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    int
    getSignificantDigits()
    Current significant digits for floating-point and double-precision String output
    void
    getValue(float[] valueDestination)
    Get the current value of this SFVec4f by copying it into the valueDestination array, leaving the current object unchanged.
    final void
    initialize()
    Initialization for SFVec4f 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.
    SFVec4f
    multiply(float scaleFactor)
    Multiply scaleFactor times all values in this field type.
    SFVec4f
    normalize()
    Utility method to normalize this vector value to unit length, ignore if zero length.
    void
    setEpsilon(float newEpsilon)
    Set revised error bound for numerical comparison of values for equality
    void
    setSignificantDigits(int newSignificantDigits)
    Set revised number of significant digits for floating-point and double-precision String output
    SFVec4f
    setValue(double[] newValue)
    Constructor for SFVec4f using a corresponding Java primitive double[] array as new initial value.
    SFVec4f
    setValue(double x, double y, double z, double t)
    Assign a new value to this field.
    void
    setValue(float[] newValue)
    Assign a new value to this field.
    SFVec4f
    setValue(float x, float y, float z, float t)
    Assign a new value to this field.
    SFVec4f
    setValue(SFVec4f newValue)
    Apply an SFVec4f value to this field.
    SFVec4f
    setValueArray(float[] newValue)
    Assign a new array value to this field, pipelined.
    SFVec4f
    setValueByString(String newValue)
    Utility accessor for SFVec4f using String value (which must pass parsing validation checks).
    float[]
    toFloatArray()
    Provide float array for this field type.
    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 X3DConcreteField

    addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable
    Modifier and Type
    Method
    Description
    void
    addX3DEventListener(X3DFieldEventListener newListener)
    WARNING not tested
    X3DConcreteFieldDefinition
    getDefinition()
    WARNING not implemented
    static int
    getTupleSize(String fieldType)
    Compute tuple size for given type (for example, SFVec3f and MFVec3f have tupleSize of 3).
    String
    getValidationResult()
    Get output of results from prior validation, if any
    boolean
    isReadable()
    Check whether field is readable, default /true/
    boolean
    isWritable()
    Check whether field is writable, default /true/
    void
    removeX3DEventListener(X3DFieldEventListener oldListener)
    WARNING not tested
    void
    setReadable(boolean newValue)
    Set whether field is readable
    void
    setWritable(boolean newValue)
    Set whether field is writable

    Methods inherited from class Object

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

  • Field Details

  • Constructor Details

    • SFVec4f

      public SFVec4f()
      Constructor for SFVec4f performs value initialization.

    • SFVec4f

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

    • SFVec4f

      public SFVec4f(float[] newValue)
      Constructor for SFVec4f using a corresponding Java primitive float[] array as new initial value.
      Parameters:
      newValue - is new value to assign Warning: newValue array length must correspond to tuple size for base type SFVec4f tuple size of 4. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)

    • SFVec4f

      public SFVec4f(float x, float y, float z, float w)
      Utility constructor for SFVec4f using individual primitive values.
      Parameters:
      x - first component
      y - second component
      z - third component
      w - fourth component
      See Also:

    • SFVec4f

      public SFVec4f(double x, double y, double z, double t)
      Utility constructor for SFVec4f using double values.
      Parameters:
      x - first component
      y - second component
      z - third component
      t - fourth component
      See Also:

    • SFVec4f

      public SFVec4f(double[] newValue)
      Utility constructor for SFVec4f 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 (false)
      Returns:
      true if array type

    • initialize

      public final void initialize()
      Initialization for SFVec4f 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(SFVec4f comparisonSFVec4f)
      Determine whether current object and another SFVec4f object contain equal values.
      Parameters:
      comparisonSFVec4f - field type to compare
      Returns:
      true if equivalent, false otherwise

    • setEpsilon

      public void setEpsilon(float newEpsilon)
      Set revised error bound for numerical comparison of values for equality
      Parameters:
      newEpsilon - new value for epsilon, must be positive

    • getEpsilon

      public float getEpsilon()
      Current error bound for numerical comparison of values for equality

    • setSignificantDigits

      public void setSignificantDigits(int newSignificantDigits)
      Set revised number of significant digits for floating-point and double-precision String output
      Parameters:
      newSignificantDigits - new value for significantDigits, must be non-negative

    • getSignificantDigits

      public int getSignificantDigits()
      Current significant digits for floating-point and double-precision String output

    • equals

      public boolean equals(float[] comparisonValue)
      Determine whether current SFVec4f object and float array 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 SFVec4f setValueByString(String newValue) throws InvalidFieldValueException
      Utility accessor for SFVec4f 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:

    • normalize

      public SFVec4f normalize()
      Utility method to normalize this vector value to unit length, ignore if zero length.
      Returns:
      SFVec4f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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, with trailing zeroes and decimal points omitted.
      See Also:

    • getValue

      public void getValue(float[] valueDestination)
      Get the current value of this SFVec4f by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface SFVec4f
      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 String toString()
      Provides current value as a String.
      Overrides:
      toString in class Object
      Returns:
      String version of the provided value, with trailing zeroes and decimal points omitted.
      See Also:

    • setValue

      public void setValue(float[] newValue)
      Assign a new value to this field. Warning: newValue array length must correspond to tuple size for base type SFVec4f tuple size of 4.
      Specified by:
      setValue in interface SFVec4f
      Parameters:
      newValue - The replacement value to assign.
      See Also:

    • setValueArray

      public SFVec4f setValueArray(float[] newValue)
      Assign a new array value to this field, pipelined. This is an alternate utility method since primary method returns void and cannot be overridden. Warning: newValue array length must correspond to tuple size for base type SFVec4f tuple size of 4.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      SFVec4f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setValue

      public SFVec4f setValue(double[] newValue)
      Constructor for SFVec4f using a corresponding Java primitive double[] array as new initial value.
      Parameters:
      newValue - is new value to assign Warning: newValue array length must correspond to tuple size for base type SFVec4f tuple size of 4.
      Returns:
      SFVec4f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

      public SFVec4f setValue(float x, float y, float z, float t)
      Assign a new value to this field.
      Parameters:
      x - first component
      y - second component
      z - third component
      t - fourth component
      Returns:
      SFVec4f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

      public SFVec4f setValue(double x, double y, double z, double t)
      Assign a new value to this field.
      Parameters:
      x - first component
      y - second component
      z - third component
      t - fourth component
      Returns:
      SFVec4f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • toFloatArray

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

    • setValue

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

    • multiply

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

    • add

      public SFVec4f add(SFVec4f secondValue)
      Add second set of values to corresponding values in this field type.
      Parameters:
      secondValue - value for vector addition
      Returns:
      SFVec4f - 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: