SoMFVec3f Class Reference
[Fields]

Multiple-value field containing any number of three-dimensional vectors. More...

#include <Inventor/fields/SoMFVec3f.h>

Inheritance diagram for SoMFVec3f:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
const SoMFVec3f &	operator= (const SoMFVec3f &f)
	SoMFVec3f ()
virtual	~SoMFVec3f ()
SbVec3f *	startEditing ()
void	finishEditing ()
const SbVec3f &	operator[] (int i) const
const SbVec3f *	getValues (int start) const
int	find (const SbVec3f &targetValue, SbBool addIfNotFound=FALSE)
void	setValues (int start, int num, const SbVec3f *newValues)
void	set1Value (int index, const SbVec3f &newValue)
void	setValue (const SbVec3f &newValue)
const SbVec3f &	operator= (const SbVec3f &newValue)
int	operator== (const SoMFVec3f &f) const
int	operator!= (const SoMFVec3f &f) const
virtual void	enableDeleteValues ()
virtual void	disableDeleteValues ()
virtual SbBool	isDeleteValuesEnabled ()
virtual size_t	getValueSize () const
void	setValuesPointer (int num, const float *userData)
void	setValuesPointer (int num, float *userData)
void	setValuesPointer (int num, const SbVec3f *userData)
void	setValuesPointer (int num, SbVec3f *userData)
void	setValues (int start, int num, const float xyz[][3])
void	set1Value (int index, float x, float y, float z)
void	set1Value (int index, const float xyz[3])
void	setValue (float x, float y, float z)
void	setValue (const float xyz[3])
void	set1Value (int index, const SbVec3d &vec3d)
void	setValue (const SbVec3d &vec3d)
void	setValues (int start, int num, const SbVec3d *vec3d)
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

Multiple-value field containing any number of three-dimensional vectors.

A multiple-value field that contains any number of three-dimensional vectors.

SoMFVec3fs are written to file as one or more triples of floating point values separated by whitespace.

When more than one value is present, all of the values are enclosed in square brackets and separated by commas; for example:

     [ 0 0 0, 1.2 3.4 5.6, 98.6 -4e1 212 ]
    

Using the setValues() method:

Note: If you use the setValues() method to set a larger number of values than the field currently contains, Open Inventor will automatically allocate more memory. The total number of values in the field is increased as expected. However the converse is not true. If you use setValues() to set a smaller number of values than the field currently contains, you are simply overriding some of the values in the field. The total number of values in the field does not change. If you want to replace the current contents of the field with a smaller number of values, first call setNum( 0 ), then call setValues().

Using an Application-Supplied Array

The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied and the memory will not be deleted by Open Inventor unless enableDeleteValues() is called. NOTE: When setValuesPointer( 0, 0 ) is called, the previously set buffer and number of items are not reset. Call the deleteValues( 0 ) method instead to reset the field's content.

methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied.

When using application data directly the values may be modified by changing the application memory and calling touch() to notify Open Inventor of the change. The values may also be modified using the usual methods (set1Value(), etc.)

However, note that some methods (setNum(), deleteValues(), insertSpace(), setValues(), set1Value(), setValue()) may force Open Inventor to allocate a larger block of memory to hold all the values. In this case, Open Inventor will allocate memory internally and copy the data. Modifying values in the application memory will not affect the field if Open Inventor has allocated new memory. The application is still responsible for freeing its memory (using free()) unless enableDeleteValues() has been called.

Example:

   // Allocate memory for vertices
   SbVec3f* vertices = new SbVec3f[NUM_VERTICES]; 

   // Assign values to the vertices (application-specific code)
   //...

   // Set the field's value to vertices in application memory
   SoVertexProperty* vertexProperty = new SoVertexProperty();
   vertexProperty->vertex.setValuesPointer( NUM_VERTICES, vertices ); 

   // Change application data and notify Open Inventor
   vertices[5].setValue( 0, 1, 2 );
   vertexProperty->vertex.touch(); 

---

Constructor & Destructor Documentation

SoMFVec3f::SoMFVec3f

(

)

Default constructor.

virtual SoMFVec3f::~SoMFVec3f

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void SoMFVec3f::disableDeleteValues

(

)

[inline, virtual]

Temporary disable value deleting.

virtual void SoMFVec3f::enableDeleteValues

(

)

[inline, virtual]

