SoSFArray3D Class Reference
[Fields]

Field containing a 3D array value. More...

#include <Inventor/fields/SoSFArray3D.h>

Inheritance diagram for SoSFArray3D:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
const SoSFArray3D &	operator= (const SoSFArray3D &f)
	SoSFArray3D ()
virtual	~SoSFArray3D ()
void	setValue (const SbVec3i32 &size, const SbDataType &dataType, unsigned int numSigBits, const void *data, CopyPolicy copy)
void	setValue (const SbVec3i32 &size, unsigned int numSigBits, SoMemoryObject *memObj, CopyPolicy copy)
unsigned int	getNumSigBits () const
virtual int	operator== (const SoSFArray3D &f) const
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

Field containing a 3D array value.

This field contains a 3D array of values of a specified type. The setValue method allows you to specify the dimensions and type of data the array will contain, as well as the number of significant bits. The CopyPolicy allows you to control whether Open Inventor will make a copy of the data and, if not, whether the application or Open Inventor is responsible for managing the memory.

In ASCII format, an SoSFArray3D is written to file in the following format:

• Three numbers define the dimensions of the array
• One string defines the type of the data:
  • BYTE for signed bytes
  • UBYTE for unsigned bytes
  • SHORT for signed shorts
  • USHORT for unsigned shorts
  • INT32 for signed 32 bits ints
  • UINT32 for unsigned 32 bits ints
  • FLOAT for floating point values
• A list of values in decimal, hexadecimal, or octal format for integers or in standard scientific notation for float. Numbers are separated by a blank (space, tab, return...).
• One number defines the number of significant bits

The example below shows the definition of a 2x2x2 array of unsigned bytes with data values 0, 1, 2, 3, 4, 5, 6, 7 and a number of significant bits of 8:

   2 2 2 UBYTE
   0 1
   2 3
   4 5
   6 7
   8
 * \verbatim
 *
 * An SoSFArray3D may be empty or contain only dimension and type information,
 * but no data values.  With no data values the previous example would be
 * written with the prefix "NODATA" like this:
 * \verbatim
   NODATA 2 2 2 UBYTE
   8
   

SEE ALSO

SoField, SoSField, SoSFArray, SoSFArray2D

---

Constructor & Destructor Documentation

SoSFArray3D::SoSFArray3D

(

)

Default constructor.

virtual SoSFArray3D::~SoSFArray3D

(

)

[virtual]

Destructor.

---

Member Function Documentation

static SoType SoSFArray3D::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoSFArray.

unsigned int SoSFArray3D::getNumSigBits

(

)

const [inline]

Returns the number of significant bits.

virtual SoType SoSFArray3D::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoSFArray.

const SoSFArray3D& SoSFArray3D::operator=

(

const SoSFArray3D &

f

)

Copy from another field of same type.

Reimplemented from SoSFArray.

virtual int SoSFArray3D::operator==

(

const SoSFArray3D &

f

)

const [virtual]

Returns TRUE if all of the values of this field equal those of the given field f.

If the fields are different types FALSE will always be returned.

Reimplemented from SoSFArray.

void SoSFArray3D::setValue	(	const SbVec3i32 &	size,
		unsigned int	numSigBits,
		SoMemoryObject *	memObj,
		CopyPolicy	copy
	)

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

void SoSFArray3D::setValue	(	const SbVec3i32 &	size,
		const SbDataType &	dataType,
		unsigned int	numSigBits,
		const void *	data,
		CopyPolicy	copy
	)

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

---

The documentation for this class was generated from the following file:

• Inventor/fields/SoSFArray3D.h