Class SFMatrix3d

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFMatrix3d
All Implemented Interfaces:
Matrix3, SFMatrix3d, X3DField

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


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFMatrix3d specifies a 3x3 matrix of double-precision floating point numbers, organized in row-major fashion. Warning: comma characters within singleton values do not pass strict XML validation.

Related field object: MFMatrix3d
See Also:
X3D Tooltips: type SFMatrix3d, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFMatrix3dAndMFMatrix3d, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • SFMatrix3d

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

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

      public SFMatrix3d(double[] newValue)
      Constructor for SFMatrix3d 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 SFMatrix3d tuple size of 9. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
  • 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 SFMatrix3d 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(SFMatrix3d comparisonSFMatrix3d)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFMatrix3d - 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 SFMatrix3d setValueByString(String newValue) throws InvalidFieldValueException
      Utility accessor for SFMatrix3d 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)
    • toString

      public static 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, SFDouble.stripTrailingZeroes(double)
    • getPrimitiveValue

      public double[] 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 SFMatrix3d, SFDouble.stripTrailingZeroes(double)
    • setValue

      public SFMatrix3d setValue(double[] newValue)
      Apply an array of primitive values to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      SFMatrix3d - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setIdentity

      public void setIdentity()
      Specified by:
      setIdentity in interface Matrix3
    • set

      public void set(int row, int column)
      Specified by:
      set in interface Matrix3
    • get

      public float get(int row, int column)
      Specified by:
      get in interface Matrix3
    • setTransform

      public void setTransform(SFVec3d translation, SFRotation rotation, SFVec3d scale, SFRotation scaleOrientation, SFVec3d center)
      Specified by:
      setTransform in interface SFMatrix3d
    • getTransform

      public void getTransform(SFVec3d translation, SFRotation rotation, SFVec3d scale)
      Specified by:
      getTransform in interface SFMatrix3d
    • inverse

      public Matrix3 inverse()
      Specified by:
      inverse in interface Matrix3
    • transpose

      public Matrix3 transpose()
      Specified by:
      transpose in interface Matrix3
    • multiplyLeft

      public Matrix3 multiplyLeft(Matrix3 matrix3x3)
      Specified by:
      multiplyLeft in interface Matrix3
    • multiplyRight

      public Matrix3 multiplyRight(Matrix3 matrix3x3)
      Specified by:
      multiplyRight in interface Matrix3
    • multiplyRowVector

      public Matrix3 multiplyRowVector(SFVec3d vector3d)
      Specified by:
      multiplyRowVector in interface SFMatrix3d
    • multiplyColVector

      public Matrix3 multiplyColVector(SFVec3d vector3d)
      Specified by:
      multiplyColVector in interface SFMatrix3d
    • toDoubleArray

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

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

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