Class SFVec3f

All Implemented Interfaces:
SFVec3f, X3DField

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


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFVec3f is a 3-tuple triplet of SFFloat values. Hint: SFVec3f can be used to specify a 3D coordinate or a 3D scale value. Warning: comma characters within singleton values do not pass strict XML validation.

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

    Fields
    Modifier and Type
    Field
    Description
    static float[]
    Default value for this field type contains values of 0 0 0.
    static float[]
    Special SimpleType bboxSizeType contains default value of -1 -1 -1.
    static String
    Default string value for this special SimpleType is "-1 -1 -1".
    static String
    Default string value for this field type is "0.0 0.0 0.0".
    static String
    String constant NAME provides name of this element: SFVec3f
    static Pattern
    Precompiled regular expression (regex) pattern for this field type using default REGEX value.
    static Pattern
    Special SimpleType bboxSizeType regular expression (regex) pattern for this field type.
    static String
    Default regular expression (regex) pattern for this field type is \s*(([+-]?
    static String
    Special SimpleType bboxSizeType regular expression (regex) pattern for this field type is \\s*((([+]?
    static int
    Default tuple size for this field type is 3 (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
    Constructor for SFVec3f performs value initialization.
    SFVec3f​(double[] newValue)
    Utility constructor for SFVec3f using an alternatively typed Java double[] array as new initial value.
    SFVec3f​(double x, double y, double z)
    Utility constructor for SFVec3f using double values.
    SFVec3f​(float[] newValue)
    Constructor for SFVec3f using a corresponding Java primitive float[] array as new initial value.
    SFVec3f​(float x, float y, float z)
    Utility constructor for SFVec3f using individual primitive values.
    SFVec3f​(SFVec3f newValue)
    Constructor to copy an SFVec3f value as initial value for this new field object.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(SFVec3f comparisonSFVec3f)
    Determine whether two objects contain equal values.
    float[]
    Provides current value of the field as a Java primitive type.
    void
    getValue​(float[] valueDestination)
    Get the current value of this SFVec3f by copying it into the valueDestination array, leaving the current object unchanged.
    void
    Initialization for SFVec3f applies default initial value.
    static boolean
    Whether or not this field type is an array (false)
    boolean
    Determine whether current value matches DEFAULT_VALUE
    boolean
    Test PATTERN match via regular expression (regex) check of current object's toString() value.
    static boolean
    matches​(String value)
    Test PATTERN match with regular expression (regex) of provided value.
    boolean
    Special SimpleType regular expression (regex) bboxSizeType PATTERN_BBOXSIZETYPE match of current object's toString() value.
    static boolean
    Special SimpleType regular expression (regex) bboxSizeType PATTERN_BBOXSIZETYPE match of current object's toString() value.
    multiply​(float scaleFactor)
    Multiply scaleFactor times all values in this field type.
    Utility method to normalize this vector value to unit length, ignore if zero length.
    setValue​(double[] newValue)
    Constructor for SFVec3f using a corresponding Java primitive double[] array as new initial value.
    setValue​(double x, double y, double z)
    Assign a new value to this field.
    void
    setValue​(float[] newValue)
    Assign a new value to this field.
    setValue​(float x, float y, float z)
    Assign a new value to this field.
    setValue​(SFVec3f newValue)
    Apply an SFVec3f value to this field.
    setValueArray​(float[] newValue)
    Assign a new array value to this field, pipelined.
    setValueByString​(String newValue)
    Utility accessor for SFVec3f using String value (which must pass parsing validation checks).
    float[]
    Provide float array for this field type.
    Provides current value as a String.
    static String
    toString​(float[] value)
    Static utility method to provide String representation of a correctly typed input value.
    Validate current value via get/set comparison tests
    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
  • Field Details

  • Constructor Details

    • SFVec3f

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

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

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

      public SFVec3f(float x, float y, float z)
      Utility constructor for SFVec3f using individual primitive values.
      Parameters:
      x - first component
      y - second component
      z - third component
      See Also:
      X3D Tooltips: type
    • SFVec3f

      public SFVec3f(double x, double y, double z)
      Utility constructor for SFVec3f using double values.
      Parameters:
      x - first component
      y - second component
      z - third component
      See Also:
      X3D Tooltips: type
    • SFVec3f

      public SFVec3f(double[] newValue)
      Utility constructor for SFVec3f 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
    • matchesBboxSizeType

      public final boolean matchesBboxSizeType()
      Special SimpleType regular expression (regex) bboxSizeType PATTERN_BBOXSIZETYPE match of current object's toString() value.
      Returns:
      true if PATTERN_BBOXSIZETYPE matches, false otherwise
      See Also:
      REGEX_BBOXSIZETYPE, PATTERN_BBOXSIZETYPE, matchesBboxSizeType(String), matches(), matches(String), validate(), java.util.regex.Pattern
    • matchesBboxSizeType

      public static final boolean matchesBboxSizeType(String value)
      Special SimpleType regular expression (regex) bboxSizeType PATTERN_BBOXSIZETYPE match of current object's toString() value.
      Parameters:
      value - String value to check
      Returns:
      true if PATTERN_BBOXSIZETYPE matches, false otherwise
      See Also:
      REGEX_BBOXSIZETYPE, PATTERN_BBOXSIZETYPE, matchesBboxSizeType(), matches(), matches(String), validate(), java.util.regex.Pattern
    • initialize

      public final void initialize()
      Initialization for SFVec3f 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(SFVec3f comparisonSFVec3f)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFVec3f - 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:
      validate(), validateRegex()
    • 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:
      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(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 SFVec3f setValueByString(String newValue) throws InvalidFieldValueException
      Utility accessor for SFVec3f 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:
      X3DLoaderDOM.toX3dModelInstance(org.w3c.dom.Node)
    • normalize

      public SFVec3f normalize()
      Utility method to normalize this vector value to unit length, ignore if zero length.
      Returns:
      SFVec3f - 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:
      X3D Tooltips: type, SFFloat.stripTrailingZeroes(float)
    • getValue

      public void getValue(float[] valueDestination)
      Get the current value of this SFVec3f by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface SFVec3f
      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:
      X3D Tooltips: type SFVec3f, SFFloat.stripTrailingZeroes(float)
    • 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 SFVec3f tuple size of 3.
      Specified by:
      setValue in interface SFVec3f
      Parameters:
      newValue - The replacement value to assign.
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValueArray

      public SFVec3f 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 SFVec3f tuple size of 3.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      SFVec3f - 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 SFVec3f setValue(double[] newValue)
      Constructor for SFVec3f 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 SFVec3f tuple size of 3.
      Returns:
      SFVec3f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setValue

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

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

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