Class SFMatrix3d
java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFMatrix3d
- All Implemented Interfaces:
Matrix3
,SFMatrix3d
,X3DField
This utility class provides a concrete implementation corresponding to SFMatrix3d 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). SFMatrix3d specifies a 3x3 matrix of double-precision floating point numbers, organized in row-major fashion. Warning: comma characters within singleton values do not pass strict XML validation.
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). SFMatrix3d specifies a 3x3 matrix of double-precision floating point numbers, organized in row-major fashion. Warning: comma characters within singleton values do not pass strict XML validation.
Related field object:
MFMatrix3d
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final double[]
Default value for this field type contains values of 1 0 0 0 1 0 0 0 1.static final String
Default string value for this field type is "1 0 0 0 1 0 0 0 1".static final String
String constant NAME provides name of this element: SFMatrix3dstatic 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 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
ConstructorDescriptionConstructor for SFMatrix3d performs value initialization.SFMatrix3d
(double[] newValue) Constructor for SFMatrix3d using a corresponding Java primitive double[] array as new initial value.SFMatrix3d
(SFMatrix3d newValue) Constructor to copy an SFMatrix3d value as initial value for this new field object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
equals
(SFMatrix3d comparisonSFMatrix3d) Determine whether two objects contain equal values.float
get
(int row, int column) double[]
Provides current value of the field as a Java primitive type.void
getTransform
(SFVec3d translation, SFRotation rotation, SFVec3d scale) final void
Initialization for SFMatrix3d applies default initial value.inverse()
static final boolean
isArray()
Whether or not this field type is an array (false)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
(double scaleFactor) Multiply scaleFactor times all values in this field type.multiplyColVector
(SFVec3d vector3d) multiplyLeft
(Matrix3 matrix3x3) multiplyRight
(Matrix3 matrix3x3) multiplyRowVector
(SFVec3d vector3d) void
set
(int row, int column) void
void
setTransform
(SFVec3d translation, SFRotation rotation, SFVec3d scale, SFRotation scaleOrientation, SFVec3d center) setValue
(double[] newValue) Apply an array of primitive values to this field.setValue
(SFMatrix3d newValue) Apply an SFMatrix3d value to this field.setValueByString
(String newValue) Utility accessor for SFMatrix3d using String value (which must pass parsing validation checks).double[]
Provide double array for this field type.toString()
Provides current value as a String.static String
toString
(double[] 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: SFMatrix3d- See Also:
-
DEFAULT_VALUE
public static final double[] DEFAULT_VALUEDefault value for this field type contains values of 1 0 0 0 1 0 0 0 1.- See Also:
-
DEFAULT_VALUE_STRING
Default string value for this field type is "1 0 0 0 1 0 0 0 1".- See Also:
-
TUPLE_SIZE
public static final int TUPLE_SIZEDefault tuple size for this field type is 9 (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+){8}([+-]?((0|[1-9][0-9]*)(\.[0-9]*)?|\.[0-9]+)([Ee][+-]?[0-9]+)?)\s*- See Also:
-
PATTERN
Precompiled regular expression (regex) pattern for this field type using default REGEX value.- See Also:
-
-
Constructor Details
-
SFMatrix3d
public SFMatrix3d()Constructor for SFMatrix3d performs value initialization. -
SFMatrix3d
Constructor to copy an SFMatrix3d value as initial value for this new field object.- Parameters:
newValue
- The newValue to apply
-
SFMatrix3d
public SFMatrix3d(double[] newValue) Constructor for SFMatrix3d using a corresponding Java primitive double[] array as new initial value.- Parameters:
newValue
- is new value to assign Warning: newValue array length must correspond to tuple size for base type SFMatrix3d 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 SFMatrix3d 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:
comparisonSFMatrix3d
- 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 SFMatrix3d 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:
-
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 double[] 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:
SFMatrix3d
- 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 interfaceMatrix3
-
set
-
get
-
setTransform
public void setTransform(SFVec3d translation, SFRotation rotation, SFVec3d scale, SFRotation scaleOrientation, SFVec3d center) - Specified by:
setTransform
in interfaceSFMatrix3d
-
getTransform
- Specified by:
getTransform
in interfaceSFMatrix3d
-
inverse
-
transpose
-
multiplyLeft
- Specified by:
multiplyLeft
in interfaceMatrix3
-
multiplyRight
- Specified by:
multiplyRight
in interfaceMatrix3
-
multiplyRowVector
- Specified by:
multiplyRowVector
in interfaceSFMatrix3d
-
multiplyColVector
- Specified by:
multiplyColVector
in interfaceSFMatrix3d
-
toDoubleArray
public double[] toDoubleArray()Provide double array for this field type.- Returns:
- Array of doubles in this field array.
-
setValue
Apply an SFMatrix3d value to this field.- Parameters:
newValue
- The newValue to apply- Returns:
SFMatrix3d
- 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:
SFMatrix3d
- 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:
-