Class SFVec4dObject

    • Field Summary

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

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

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

      • SFVec4dObject

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

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

        public SFVec4dObject​(double[] newValue)
        Constructor for SFVec4dObject 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 SFVec4d tuple size of 4. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
      • SFVec4dObject

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

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

      • equals

        public boolean equals​(SFVec4dObject comparisonSFVec4dObject)
        Determine whether two objects contain equal values.
        Parameters:
        comparisonSFVec4dObject - 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 SFVec4dObject setValueByString​(java.lang.String newValue)
                                       throws InvalidFieldValueException
        Utility accessor for SFVec4dObject 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 SFVec4dObject normalize()
        Utility method to normalize this vector value to unit length, ignore if zero length.
        Returns:
        SFVec4dObject - 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​(double[] 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, SFDoubleObject.stripTrailingZeroes(double)
      • getValue

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

        public double[] getPrimitiveValue()
        Provides current value of the field as a Java primitive type.
        Returns:
        current value
      • setValue

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

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

        public SFVec4dObject 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 - third component
        Returns:
        SFVec4dObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • toDoubleArray

        public double[] toDoubleArray()
        Provide double array for this field type.
        Returns:
        Array of doubles in this field array.
      • setValue

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

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