Package org.web3d.x3d.jsail.fields
Class MFMatrix4f
java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.MFMatrix4f
- All Implemented Interfaces:
Matrix4
,MFMatrix4f
,X3DField
This utility class provides a concrete implementation corresponding to MFMatrix4f X3D field type.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFMatrix4f specifies zero or more 4x4 matrices of single-precision floating point numbers, organized in row-major fashion. Warning: comma characters can only appear between singleton 16-tuple values.
Related field object:
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). MFMatrix4f specifies zero or more 4x4 matrices of single-precision floating point numbers, organized in row-major fashion. Warning: comma characters can only appear between singleton 16-tuple values.
Related field object:
SFMatrix4f
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final float[]
Default value for this field type is an empty array.static final String
Default string value for this field type is "".static final String
String constant NAME provides name of this element: MFMatrix4fstatic final Pattern
Precompiled regular expression (regex) pattern for this field type using default REGEX value.static final String
Default regular expression (regex) pattern for this field type is \s*((([+-]?static final int
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
ConstructorDescriptionConstructor for MFMatrix4f performs value initialization.MFMatrix4f
(float[] newValue) Constructor for MFMatrix4f using a corresponding Java primitive float[] array as new initial value.MFMatrix4f
(MFMatrix4f newValue) Constructor to copy an MFMatrix4f value as initial value for this new field object.MFMatrix4f
(SFMatrix4f newValue) Utility constructor for MFMatrix4f to assign a single SFMatrix4f as new initial value. -
Method Summary
Modifier and TypeMethodDescriptionboolean
equals
(MFMatrix4f comparisonMFMatrix4f) Determine whether two objects contain equal values.float
get
(int row, int column) float[]
Provides current value of the field as a Java primitive type.void
getTransform
(SFVec3f translation, SFRotation rotation, SFVec3f scale) final void
Initialization for MFMatrix4f applies default initial value.inverse()
static final boolean
isArray()
Whether or not this field type is an array (true)boolean
Determine whether current value matches DEFAULT_VALUEfinal boolean
matches()
Test PATTERN match via regular expression (regex) check of current object's toString() value.static final boolean
Test PATTERN match with regular expression (regex) of provided value.multiply
(float scaleFactor) Multiply scaleFactor times all values in this field type.multiplyColVector
(SFVec3f vector3f) multiplyLeft
(Matrix4 matrix3x3) multiplyRight
(Matrix4 matrix3x3) multiplyRowVector
(SFVec3f vector3f) void
set
(int row, int column) void
void
setTransform
(SFVec3f translation, SFRotation rotation, SFVec3f scale, SFRotation scaleOrientation, SFVec3f center) setValue
(float[] newValue) Apply an array of primitive values to this field.setValue
(MFMatrix4f newValue) Apply an MFMatrix4f value to this field.setValue
(SFMatrix4f newValue) Utility method for MFMatrix4f to assign a single SFMatrix4f as new initial value.setValueByString
(String newValue) Utility accessor for MFMatrix4f using String value (which must pass parsing validation checks).float[]
Provide float array for this field type.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.final String
validate()
Validate current value via get/set comparison testsfinal String
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
-
Field Details
-
NAME
String constant NAME provides name of this element: MFMatrix4f- See Also:
-
DEFAULT_VALUE
public static final float[] DEFAULT_VALUEDefault value for this field type is an empty array.- See Also:
-
DEFAULT_VALUE_STRING
Default string value for this field type is "".- See Also:
-
TUPLE_SIZE
public static final int TUPLE_SIZEDefault tuple size for this field type is 16 (i.e. number of component values making up a single-field SF object).- See Also:
-
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*,?\s*)*- See Also:
-
PATTERN
Precompiled regular expression (regex) pattern for this field type using default REGEX value.- See Also:
-
-
Constructor Details
-
MFMatrix4f
public MFMatrix4f()Constructor for MFMatrix4f performs value initialization. -
MFMatrix4f
Constructor to copy an MFMatrix4f value as initial value for this new field object.- Parameters:
newValue
- The newValue to apply
-
MFMatrix4f
public MFMatrix4f(float[] newValue) Constructor for MFMatrix4f 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 MFMatrix4f tuple size of 16. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
-
MFMatrix4f
Utility constructor for MFMatrix4f to assign a single SFMatrix4f as new initial value.- Parameters:
newValue
- is new value to assign
-
-
Method Details
-
isArray
public static final boolean isArray()Whether or not this field type is an array (true)- Returns:
- true if array type
-
initialize
public final void initialize()Initialization for MFMatrix4f applies default initial value. Static initializer also provided to verify that the regex pattern compiles and matches that default value.- Specified by:
initialize
in classX3DConcreteField
- See Also:
-
equals
Determine whether two objects contain equal values.- Parameters:
comparisonMFMatrix4f
- field type to compare- Returns:
- true if equivalent, false otherwise
-
validate
Validate current value via get/set comparison tests- Returns:
- empty string if get/set testing passes, warning otherwise
- See Also:
-
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:
-
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:
-
matches
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:
-
setValueByString
Utility accessor for MFMatrix4f 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:
-
setValue
Utility method for MFMatrix4f to assign a single SFMatrix4f as new initial value.- Parameters:
newValue
- is new value to assign- Returns:
SFColor
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
toString
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:
-
getPrimitiveValue
public float[] getPrimitiveValue()Provides current value of the field as a Java primitive type.- Returns:
- current value
-
toString
-
setValue
Apply an array of primitive values to this field.- Parameters:
newValue
- The newValue to apply- Returns:
MFMatrix4f
- 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 interfaceMatrix4
-
set
-
get
-
setTransform
public void setTransform(SFVec3f translation, SFRotation rotation, SFVec3f scale, SFRotation scaleOrientation, SFVec3f center) - Specified by:
setTransform
in interfaceMFMatrix4f
-
getTransform
- Specified by:
getTransform
in interfaceMFMatrix4f
-
inverse
-
transpose
-
multiplyLeft
- Specified by:
multiplyLeft
in interfaceMatrix4
-
multiplyRight
- Specified by:
multiplyRight
in interfaceMatrix4
-
multiplyRowVector
- Specified by:
multiplyRowVector
in interfaceMFMatrix4f
-
multiplyColVector
- Specified by:
multiplyColVector
in interfaceMFMatrix4f
-
toFloatArray
public float[] toFloatArray()Provide float array for this field type.- Returns:
- Array of floats in this field array.
-
setValue
Apply an MFMatrix4f value to this field.- Parameters:
newValue
- The newValue to apply- Returns:
MFMatrix4f
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
multiply
Multiply scaleFactor times all values in this field type.- Parameters:
scaleFactor
- scalar value for vector multiplication- Returns:
MFMatrix4f
- 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:
-