Class SFMatrix4f

java.lang.Object

org.web3d.x3d.jsail.fields.X3DConcreteField

org.web3d.x3d.jsail.fields.SFMatrix4f

All Implemented Interfaces:

Matrix4, SFMatrix4f, X3DField

public class SFMatrix4f
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 within singleton values do not pass strict XML validation.

Related field object: MFMatrix4f

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	Description
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.
static final 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 DecimalFormat	formatPrecision	DecimalFormat matching local number of significant digits for floating-point and double-precision String output
static final String	NAME	String constant NAME provides name of this field type: SFMatrix4f
static final Pattern	PATTERN	Precompiled regular expression (regex) pattern for this field type using default REGEX value.
static final String	REGEX	Default regular expression (regex) pattern for this field type is \s*(([+-]?
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).

Fields inherited from class X3DConcreteField

validationResult

Modifier and Type	Field	Description
protected static StringBuilder	validationResult	Results log of local validation.

Constructor Summary

Constructors

Constructor	Description
SFMatrix4f()	Constructor for SFMatrix4f performs value initialization.
SFMatrix4f(float[] newValue)	Constructor for SFMatrix4f using a corresponding Java primitive float[] array as new initial value.
SFMatrix4f(SFMatrix4f newValue)	Constructor to copy an SFMatrix4f value as initial value for this new field object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(float[] comparisonValue)	Determine whether current SFMatrix4f object and float array contain equal values.
boolean	equals(SFMatrix4f comparisonSFMatrix4f)	Determine whether current object and another SFMatrix4f object contain equal values.
float	get(int row, int column)
float	getEpsilon()	Current error bound for numerical comparison of values for equality
float[]	getPrimitiveValue()	Provides current value of the field as a Java primitive type.
int	getSignificantDigits()	Current significant digits for floating-point and double-precision String output
void	getTransform(SFVec3f translation, SFRotation rotation, SFVec3f scale)
final void	initialize()	Initialization for SFMatrix4f applies default initial value.
Matrix4	inverse()
static final boolean	isArray()	Whether or not this field type is an array (false)
boolean	isDefaultValue()	Determine whether current value matches DEFAULT_VALUE
final boolean	matches()	Test PATTERN match via regular expression (regex) check of current object's toString() value.
static final boolean	matches(String value)	Test PATTERN match with regular expression (regex) of provided value.
SFMatrix4f	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	setEpsilon(float newEpsilon)	Set revised error bound for numerical comparison of values for equality
void	setIdentity()
void	setSignificantDigits(int newSignificantDigits)	Set revised number of significant digits for floating-point and double-precision String output
void	setTransform(SFVec3f translation, SFRotation rotation, SFVec3f scale, SFRotation scaleOrientation, SFVec3f center)
SFMatrix4f	setValue(float[] newValue)	Apply an array of primitive values to this field.
SFMatrix4f	setValue(SFMatrix4f newValue)	Apply an SFMatrix4f value to this field.
SFMatrix4f	setValueByString(String newValue)	Utility accessor for SFMatrix4f using String value (which must pass parsing validation checks).
float[]	toFloatArray()	Provide float array for this field type.
String	toString()	Provides current value as a String.
static String	toString(float[] value)	Static utility method to provide String representation of a correctly typed input value.
Matrix4	transpose()
final String	validate()	Validate current value via get/set comparison tests
final 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 X3DConcreteField

addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable

Modifier and Type	Method	Description
void	addX3DEventListener(X3DFieldEventListener newListener)	WARNING not tested
X3DConcreteFieldDefinition	getDefinition()	WARNING not implemented
static int	getTupleSize(String fieldType)	Compute tuple size for given type (for example, SFVec3f and MFVec3f have tupleSize of 3).
String	getValidationResult()	Get output of results from prior validation, if any
boolean	isReadable()	Check whether field is readable, default /true/
boolean	isWritable()	Check whether field is writable, default /true/
void	removeX3DEventListener(X3DFieldEventListener oldListener)	WARNING not tested
void	setReadable(boolean newValue)	Set whether field is readable
void	setWritable(boolean newValue)	Set whether field is writable

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this field type: 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 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 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 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

formatPrecision

public static DecimalFormat formatPrecision

DecimalFormat matching local number of significant digits for floating-point and double-precision String output

Constructor Details

SFMatrix4f

public SFMatrix4f()

Constructor for SFMatrix4f performs value initialization.

SFMatrix4f

public SFMatrix4f(SFMatrix4f newValue)

Constructor to copy an SFMatrix4f value as initial value for this new field object.

Parameters:

newValue - The newValue to apply

SFMatrix4f

public SFMatrix4f(float[] newValue)

Constructor for SFMatrix4f 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 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 SFMatrix4f 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(SFMatrix4f comparisonSFMatrix4f)

Determine whether current object and another SFMatrix4f object contain equal values.

Parameters:

comparisonSFMatrix4f - field type to compare

Returns:

true if equivalent, false otherwise

setEpsilon

public void setEpsilon(float newEpsilon)

Set revised error bound for numerical comparison of values for equality

Parameters:

newEpsilon - new value for epsilon, must be positive

getEpsilon

public float getEpsilon()

Current error bound for numerical comparison of values for equality

setSignificantDigits

public void setSignificantDigits(int newSignificantDigits)

Set revised number of significant digits for floating-point and double-precision String output

Parameters:

newSignificantDigits - new value for significantDigits, must be non-negative

getSignificantDigits

public int getSignificantDigits()

Current significant digits for floating-point and double-precision String output

equals

public boolean equals(float[] comparisonValue)

Determine whether current SFMatrix4f object and float array contain equal values.

Parameters:

comparisonValue - float[] array 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 SFMatrix4f setValueByString(String newValue)
                            throws InvalidFieldValueException

Utility accessor for SFMatrix4f 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(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 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 SFMatrix4f
• SFFloat.stripTrailingZeroes(float)

setValue

public SFMatrix4f setValue(float[] newValue)

Apply an array of primitive values to this field.

Parameters:

newValue - The newValue to apply

Returns:

SFMatrix4f - 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 SFMatrix4f setValue(SFMatrix4f newValue)

Apply an SFMatrix4f value to this field.

Parameters:

newValue - The newValue to apply

Returns:

SFMatrix4f - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

multiply

public SFMatrix4f multiply(float scaleFactor)

Multiply scaleFactor times all values in this field type.

Parameters:

scaleFactor - scalar value for vector multiplication

Returns:

SFMatrix4f - 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