com.openinventor.inventor.fields

Class SoSFArray

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFArray

Direct Known Subclasses:

SoSFArray2D, SoSFArray3D

public class SoSFArray
extends SoSField

Abstract Field containing an array of values. Subclasses of this field can contain a 2D or 3D array of values of a specified type.

See also:

SoField, SoSField, SoSFArray2D, SoSFArray3D

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoSFArray.Array3D
static class	SoSFArray.CopyPolicies SoSFArray may be manipulating some large amounts of memory.
static class	SoSFArray.DataTypes Supported data type enumeration values.

Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField

SoField.FieldTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	COPY Deprecated. Use SoSFArray.CopyPolicies.COPY instead.
static int	FLOAT Deprecated. Use SoSFArray.DataTypes.FLOAT instead.
static int	NO_COPY Deprecated. Use SoSFArray.CopyPolicies.NO_COPY instead.
static int	SIGNED_BYTE Deprecated. Use SoSFArray.DataTypes.SIGNED_BYTE instead.
static int	SIGNED_INT32 Deprecated. Use SoSFArray.DataTypes.SIGNED_INT32 instead.
static int	SIGNED_SHORT Deprecated. Use SoSFArray.DataTypes.SIGNED_SHORT instead.
static int	UNSIGNED_BYTE Deprecated. Use SoSFArray.DataTypes.UNSIGNED_BYTE instead.
static int	UNSIGNED_INT32 Deprecated. Use SoSFArray.DataTypes.UNSIGNED_INT32 instead.
static int	UNSIGNED_SHORT Deprecated. Use SoSFArray.DataTypes.UNSIGNED_SHORT instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoSFArray() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFArray(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.nio.ByteBuffer	getData() Returns a read-only pointer to the array's values .
SoSFArray.DataTypes	getDataType() Returns the data type of the array.
SbVec3i32	getSize() Returns the dimensions of the array.
SoSFArray.Array3D	getValue() Returns a read-only pointer to the array's values and its dimensions and data type.
long	getValueSize() Returns the size in bytes of one data value, e.g.
boolean	isEmpty() Returns true if the current array is empty.
boolean	isNeverWrite() Returns the "neverWrite" flag.
void	setNeverWrite(boolean neverWrite) Sets the "neverWrite" flag.
void	setValue(SbVec3i32 size, SbDataType dataType, java.nio.ByteBuffer data) Calls setValue(size, dataType, data, SoSFArray.CopyPolicies.valueOf( SoSFArray.CopyPolicies.COPY.getValue() )).
void	setValue(SbVec3i32 size, SbDataType dataType, java.nio.ByteBuffer data, SoSFArray.CopyPolicies copy) Fill the array with data of the specified dimensions and type using the specified copy policy.

Methods inherited from class com.openinventor.inventor.fields.SoField

appendConnection, appendConnection, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPY

@Deprecated
public static final int COPY

Deprecated. Use SoSFArray.CopyPolicies.COPY instead.

NO_COPY

@Deprecated
public static final int NO_COPY

Deprecated. Use SoSFArray.CopyPolicies.NO_COPY instead.

UNSIGNED_BYTE

@Deprecated
public static final int UNSIGNED_BYTE

Deprecated. Use SoSFArray.DataTypes.UNSIGNED_BYTE instead.

UNSIGNED_SHORT

@Deprecated
public static final int UNSIGNED_SHORT

Deprecated. Use SoSFArray.DataTypes.UNSIGNED_SHORT instead.

UNSIGNED_INT32

@Deprecated
public static final int UNSIGNED_INT32

Deprecated. Use SoSFArray.DataTypes.UNSIGNED_INT32 instead.

SIGNED_BYTE

@Deprecated
public static final int SIGNED_BYTE

Deprecated. Use SoSFArray.DataTypes.SIGNED_BYTE instead.

SIGNED_SHORT

@Deprecated
public static final int SIGNED_SHORT

Deprecated. Use SoSFArray.DataTypes.SIGNED_SHORT instead.

SIGNED_INT32

@Deprecated
public static final int SIGNED_INT32

Deprecated. Use SoSFArray.DataTypes.SIGNED_INT32 instead.

FLOAT

@Deprecated
public static final int FLOAT

Deprecated. Use SoSFArray.DataTypes.FLOAT instead.

Constructor Detail

SoSFArray

@Deprecated
public SoSFArray()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoSFArray

public SoSFArray(SoFieldContainer fieldContainer,
                 java.lang.String fieldName,
                 SoField.FieldTypes fieldType)

Default constructor.

Method Detail

setValue

public void setValue(SbVec3i32 size,
                     SbDataType dataType,
                     java.nio.ByteBuffer data)

Calls setValue(size, dataType, data, SoSFArray.CopyPolicies.valueOf( SoSFArray.CopyPolicies.COPY.getValue() )).

getValue

public SoSFArray.Array3D getValue()

Returns a read-only pointer to the array's values and its dimensions and data type.

isNeverWrite

public boolean isNeverWrite()

Returns the "neverWrite" flag.

getSize

public SbVec3i32 getSize()

Returns the dimensions of the array.

getValueSize

public long getValueSize()

Returns the size in bytes of one data value, e.g. returns 1 if the data type is UNSIGNED_BYTE.

setNeverWrite

public void setNeverWrite(boolean neverWrite)

Sets the "neverWrite" flag. As this field may have to handle large amounts of data and its representation in an .iv file is not very efficient, it is often a good idea not to allow that data to be written out when required by a write action. By default, the "neverWrite" condition is false.

setValue

public void setValue(SbVec3i32 size,
                     SbDataType dataType,
                     java.nio.ByteBuffer data,
                     SoSFArray.CopyPolicies copy)

Fill the array with data of the specified dimensions and type using the specified copy policy.

isEmpty

public boolean isEmpty()

Returns true if the current array is empty.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

getData

public java.nio.ByteBuffer getData()

Returns a read-only pointer to the array's values .

getDataType

public SoSFArray.DataTypes getDataType()

Returns the data type of the array.