SFVec2fObject (X3DJSAIL, X3D Java Scene Access Interface Library)

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

All Implemented Interfaces:

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

Package hint: This specification class is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI). SFVec2f is a 2-tuple pair of SFFloat values. Hint: SFVec2f can be used to specify a 2D single-precision coordinate. Warning: comma characters in attribute values do not pass strict XML validation.

Related field object: MFVec2fObject

See Also:

X3D Tooltips: type SFVec2f, SAI Java Specification: B.4.11 X3DFieldTypes, SAI Abstract Specification: 5.2.15 SAIFieldType, X3D Abstract Specification: SFVec2fAndMFVec2f, 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 0 0.
`static java.lang.String`	`DEFAULT_VALUE_STRING` Default string value for this field type is "0.0 0.0".
`static java.lang.String`	`NAME` String constant NAME provides name of this element: SFVec2f
`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 2 (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
`SFVec2fObject()` Constructor for SFVec2fObject performs value initialization.
`SFVec2fObject(double x, double y)` Utility constructor for SFVec2fObject using double values.
`SFVec2fObject(float[] newValue)` Constructor for SFVec2fObject using a corresponding Java primitive float[] array as new initial value.
`SFVec2fObject(float x, float y)` Utility constructor for SFVec2fObject using individual primitive values.
`SFVec2fObject(SFVec2fObject newValue)` Constructor to copy an SFVec2fObject 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[]`	`getPrimitiveValue()` Provides current value of the field as a Java primitive type.
`void`	`getValue(float[] valueDestination)` Get the current value of this SFVec2fObject by copying it into the valueDestination array, leaving the current object unchanged.
`void`	`initialize()` Initialization for SFVec2fObject 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.
`SFVec2fObject`	`multiply(float scaleFactor)` Multiply scaleFactor times all values in this field type.
`SFVec2fObject`	`normalize()` Utility method to normalize this vector value to unit length, ignore if zero length.
`SFVec2fObject`	`setValue(double x, double y)` Assign a new value to this field.
`void`	`setValue(float[] newValue)` Assign a new value to this field.
`SFVec2fObject`	`setValue(float x, float y)` Assign a new value to this field.
`SFVec2fObject`	`setValue(SFVec2fObject newValue)` Apply an SFVec2fObject value to this field.
`SFVec2fObject`	`setValueByString(java.lang.String newValue)` Utility accessor for SFVec2fObject 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 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

Methods inherited from interface org.web3d.x3d.sai.X3DField
addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: SFVec2f
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
public static final float[] DEFAULT_VALUE
```
    Default value for this field type contains values of 0 0.
    
    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 "0.0 0.0".
    
    See Also:
    
    Constant Field Values
  - TUPLE_SIZE
```
public static final int TUPLE_SIZE
```
    Default tuple size for this field type is 2 (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+){1}([+-]?((0|[1-9][0-9]*)(\.[0-9]*)?|\.[0-9]+)([Ee][+-]?[0-9]+)?)\s*
    
    See Also:
    
    PATTERN, matches(), matches(String), validate(), X3D Regular Expressions: SFVec2f, 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
  - SFVec2fObject
```
public SFVec2fObject()
```
    Constructor for SFVec2fObject performs value initialization.
  - SFVec2fObject
```
public SFVec2fObject(SFVec2fObject newValue)
```
    Constructor to copy an SFVec2fObject value as initial value for this new field object.
    
    Parameters:
    
    newValue - The newValue to apply
  - SFVec2fObject
```
public SFVec2fObject(float[] newValue)
```
    Constructor for SFVec2fObject 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 SFVec2f tuple size of 2. setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)
  - SFVec2fObject
```
public SFVec2fObject(float x,
                     float y)
```
    Utility constructor for SFVec2fObject using individual primitive values.
    
    Parameters:
    
    x - first component of axis
    
    y - second component of axis
    
    See Also:
    
    X3D Tooltips: type
  - SFVec2fObject
```
public SFVec2fObject(double x,
                     double y)
```
    Utility constructor for SFVec2fObject using double values.
    
    Parameters:
    
    x - first component
    
    y - second component
    
    See Also:
    
    X3D Tooltips: type
- Method Detail
  - initialize
```
public void initialize()
```
    Initialization for SFVec2fObject 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 SFVec2fObject setValueByString(java.lang.String newValue)
                               throws InvalidFieldValueException
```
    Utility accessor for SFVec2fObject 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)
  - normalize
```
public SFVec2fObject normalize()
```
    Utility method to normalize this vector value to unit length, ignore if zero length.
    
    Returns:
    
    SFVec2fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - 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 SFVec2fObject by copying it into the valueDestination array, leaving the current object unchanged.
    
    Specified by:
    
    getValue in interface SFVec2f
    
    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 SFVec2f, 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 SFVec2f tuple size of 2.
    
    Specified by:
    
    setValue in interface SFVec2f
    
    Parameters:
    
    newValue - The replacement value to assign.
    
    See Also:
    
    X3DConcreteField.getTupleSize(String)
  - setValue
```
public SFVec2fObject setValue(float x,
                              float y)
```
    Assign a new value to this field.
    
    Parameters:
    
    x - first component
    
    y - second component
    
    Returns:
    
    SFVec2fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setValue
```
public SFVec2fObject setValue(double x,
                              double y)
```
    Assign a new value to this field.
    
    Parameters:
    
    x - first component
    
    y - second component
    
    Returns:
    
    SFVec2fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - toFloatArray
```
public float[] toFloatArray()
```
    Provide float array for this field type.
    
    Returns:
    
    Array of floats in this field array.
  - setValue
```
public SFVec2fObject setValue(SFVec2fObject newValue)
```
    Apply an SFVec2fObject value to this field.
    
    Parameters:
    
    newValue - The newValue to apply
    
    Returns:
    
    SFVec2fObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - multiply
```
public SFVec2fObject multiply(float scaleFactor)
```
    Multiply scaleFactor times all values in this field type.
    
    Parameters:
    
    scaleFactor - scalar value for vector multiplication
    
    Returns:
    
    SFVec2fObject - 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 SFVec2fObject

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

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

Field Detail

NAME

DEFAULT_VALUE

DEFAULT_VALUE_STRING

TUPLE_SIZE

REGEX

PATTERN

Constructor Detail

SFVec2fObject

SFVec2fObject

SFVec2fObject

SFVec2fObject

SFVec2fObject

Method Detail

initialize

validate

matches

matches

setValueByString

normalize

toString

getValue

getPrimitiveValue

toString

setValue

setValue

setValue

toFloatArray

setValue

multiply

isDefaultValue