Class SFMatrix3f

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

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


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

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

    Fields
    Modifier and Type Field Description
    static float[] DEFAULT_VALUE
    Default value for this field type contains values of 1 0 0 0 1 0 0 0 1.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "1 0 0 0 1 0 0 0 1".
    static java.lang.String NAME
    String constant NAME provides name of this element: SFMatrix3f
    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 9 (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
    SFMatrix3f()
    Constructor for SFMatrix3f performs value initialization.
    SFMatrix3f​(float[] newValue)
    Constructor for SFMatrix3f using a corresponding Java primitive float[] array as new initial value.
    SFMatrix3f​(SFMatrix3f newValue)
    Constructor to copy an SFMatrix3f value as initial value for this new field object.
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(SFMatrix3f comparisonSFMatrix3f)
    Determine whether two objects contain equal values.
    float get​(int row, int column)  
    float[] getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    void getTransform​(SFVec3f translation, SFRotation rotation, SFVec3f scale)  
    void initialize()
    Initialization for SFMatrix3f applies default initial value.
    Matrix3 inverse()  
    static boolean isArray()
    Whether or not this field type is an array (false)
    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.
    SFMatrix3f multiply​(float scaleFactor)
    Multiply scaleFactor times all values in this field type.
    Matrix3 multiplyColVector​(SFVec3f vector3f)  
    Matrix3 multiplyLeft​(Matrix3 matrix3x3)  
    Matrix3 multiplyRight​(Matrix3 matrix3x3)  
    Matrix3 multiplyRowVector​(SFVec3f vector3f)  
    void set​(int row, int column)  
    void setIdentity()  
    void setTransform​(SFVec3f translation, SFRotation rotation, SFVec3f scale, SFRotation scaleOrientation, SFVec3f center)  
    SFMatrix3f setValue​(float[] newValue)
    Apply an array of primitive values to this field.
    SFMatrix3f setValue​(SFMatrix3f newValue)
    Apply an SFMatrix3f value to this field.
    SFMatrix3f setValueByString​(java.lang.String newValue)
    Utility accessor for SFMatrix3f 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.
    Matrix3 transpose()  
    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
  • Field Details

    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: SFMatrix3f
      See Also:
      Constant Field Values
    • DEFAULT_VALUE

      public static final float[] DEFAULT_VALUE
      Default value for this field type contains values of 1 0 0 0 1 0 0 0 1.
      See Also:
      Java Tutorials: Primitive Data Types
    • DEFAULT_VALUE_STRING

      public static final java.lang.String DEFAULT_VALUE_STRING
      Default string value for this field type is "1 0 0 0 1 0 0 0 1".
      See Also:
      Constant Field Values
    • TUPLE_SIZE

      public static final int TUPLE_SIZE
      Default tuple size for this field type is 9 (i.e. number of component values making up a single-field SF object).
      See Also:
      Constant Field Values
    • REGEX

      public static final java.lang.String REGEX
      Default regular expression (regex) pattern for this field type is \s*(([+-]?((0|[1-9][0-9]*)(\.[0-9]*)?|\.[0-9]+)([Ee][+-]?[0-9]+)?)\s+){8}([+-]?((0|[1-9][0-9]*)(\.[0-9]*)?|\.[0-9]+)([Ee][+-]?[0-9]+)?)\s*
      See Also:
      PATTERN, matches(), matches(String), validate(), X3D Regular Expressions: SFMatrix3f, Constant Field Values
    • PATTERN

      public static final java.util.regex.Pattern PATTERN
      Precompiled regular expression (regex) pattern for this field type using default REGEX value.
      See Also:
      REGEX, matches(), matches(String), validate(), java.util.regex.Pattern
  • Constructor Details

    • SFMatrix3f

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

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

      public SFMatrix3f​(float[] newValue)
      Constructor for SFMatrix3f 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 SFMatrix3f 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 SFMatrix3f 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​(SFMatrix3f comparisonSFMatrix3f)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFMatrix3f - 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()
    • validateRegex

      public final java.lang.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​(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 SFMatrix3f setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for SFMatrix3f 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 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, SFFloat.stripTrailingZeroes(float)
    • getPrimitiveValue

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

      public java.lang.String toString()
      Provides current value as a String.
      Overrides:
      toString in class java.lang.Object
      Returns:
      String version of the provided value, with trailing zeroes and decimal points omitted.
      See Also:
      X3D Tooltips: type SFMatrix3f, SFFloat.stripTrailingZeroes(float)
    • setValue

      public SFMatrix3f setValue​(float[] newValue)
      Apply an array of primitive values to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      SFMatrix3f - 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​(SFVec3f translation, SFRotation rotation, SFVec3f scale, SFRotation scaleOrientation, SFVec3f center)
      Specified by:
      setTransform in interface SFMatrix3f
    • getTransform

      public void getTransform​(SFVec3f translation, SFRotation rotation, SFVec3f scale)
      Specified by:
      getTransform in interface SFMatrix3f
    • 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​(SFVec3f vector3f)
      Specified by:
      multiplyRowVector in interface SFMatrix3f
    • multiplyColVector

      public Matrix3 multiplyColVector​(SFVec3f vector3f)
      Specified by:
      multiplyColVector in interface SFMatrix3f
    • toFloatArray

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

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

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