SFMatrix4fObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.fields.X3DConcreteField
- - org.web3d.x3d.jsail.fields.SFMatrix4fObject

All Implemented Interfaces:

Matrix4, SFMatrix4f, X3DField
```
public class SFMatrix4fObject
extends X3DConcreteField
implements SFMatrix4f
```
This utility class provides a concrete implementation corresponding to SFMatrix4f X3D field type.

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

Related field object: MFMatrix4fObject

See Also:

X3D Tooltips: type SFMatrix4f, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFMatrix4fAndMFMatrix4f, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 SFMatrix4fObject applies default initial value.
`Matrix4`	`inverse()`
`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.
`SFMatrix4fObject`	`multiply(float scaleFactor)` Multiply scaleFactor times all values in this field type.
`Matrix4`	`multiplyColVector(SFVec3f vector3f)`
`Matrix4`	`multiplyLeft(Matrix4 matrix3x3)`
`Matrix4`	`multiplyRight(Matrix4 matrix3x3)`
`Matrix4`	`multiplyRowVector(SFVec3f vector3f)`
`void`	`set(int row, int column)`
`void`	`setIdentity()`
`void`	`setTransform(SFVec3f translation, SFRotation rotation, SFVec3f scale, SFRotation scaleOrientation, SFVec3f center)`
`SFMatrix4fObject`	`setValue(float[] newValue)` Apply an array of primitive values to this field.
`SFMatrix4fObject`	`setValue(SFMatrix4fObject newValue)` Apply an SFMatrix4fObject value to this field.
`SFMatrix4fObject`	`setValueByString(java.lang.String newValue)` Utility accessor for SFMatrix4fObject 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.
`Matrix4`	`transpose()`
`java.lang.String`	`validate()` Validate current value via regular expression (regex) check of current object's toString() value, reporting errors only if found.

Methods inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField
addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: SFMatrix4f
    
    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 0 1 0 0 0 0 1 0 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 0 1 0 0 0 0 1 0 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 16 (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+){15}([+-]?((0|[1-9][0-9]*)(\.[0-9]*)?|\.[0-9]+)([Ee][+-]?[0-9]+)?)\s*
    
    See Also:
    
    PATTERN, matches(), matches(String), validate(), X3D Regular Expressions: SFMatrix4f, 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 Detail
  - SFMatrix4fObject
```
public SFMatrix4fObject()
```
    Constructor for SFMatrix4fObject performs value initialization.
  - SFMatrix4fObject
```
public SFMatrix4fObject(SFMatrix4fObject newValue)
```
    Constructor to copy an SFMatrix4fObject value as initial value for this new field object.
    
    Parameters:
    
    newValue - The newValue to apply
  - SFMatrix4fObject
```
public SFMatrix4fObject(float[] newValue)
```
    Constructor for SFMatrix4fObject 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 SFMatrix4f tuple size of 16. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
- Method Detail
  - initialize
```
public void initialize()
```
    Initialization for SFMatrix4fObject 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
  - validate
```
public final java.lang.String validate()
```
    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(), 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 SFMatrix4fObject setValueByString(java.lang.String newValue)
                                  throws InvalidFieldValueException
```
    Utility accessor for SFMatrix4fObject 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:
    
    X3DLoaderObject.toX3dObjectTree(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, SFFloatObject.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 SFMatrix4f, SFFloatObject.stripTrailingZeroes(float)
  - setValue
```
public SFMatrix4fObject setValue(float[] newValue)
```
    Apply an array of primitive values to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    SFMatrix4fObject - 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 Matrix4
  - set
```
public void set(int row,
                int column)
```
    Specified by:
    
    set in interface Matrix4
  - get
```
public float get(int row,
                 int column)
```
    Specified by:
    
    get in interface Matrix4
  - setTransform
```
public void setTransform(SFVec3f translation,
                         SFRotation rotation,
                         SFVec3f scale,
                         SFRotation scaleOrientation,
                         SFVec3f center)
```
    Specified by:
    
    setTransform in interface SFMatrix4f
  - getTransform
```
public void getTransform(SFVec3f translation,
                         SFRotation rotation,
                         SFVec3f scale)
```
    Specified by:
    
    getTransform in interface SFMatrix4f
  - inverse
```
public Matrix4 inverse()
```
    Specified by:
    
    inverse in interface Matrix4
  - transpose
```
public Matrix4 transpose()
```
    Specified by:
    
    transpose in interface Matrix4
  - multiplyLeft
```
public Matrix4 multiplyLeft(Matrix4 matrix3x3)
```
    Specified by:
    
    multiplyLeft in interface Matrix4
  - multiplyRight
```
public Matrix4 multiplyRight(Matrix4 matrix3x3)
```
    Specified by:
    
    multiplyRight in interface Matrix4
  - multiplyRowVector
```
public Matrix4 multiplyRowVector(SFVec3f vector3f)
```
    Specified by:
    
    multiplyRowVector in interface SFMatrix4f
  - multiplyColVector
```
public Matrix4 multiplyColVector(SFVec3f vector3f)
```
    Specified by:
    
    multiplyColVector in interface SFMatrix4f
  - toFloatArray
```
public float[] toFloatArray()
```
    Provide float array for this field type.
    
    Returns:
    
    Array of floats in this field array.
  - setValue
```
public SFMatrix4fObject setValue(SFMatrix4fObject newValue)
```
    Apply an SFMatrix4fObject value to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    SFMatrix4fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - multiply
```
public SFMatrix4fObject multiply(float scaleFactor)
```
    Multiply scaleFactor times all values in this field type.
    
    Parameters:
    
    scaleFactor - scalar value for vector multiplication
    
    Returns:
    
    SFMatrix4fObject - 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

Class SFMatrix4fObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.fields.X3DConcreteField

Methods inherited from class java.lang.Object

Field Detail

NAME

DEFAULT_VALUE

DEFAULT_VALUE_STRING

TUPLE_SIZE

REGEX

PATTERN

Constructor Detail

SFMatrix4fObject

SFMatrix4fObject

SFMatrix4fObject

Method Detail

initialize

validate

matches

matches

setValueByString

toString

getPrimitiveValue

toString

setValue

setIdentity

set

get

setTransform

getTransform

inverse

transpose

multiplyLeft

multiplyRight

multiplyRowVector

multiplyColVector

toFloatArray

setValue

multiply

isDefaultValue