Class MFVec3fObject

    • Field Summary

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

      Constructors 
      Constructor Description
      MFVec3fObject()
      Constructor for MFVec3fObject performs value initialization.
      MFVec3fObject​(double[] newValue)
      Utility constructor for MFVec3fObject using an alternatively typed Java double[] array as new initial value.
      MFVec3fObject​(float[] newValue)
      Constructor for MFVec3fObject using a corresponding Java primitive float[] array as new initial value.
      MFVec3fObject​(MFVec3fObject newValue)
      Constructor to copy an MFVec3fObject value as initial value for this new field object.
      MFVec3fObject​(SFVec3fObject newValue)
      Utility constructor for MFVec3fObject to assign a single SFVec3fObject as new initial value.
    • Method Summary

      Modifier and Type Method Description
      void append​(float[] newValue)
      Places new value(s) at the end of the existing value array, increasing the field length accordingly.
      MFVec3fObject append​(MFVec3fObject newValue)
      Appends a new MFVec3fObject to the end of the existing value array, increasing the field length accordingly.
      MFVec3fObject append​(SFVec3fObject newValue)
      Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
      void clear()
      Removes all values in the field array, changing the array size to zero.
      boolean equals​(MFVec3fObject comparisonMFVec3fObject)
      Determine whether two objects contain equal values.
      void get1Value​(int index, float[] destinationValue)
      Get an individual value from the existing field array.
      float[] getPrimitiveValue()
      Provides current value of the field as a Java primitive type.
      void getValue​(float[] valueDestination)
      Get the current value of this MFVec3fObject by copying it into the valueDestination array, leaving the current object unchanged.
      void getValue​(float[][] valueDestination)
      Get the current value of this MFVec3fObject by copying it into the valueDestination array, leaving the current object unchanged.
      void initialize()
      Initialization for MFVec3fObject applies default initial value.
      void insertValue​(int index, float[] newValue)
      Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
      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.
      MFVec3fObject multiply​(float scaleFactor)
      Multiply scaleFactor times all values in this field type.
      MFVec3fObject normalize()
      Utility method to normalize vector values to unit length, ignore vector values with zero length.
      void remove​(int index)
      Remove one SFVec3f element of the field array at index position, if found.
      void set1Value​(int index, float[] newValue)
      Replace a single value at the appropriate location in the existing value array.
      MFVec3fObject setValue​(double[] newValue)
      Assign a double-precision array value to this single-precision field.
      void setValue​(float[] newValue)
      Assign a new float[] value to this field.
      void setValue​(int size, float[] newValue)
      Assign an array subset to this field.
      void setValue​(int size, float[][] newValue)
      Assign an array subset to this field.
      MFVec3fObject setValue​(MFVec3fObject newValue)
      Apply an MFVec3fObject value to this field.
      MFVec3fObject setValue​(SFVec3fObject newValue)
      Assign a single-field SFVec3fObject as new array value.
      MFVec3fObject setValueByString​(java.lang.String newValue)
      Utility accessor for MFVec3fObject using String value (which must pass parsing validation checks).
      int size()
      Get the size of the underlying data array, meaning the number of simple SFVec3f elements for the given data type.
      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

      • MFVec3fObject

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

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

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

        public MFVec3fObject​(SFVec3fObject newValue)
        Utility constructor for MFVec3fObject to assign a single SFVec3fObject as new initial value.
        Parameters:
        newValue - is new value to assign
      • MFVec3fObject

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

      • equals

        public boolean equals​(MFVec3fObject comparisonMFVec3fObject)
        Determine whether two objects contain equal values.
        Parameters:
        comparisonMFVec3fObject - 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 MFVec3fObject setValueByString​(java.lang.String newValue)
                                       throws InvalidFieldValueException
        Utility accessor for MFVec3fObject 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 MFVec3fObject normalize()
        Utility method to normalize vector values to unit length, ignore vector values with zero length.
        Returns:
        MFVec3fObject - 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 MFVec3fObject by copying it into the valueDestination array, leaving the current object unchanged.
        Specified by:
        getValue in interface MFVec3f
        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
      • get1Value

        public void get1Value​(int index,
                              float[] destinationValue)

        Get an individual value from the existing field array.

        If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.

        Specified by:
        get1Value in interface MFVec3f
        Parameters:
        index - is position of selected value in current array
        destinationValue - where to place result for selected value
        Throws:
        java.lang.ArrayIndexOutOfBoundsException - The index was outside of the bounds of the current array.
      • setValue

        public void setValue​(int size,
                             float[] newValue)
        Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Specified by:
        setValue in interface MFVec3f
        Parameters:
        size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
        newValue - The replacement value array to (potentially) slice and then assign.
        See Also:
        X3DConcreteField.getTupleSize(String)
      • getValue

        public void getValue​(float[][] valueDestination)
        Get the current value of this MFVec3fObject by copying it into the valueDestination array, leaving the current object unchanged.
        Specified by:
        getValue in interface MFVec3f
        Parameters:
        valueDestination - The array to be filled in with current field values.
      • setValue

        public void setValue​(int size,
                             float[][] newValue)
        Assign an array subset to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Specified by:
        setValue in interface MFVec3f
        Parameters:
        size - indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.
        newValue - The replacement value array to (potentially) slice and then assign.
        See Also:
        X3DConcreteField.getTupleSize(String)
      • setValue

        public void setValue​(float[] newValue)
        Assign a new float[] value to this field. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Parameters:
        newValue - is replacement value array to assign
        See Also:
        X3DConcreteField.getTupleSize(String)
      • setValue

        public MFVec3fObject setValue​(double[] newValue)
        Assign a double-precision array value to this single-precision field.

        Warning: this method casts type of input values from higher precision to lower precision.

        Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Parameters:
        newValue - is replacement value array to assign
        Returns:
        MFVec3fObject - 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 MFVec3fObject setValue​(SFVec3fObject newValue)
        Assign a single-field SFVec3fObject as new array value.
        Parameters:
        newValue - The replacement value to assign.
        Returns:
        MFVec3fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
      • set1Value

        public void set1Value​(int index,
                              float[] newValue)
                       throws java.lang.ArrayIndexOutOfBoundsException
        Replace a single value at the appropriate location in the existing value array. Size of the current underlying value array does not change. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Specified by:
        set1Value in interface MFVec3f
        Parameters:
        index - is position of selected value in current array
        newValue - provides new value to apply
        Throws:
        java.lang.ArrayIndexOutOfBoundsException
        See Also:
        X3DConcreteField.getTupleSize(String)
      • append

        public void append​(float[] newValue)
        Places new value(s) at the end of the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Specified by:
        append in interface MFVec3f
        Parameters:
        newValue - The newValue to append
        See Also:
        X3DConcreteField.getTupleSize(String)
      • append

        public MFVec3fObject append​(SFVec3fObject newValue)
        Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for incrementally constructing arrays.
        Parameters:
        newValue - The newValue to append
        Returns:
        MFVec3fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • append

        public MFVec3fObject append​(MFVec3fObject newValue)
        Appends a new MFVec3fObject to the end of the existing value array, increasing the field length accordingly. Note: this method can be useful for constructing long arrays.
        Parameters:
        newValue - The newValue to append
        Returns:
        MFVec3fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        X3DConcreteField.getTupleSize(String)
      • insertValue

        public void insertValue​(int index,
                                float[] newValue)
        Insert a new value prior to the index location in the existing value array, increasing the field length accordingly. Warning: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
        Specified by:
        insertValue in interface MFVec3f
        Parameters:
        index - The position for the inserted value in the current array
        newValue - The newValue to insert
        See Also:
        X3DConcreteField.getTupleSize(String)
      • size

        public int size()
        Get the size of the underlying data array, meaning the number of simple SFVec3f elements for the given data type.
        Specified by:
        size in interface MField
        Returns:
        The number of SFVec3f elements in this field array.
      • clear

        public void clear()
        Removes all values in the field array, changing the array size to zero.
        Specified by:
        clear in interface MField
      • remove

        public void remove​(int index)
        Remove one SFVec3f element of the field array at index position, if found. Initial element is at index 0.
        Specified by:
        remove in interface MField
        Parameters:
        index - position of element in field array that gets removed
      • toFloatArray

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

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

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