Package org.web3d.x3d.jsail.fields

Class SFVec2f

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

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFVec2f is a 2-tuple pair of SFFloat values. Hint: SFVec2f can be used to specify a 2D single-precision coordinate. Warning: comma characters within singleton values do not pass strict XML validation.

Related field object: MFVec2f
See Also:

  • Field Details

  • Constructor Details

    • SFVec2f

      public SFVec2f()
      Constructor for SFVec2f performs value initialization.

    • SFVec2f

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

    • SFVec2f

      public SFVec2f(float[] newValue)
      Constructor for SFVec2f 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 SFVec2f tuple size of 2. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)

    • SFVec2f

      public SFVec2f(float x, float y)
      Utility constructor for SFVec2f using individual primitive values.
      Parameters:
      x - first component of axis
      y - second component of axis
      See Also:

    • SFVec2f

      public SFVec2f(double x, double y)
      Utility constructor for SFVec2f using double values.
      Parameters:
      x - first component
      y - second component
      See Also:

    • SFVec2f

      public SFVec2f(double[] newValue)
      Utility constructor for SFVec2f 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 SFVec2f 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(SFVec2f comparisonSFVec2f)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFVec2f - field type 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 SFVec2f setValueByString(String newValue) throws InvalidFieldValueException
      Utility accessor for SFVec2f 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 SFVec2f normalize()
      Utility method to normalize this vector value to unit length, ignore if zero length.
      Returns:
      SFVec2f - 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 SFVec2f by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface SFVec2f
      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 SFVec2f tuple size of 2.
      Specified by:
      setValue in interface SFVec2f
      Parameters:
      newValue - The replacement value to assign.
      See Also:

    • setValueArray

      public SFVec2f 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 SFVec2f tuple size of 2.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      SFVec2f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setValue

      public SFVec2f setValue(double[] newValue)
      Constructor for SFVec2f 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 SFVec2f tuple size of 2.
      Returns:
      SFVec2f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setValue

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

    • setValue

      public SFVec2f setValue(double x, double y)
      Assign a new value to this field.
      Parameters:
      x - first component
      y - second component
      Returns:
      SFVec2f - 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 SFVec2f setValue(SFVec2f newValue)
      Apply an SFVec2f value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      SFVec2f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • multiply

      public SFVec2f multiply(float scaleFactor)
      Multiply scaleFactor times all values in this field type.
      Parameters:
      scaleFactor - scalar value for vector multiplication
      Returns:
      SFVec2f - 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: