public class MFVec3fObject extends X3DConcreteField implements MFVec3f
SFVec3fObject
Modifier and Type | Field and Description |
---|---|
static float[] |
DEFAULT_VALUE
Default value for this field type is an empty array.
|
static java.lang.String |
NAME
String constant NAME provides name of this element: MFVec3f.
|
validationResult
Constructor and Description |
---|
MFVec3fObject()
Constructor for MFVec3fObject performs value initialization.
|
MFVec3fObject(double[] newValue)
Constructor for MFVec3fObject using an alternatively typed Java double[] array as new initial value.
|
MFVec3fObject(float[] newValue)
Constructor for MFVec3fObject using a corresponding Java primitive float[] array as new initial value.
|
MFVec3fObject(MFVec3fObject newValue)
Constructor to copy an MFVec3fObject value as initial value for this new field object.
|
Modifier and Type | Method and Description |
---|---|
void |
append(float[] newValue)
Places new value(s) at the end of the existing value array, increasing the field length accordingly.
|
MFVec3fObject |
append(MFVec3fObject newValue)
Appends a new MFVec3fObject to the end of the existing value array, increasing the field length accordingly.
|
MFVec3fObject |
append(SFVec3fObject newValue)
Appends a new singleton typed value at the end of the existing value array, increasing the field length accordingly.
|
void |
clear()
Removes all values in the field array, changing the array size to zero.
|
void |
get1Value(int index,
float[] destinationValue)
Get an individual value from the existing field array.
|
float[] |
getPrimitiveValue()
Provides current value of the field as a Java primitive type.
|
void |
getValue(float[] valueDestination)
Get the current value of this MFVec3fObject by copying it into the valueDestination array, leaving the current object unchanged.
|
void |
getValue(float[][] valueDestination)
Get the current value of this MFVec3fObject by copying it into the valueDestination array, leaving the current object unchanged.
|
void |
initialize()
Initialization for MFVec3fObject applies default initial value.
|
void |
insertValue(int index,
float[] newValue)
Insert a new value prior to the index location in the existing value array, increasing the field length accordingly.
|
MFVec3fObject |
multiply(float scaleFactor)
Multiply scaleFactor times all values in this field type.
|
MFVec3fObject |
normalize()
Utility method to normalize vector values to unit length, ignore vector values with zero length.
|
void |
remove(int index)
Remove one SFVec3f element of the field array at index position, if found.
|
void |
set1Value(int index,
float[] newValue)
Replace a single value at the appropriate location in the existing value array.
|
MFVec3fObject |
setValue(double[] newValue)
Assign a double-precision array value to this single-precision field.
|
void |
setValue(float[] newValue)
Assign a new float[] value to this field.
|
void |
setValue(int size,
float[] newValue)
Assign an array subset to this field.
|
void |
setValue(int size,
float[][] newValue)
Assign an array subset to this field.
|
MFVec3fObject |
setValue(MFVec3fObject newValue)
Apply an MFVec3fObject value to this field.
|
MFVec3fObject |
setValue(SFVec3fObject newValue)
Assign a single-field SFVec3fObject as new array value.
|
MFVec3fObject |
setValueByString(java.lang.String newValue)
Utility accessor for MFVec3fObject using String value (which must pass parsing validation checks).
|
int |
size()
Get the size of the underlying data array, meaning the number of
simple SFVec3f elements for the given data type.
|
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.
|
addX3DEventListener, getDefinition, getTupleSize, getValidationResult, isReadable, isWritable, removeX3DEventListener, setReadable, setWritable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addX3DEventListener, getDefinition, isReadable, isWritable, removeX3DEventListener
public static final java.lang.String NAME
public static final float[] DEFAULT_VALUE
public MFVec3fObject()
public MFVec3fObject(MFVec3fObject newValue)
newValue
- The newValue to applypublic MFVec3fObject(float[] newValue)
newValue
- is new value to assign
WARNING: newValue array length must correspond to tuple size for base type MFVec3f tuple size of 3.
setContainerFieldOverride(containerFieldName); // apply checksConcreteField#getTupleSize(String)public MFVec3fObject(double[] newValue)
newValue
- is new value to assignpublic void initialize()
initialize
in class X3DConcreteField
public MFVec3fObject setValueByString(java.lang.String newValue) throws InvalidFieldValueException
newValue
- is new value to assign, if empty then assign DEFAULT_VALUEMFMatrix4dObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
method invocations on the same node object).InvalidFieldValueException
X3DLoaderObject.toX3dObjectTree(org.w3c.dom.Node)
public MFVec3fObject normalize()
MFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).public static java.lang.String toString(float[] value)
value
- The value to convert to a StringSFFloatObject.stripTrailingZeroes(float)
public void getValue(float[] valueDestination)
public float[] getPrimitiveValue()
public java.lang.String toString()
toString
in class java.lang.Object
SFFloatObject.stripTrailingZeroes(float)
public void get1Value(int index, float[] destinationValue)
Get an individual value from the existing field array.
If the index is outside the bounds of the current array of data values, an ArrayIndexOutOfBoundsException is thrown.
public void setValue(int size, float[] newValue)
setValue
in interface MFVec3f
size
- indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.newValue
- The replacement value array to (potentially) slice and then assign.X3DConcreteField.getTupleSize(String)
public void getValue(float[][] valueDestination)
public void setValue(int size, float[][] newValue)
setValue
in interface MFVec3f
size
- indicates size of result to copy (i.e. the number of typed singleton values) from beginning of newValue array.newValue
- The replacement value array to (potentially) slice and then assign.X3DConcreteField.getTupleSize(String)
public void setValue(float[] newValue)
newValue
- is replacement value array to assignX3DConcreteField.getTupleSize(String)
public MFVec3fObject setValue(double[] newValue)
newValue
- is replacement value array to assignMFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).X3DConcreteField.getTupleSize(String)
public MFVec3fObject setValue(SFVec3fObject newValue)
newValue
- The replacement value to assign.MFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive
method invocations on the same node object).public void set1Value(int index, float[] newValue) throws java.lang.ArrayIndexOutOfBoundsException
set1Value
in interface MFVec3f
index
- is position of selected value in current arraynewValue
- provides new value to applyjava.lang.ArrayIndexOutOfBoundsException
X3DConcreteField.getTupleSize(String)
public void append(float[] newValue)
append
in interface MFVec3f
newValue
- The newValue to appendX3DConcreteField.getTupleSize(String)
public MFVec3fObject append(SFVec3fObject newValue)
newValue
- The newValue to appendMFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).public MFVec3fObject append(MFVec3fObject newValue)
newValue
- The newValue to appendMFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).X3DConcreteField.getTupleSize(String)
public void insertValue(int index, float[] newValue)
insertValue
in interface MFVec3f
index
- The position for the inserted value in the current arraynewValue
- The newValue to insertX3DConcreteField.getTupleSize(String)
public int size()
public void clear()
public void remove(int index)
public float[] toFloatArray()
public MFVec3fObject setValue(MFVec3fObject newValue)
newValue
- The newValue to applyMFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).public MFVec3fObject multiply(float scaleFactor)
scaleFactor
- scalar value for vector multiplicationMFVec3fObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).Copyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.