Class SFVec2fObject

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static float[] DEFAULT_VALUE
      Default value for this field type contains values of 0 0.
      static java.lang.String DEFAULT_VALUE_STRING
      Default string value for this field type is "0.0 0.0".
      static java.lang.String NAME
      String constant NAME provides name of this element: SFVec2f
      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 2 (i.e. number of component values making up a single-field SF object).
    • Constructor Summary

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

      Modifier and Type Method Description
      boolean equals​(SFVec2fObject comparisonSFVec2fObject)
      Determine whether two objects contain equal values.
      float[] getPrimitiveValue()
      Provides current value of the field as a Java primitive type.
      void getValue​(float[] valueDestination)
      Get the current value of this SFVec2fObject by copying it into the valueDestination array, leaving the current object unchanged.
      void initialize()
      Initialization for SFVec2fObject 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.
      SFVec2fObject multiply​(float scaleFactor)
      Multiply scaleFactor times all values in this field type.
      SFVec2fObject normalize()
      Utility method to normalize this vector value to unit length, ignore if zero length.
      SFVec2fObject setValue​(double[] newValue)
      Constructor for SFVec2fObject using a corresponding Java primitive double[] array as new initial value.
      SFVec2fObject setValue​(double x, double y)
      Assign a new value to this field.
      void setValue​(float[] newValue)
      Assign a new value to this field.
      SFVec2fObject setValue​(float x, float y)
      Assign a new value to this field.
      SFVec2fObject setValue​(SFVec2fObject newValue)
      Apply an SFVec2fObject value to this field.
      SFVec2fObject setValueArray​(float[] newValue)
      Assign a new array value to this field, pipelined.
      SFVec2fObject setValueByString​(java.lang.String newValue)
      Utility accessor for SFVec2fObject using String value (which must pass parsing validation checks).
      float[] toFloatArray()
      Provide float array for this field type.
      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 get/set comparison tests
      java.lang.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 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • SFVec2fObject

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

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

        public SFVec2fObject​(float[] newValue)
        Constructor for SFVec2fObject 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)
      • SFVec2fObject

        public SFVec2fObject​(float x,
                             float y)
        Utility constructor for SFVec2fObject using individual primitive values.
        Parameters:
        x - first component of axis
        y - second component of axis
        See Also:
        X3D Tooltips: type
      • SFVec2fObject

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

        public SFVec2fObject​(double[] newValue)
        Utility constructor for SFVec2fObject using an alternatively typed Java double[] array as new initial value.
        Parameters:
        newValue - is new value to assign
    • Method Detail

      • equals

        public boolean equals​(SFVec2fObject comparisonSFVec2fObject)
        Determine whether two objects contain equal values.
        Parameters:
        comparisonSFVec2fObject - field type to compare
        Returns:
        true if equivalent, false otherwise
      • validate

        public final java.lang.String validate()
        Validate current value via get/set comparison tests
        Returns:
        empty string if get/set testing passes, warning otherwise
        See Also:
        validate(), validateRegex()
      • 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 SFVec2fObject setValueByString​(java.lang.String newValue)
                                       throws InvalidFieldValueException
        Utility accessor for SFVec2fObject 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:
        X3DLoaderDOM.toX3dObjectTree(org.w3c.dom.Node)
      • normalize

        public SFVec2fObject normalize()
        Utility method to normalize this vector value to unit length, ignore if zero length.
        Returns:
        SFVec2fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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, with trailing zeroes and decimal points omitted.
        See Also:
        X3D Tooltips: type, SFFloatObject.stripTrailingZeroes(float)
      • getValue

        public void getValue​(float[] valueDestination)
        Get the current value of this SFVec2fObject 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
      • 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:
        X3DConcreteField.getTupleSize(String)
      • setValueArray

        public SFVec2fObject 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:
        SFVec2fObject - 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 SFVec2fObject setValue​(double[] newValue)
        Constructor for SFVec2fObject 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:
        SFVec2fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setValue

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

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

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