Class SFRotationObject

java.lang.Object
org.web3d.x3d.jsail.fields.X3DConcreteField
org.web3d.x3d.jsail.fields.SFRotationObject
All Implemented Interfaces:
SFRotation, X3DField

public class SFRotationObject
extends X3DConcreteField
implements SFRotation
This utility class provides a concrete implementation corresponding to SFRotation X3D field type.


Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFRotation is an axis-angle 4-tuple, indicating X-Y-Z direction axis plus angle orientation about that axis. The first three values specify a normalized axis vector about which the rotation takes place, so the first three values shall be within the range [-1..+1] in order to represent a normalized unit vector. The fourth value specifies the amount of right-handed rotation about that axis in radians. Warning: comma characters in attribute values do not pass strict XML validation.

Related field object: MFRotationObject
See Also:
X3D Tooltips: type SFRotation, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFRotationAndMFRotation, X3D Tooltips, X3D Tooltips: field, X3D Tooltips: fieldValue, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static float[] DEFAULT_VALUE
    Default value for this field type is a 0 0 1 0 identity-rotation value.
    static float[] DEFAULT_VALUE_PREFERRED
    Preferred default value for this field type, oriented for rotation about vertical Y axis.
    static java.lang.String DEFAULT_VALUE_STRING
    Default string value for this field type is "0 0 1 0".
    static java.lang.String NAME
    String constant NAME provides name of this element: SFRotation
    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 4 (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 Description
    SFRotationObject()
    Constructor for SFRotationObject performs value initialization.
    SFRotationObject​(double[] newValue)
    Utility constructor for SFRotationObject using an alternatively typed Java double[] array as new initial value.
    SFRotationObject​(double x, double y, double z, double angleRadians)
    Constructor using individual double types as new initial axis-angle value.
    SFRotationObject​(float[] newValue)
    Constructor for SFRotationObject using a corresponding Java primitive float[] array as new initial value.
    SFRotationObject​(float x, float y, float z, float angleRadians)
    Constructor using individual float types as new initial axis-angle value.
    SFRotationObject​(int x, int y, int z, float angleRadians)
    Constructor using individual integer types as new initial axis, along with float angle value.
    SFRotationObject​(SFRotationObject newValue)
    Constructor to copy an SFRotationObject value as initial value for this new field object.
  • Method Summary

    Modifier and Type Method Description
    static float degreesToRadians​(double angleDegrees)
    Utility method converting degrees to radians.
    static float degreesToRadians​(float angleDegrees)
    Utility method converting degrees to radians.
    static float degreesToRadians​(int angleDegrees)
    Utility method converting degrees to radians.
    boolean equals​(SFRotationObject comparisonSFRotationObject)
    Determine whether two objects contain equal values.
    float[] getPrimitiveValue()
    Provides current value of the field as a Java primitive type.
    void getValue​(float[] valueDestination)
    Get the current value of this SFRotationObject by copying it into the valueDestination array, leaving the current object unchanged.
    void initialize()
    Initialization for SFRotationObject applies default initial value.
    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.
    SFRotationObject normalize()
    Utility method to normalize this rotation value: unit length for axis-angle vector, angle in range [0-2pi] radians, rotation with zero-length axis is reset to DEFAULT_VALUE.
    static float radiansToDegrees​(double angleRadians)
    Utility method converting radians to degrees.
    static float radiansToDegrees​(float angleRadians)
    Utility method converting radians to degrees.
    SFRotationObject setValue​(double[] newValue)
    Assign a new value to this field.
    SFRotationObject setValue​(double x, double y, double z, double angleRadians)
    Assign a new value to this field.
    void setValue​(float[] newValue)
    Assign a new value to this field.
    SFRotationObject setValue​(float x, float y, float z, float angleRadians)
    Assign a new value to this field.
    SFRotationObject setValue​(SFRotationObject newValue)
    Apply an SFRotationObject value to this field.
    SFRotationObject setValueArray​(float[] newValue)
    Assign a new array value to this field, pipelined.
    SFRotationObject setValueByString​(java.lang.String newValue)
    Utility accessor for SFRotationObject 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.
    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

    Methods inherited from interface org.web3d.x3d.sai.X3DField

    addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener
  • Field Details

  • Constructor Details

    • SFRotationObject

      public SFRotationObject()
      Constructor for SFRotationObject performs value initialization.
    • SFRotationObject

      public SFRotationObject​(SFRotationObject newValue)
      Constructor to copy an SFRotationObject value as initial value for this new field object.
      Parameters:
      newValue - The newValue to apply
    • SFRotationObject

      public SFRotationObject​(float[] newValue)
      Constructor for SFRotationObject 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 SFRotation tuple size of 4. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
    • SFRotationObject

      public SFRotationObject​(float x, float y, float z, float angleRadians)
      Constructor using individual float types as new initial axis-angle value. Warning: angle must be in radians, if necessary use degreesToRadians(float)
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
    • SFRotationObject

      public SFRotationObject​(double x, double y, double z, double angleRadians)
      Constructor using individual double types as new initial axis-angle value. Warning: angle must be in radians, if necessary use degreesToRadians(float)
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
    • SFRotationObject

      public SFRotationObject​(int x, int y, int z, float angleRadians)
      Constructor using individual integer types as new initial axis, along with float angle value. Warning: angle must be in radians, if necessary use degreesToRadians(float)
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
    • SFRotationObject

      public SFRotationObject​(double[] newValue)
      Utility constructor for SFRotationObject using an alternatively typed Java double[] array as new initial value.
      Parameters:
      newValue - is new value to assign
  • Method Details

    • initialize

      public void initialize()
      Initialization for SFRotationObject 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​(SFRotationObject comparisonSFRotationObject)
      Determine whether two objects contain equal values.
      Parameters:
      comparisonSFRotationObject - field type to compare
      Returns:
      true if equivalent, false otherwise
    • validate

      public final java.lang.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 java.lang.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​(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 SFRotationObject setValueByString​(java.lang.String newValue) throws InvalidFieldValueException
      Utility accessor for SFRotationObject 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:
      X3DLoaderDOM.toX3dObjectTree(org.w3c.dom.Node)
    • degreesToRadians

      public static float degreesToRadians​(float angleDegrees)
      Utility method converting degrees to radians.
      Parameters:
      angleDegrees - value to convert
      Returns:
      angle value in radians
    • degreesToRadians

      public static float degreesToRadians​(int angleDegrees)
      Utility method converting degrees to radians.
      Parameters:
      angleDegrees - value to convert
      Returns:
      angle value in radians
    • degreesToRadians

      public static float degreesToRadians​(double angleDegrees)
      Utility method converting degrees to radians.
      Parameters:
      angleDegrees - value to convert
      Returns:
      angle value in radians
    • radiansToDegrees

      public static float radiansToDegrees​(float angleRadians)
      Utility method converting radians to degrees.
      Parameters:
      angleRadians - value to convert
      Returns:
      angle value in degrees
    • radiansToDegrees

      public static float radiansToDegrees​(double angleRadians)
      Utility method converting radians to degrees.
      Parameters:
      angleRadians - value to convert
      Returns:
      angle value in degrees
    • normalize

      public SFRotationObject normalize()
      Utility method to normalize this rotation value: unit length for axis-angle vector, angle in range [0-2pi] radians, rotation with zero-length axis is reset to DEFAULT_VALUE.
      Returns:
      SFRotationObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setValue

      public SFRotationObject setValue​(float x, float y, float z, float angleRadians)
      Assign a new value to this field. Warning: angle must be in radians, if necessary use degreesToRadians(float)
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      SFRotationObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setValue

      public SFRotationObject setValue​(double x, double y, double z, double angleRadians)
      Assign a new value to this field. Warning: angle must be in radians, if necessary use degreesToRadians(float)
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      SFRotationObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setValue

      public SFRotationObject setValue​(double[] newValue)
      Assign a new value to this field. Warning: newValue array length must correspond to tuple size for base type SFRotation tuple size of 4.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      SFRotationObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • 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)
    • getValue

      public void getValue​(float[] valueDestination)
      Get the current value of this SFRotationObject by copying it into the valueDestination array, leaving the current object unchanged.
      Specified by:
      getValue in interface SFRotation
      Parameters:
      valueDestination - The array to be filled in with current field values.
    • 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 SFRotation, SFFloatObject.stripTrailingZeroes(float)
    • setValue

      public void setValue​(float[] newValue)
      Assign a new value to this field. Warning: newValue array length must correspond to tuple size for base type SFRotation tuple size of 4.
      Specified by:
      setValue in interface SFRotation
      Parameters:
      newValue - The replacement value to assign.
      See Also:
      X3DConcreteField.getTupleSize(String)
    • setValueArray

      public SFRotationObject setValueArray​(float[] newValue)
      Assign a new array value to this field, pipelined. This is an alternate utility method since primary method returns void and cannot be overridden. Warning: newValue array length must correspond to tuple size for base type SFRotation tuple size of 4.
      Parameters:
      newValue - The replacement value to assign.
      Returns:
      SFRotationObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3DConcreteField.getTupleSize(String)
    • toFloatArray

      public float[] toFloatArray()
      Provide float array for this field type.
      Returns:
      Array of floats in this field array.
    • setValue

      public SFRotationObject setValue​(SFRotationObject newValue)
      Apply an SFRotationObject value to this field.
      Parameters:
      newValue - The newValue to apply
      Returns:
      SFRotationObject - 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