Class 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

    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

  • Constructor Summary

    Constructor Description
    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