Sets the enableDeleteValues flag.

This flag (if TRUE) allows Open Inventor to destroy the user data array given to setValuesPointer(). This user data array will be managed exactly like internal field data values. Default is FALSE.

int SoMFVec3f::find	(	const SbVec3f &	targetValue,
		SbBool	addIfNotFound = FALSE
	)

Finds the given targetValue in the array and returns the index of that value.

in the array. If the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is added to the end of the array (but -1 is still returned).

void SoMFVec3f::finishEditing

(

)

[inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFVec3f::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFVec3f::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbVec3f* SoMFVec3f::getValues

(

int

start

)

const [inline]

Returns a pointer into the array of values in the field, starting at index start.

The values are read-only. See the startEditing()/finishEditing() methods for a way of modifying values in place.

virtual size_t SoMFVec3f::getValueSize

(

)

const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFVec3f::isDeleteValuesEnabled

(

)

[inline, virtual]

Returns FALSE if user data array has been given to.

setValuesPointer() and enableDeleteValues() has never been called, and memory for data has not been reallocated. Otherwise, returns TRUE.

int SoMFVec3f::operator!=

(

const SoMFVec3f &

f

)

const [inline]

Returns TRUE if all of the values of this field do not equal.

those of the given f. If the fields are different types TRUE will always be returned.

Reimplemented from SoField.

const SbVec3f& SoMFVec3f::operator=

(

const SbVec3f &

newValue

)

[inline]

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

const SoMFVec3f& SoMFVec3f::operator=

(

const SoMFVec3f &

f

)

Copy from another field of same type.

int SoMFVec3f::operator==

(

const SoMFVec3f &

f

)

const

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

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

Reimplemented from SoField.

const SbVec3f& SoMFVec3f::operator[]

(

int

i

)

const [inline]

Returns the i'th value of the field.

Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

void SoMFVec3f::set1Value	(	int	index,
		const SbVec3d &	vec3d
	)

Sets one value from double precision vector.

void SoMFVec3f::set1Value	(	int	index,
		const float	xyz[3]
	)

Sets one value from 3 floats in array.

void SoMFVec3f::set1Value	(	int	index,
		float	x,
		float	y,
		float	z
	)

Sets one value from 3 floats.

void SoMFVec3f::set1Value	(	int	index,
		const SbVec3f &	newValue
	)

Sets the index'th value in the array to newValue.

The array will be automatically expanded, if necessary.

void SoMFVec3f::setValue

(

const SbVec3d &

vec3d

)

Sets to one value from double precision vector.

void SoMFVec3f::setValue

(

const float

xyz[3]

)

Sets to one value from 3 floats in array.

void SoMFVec3f::setValue	(	float	x,
		float	y,
		float	z
	)

Sets to one value from 3 floats.

void SoMFVec3f::setValue

(

const SbVec3f &

newValue

)

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

void SoMFVec3f::setValues	(	int	start,
		int	num,
		const SbVec3d *	vec3d
	)

Sets values from array of double precision vectors.

void SoMFVec3f::setValues	(	int	start,
		int	num,
		const float	xyz[][3]
	)

Sets values from array of arrays of 3 floats.

void SoMFVec3f::setValues	(	int	start,
		int	num,
		const SbVec3f *	newValues
	)

Sets num values starting at index start to the values.

in newValues. The array will automatically be made larger to accommodate the new values, if necessary.

void SoMFVec3f::setValuesPointer	(	int	num,
		SbVec3f *	userData
	)

See setValuesPointer(int, const SbVec3f *).

void SoMFVec3f::setValuesPointer	(	int	num,
		const SbVec3f *	userData
	)

Sets the field to contain the num values stored in userData array.

This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).

void SoMFVec3f::setValuesPointer	(	int	num,
		float *	userData
	)

See setValuesPointer(int, const float *).

void SoMFVec3f::setValuesPointer	(	int	num,
		const float *	userData
	)

Sets the field to contain the num values stored in userData array.

This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).

SbVec3f* SoMFVec3f::startEditing

(

)

[inline]

Returns a pointer to the internally maintained array that can be modified.

The values in the array may be changed, but values cannot be added or removed. It is illegal to call any other editing methods between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc.). Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to FALSE and informs engines and sensors that the field changed, even if none of the values actually were changed.

---

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

• Inventor/fields/SoMFVec3f.h