SoMFVec2f Class Reference
[Fields]

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

#include <Inventor/fields/SoMFVec2f.h>

Inheritance diagram for SoMFVec2f:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
const SoMFVec2f &	operator= (const SoMFVec2f &f)
	SoMFVec2f ()
virtual	~SoMFVec2f ()
SbVec2f *	startEditing ()
void	finishEditing ()
const SbVec2f &	operator[] (int i) const
const SbVec2f *	getValues (int start) const
int	find (const SbVec2f &targetValue, SbBool addIfNotFound=FALSE)
void	setValues (int start, int num, const SbVec2f *newValues)
void	set1Value (int index, const SbVec2f &newValue)
void	setValue (const SbVec2f &newValue)
const SbVec2f &	operator= (const SbVec2f &newValue)
int	operator== (const SoMFVec2f &f) const
int	operator!= (const SoMFVec2f &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 SbVec2f *userData)
void	setValuesPointer (int num, SbVec2f *userData)
void	setValues (int start, int num, const float xy[][2])
void	set1Value (int index, float x, float y)
void	set1Value (int index, const float xy[2])
void	setValue (float x, float y)
void	setValue (const float xy[2])
void	set1Value (int index, const SbVec2d &vec2d)
void	setValue (const SbVec2d &vec2d)
void	setValues (int start, int num, const SbVec2d *vec2d)
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

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

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

SoMFVec2fs are written to file as one or more pairs 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, 1.2 3.4, 98.6 -4e1 ]
    

Data copying:

SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

---

Constructor & Destructor Documentation

SoMFVec2f::SoMFVec2f

(

)

Default constructor.

virtual SoMFVec2f::~SoMFVec2f

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void SoMFVec2f::disableDeleteValues

(

)

[inline, virtual]

Temporary disable value deleting.

virtual void SoMFVec2f::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 SoMFVec2f::find	(	const SbVec2f &	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 SoMFVec2f::finishEditing

(

)

[inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFVec2f::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFVec2f::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbVec2f* SoMFVec2f::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 SoMFVec2f::getValueSize

(

)

const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFVec2f::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 SoMFVec2f::operator!=

(

const SoMFVec2f &

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 SbVec2f& SoMFVec2f::operator=

(

const SbVec2f &

newValue

)

[inline]

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

the second and subsequent values.

const SoMFVec2f& SoMFVec2f::operator=

(

const SoMFVec2f &

f

)

Copy from another field of same type.

int SoMFVec2f::operator==

(

const SoMFVec2f &

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 SbVec2f& SoMFVec2f::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 SoMFVec2f::set1Value	(	int	index,
		const SbVec2d &	vec2d
	)

Sets one value from double precision vector.

void SoMFVec2f::set1Value	(	int	index,
		const float	xy[2]
	)

Sets one value from 2 floats in array.

void SoMFVec2f::set1Value	(	int	index,
		float	x,
		float	y
	)

Sets one value from 2 floats.

void SoMFVec2f::set1Value	(	int	index,
		const SbVec2f &	newValue
	)

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

The array will be automatically expanded, if necessary.

void SoMFVec2f::setValue

(

const SbVec2d &

vec2d

)

Sets to one value from double precision vector.

void SoMFVec2f::setValue

(

const float

xy[2]

)

Sets to one value from 2 floats in array.

void SoMFVec2f::setValue	(	float	x,
		float	y
	)

Sets to one value from 2 floats.

void SoMFVec2f::setValue

(

const SbVec2f &

newValue

)

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

the second and subsequent values.

void SoMFVec2f::setValues	(	int	start,
		int	num,
		const SbVec2d *	vec2d
	)

Sets values from array of double precision vectors.

void SoMFVec2f::setValues	(	int	start,
		int	num,
		const float	xy[][2]
	)

Sets values from array of arrays of 2 floats.

void SoMFVec2f::setValues	(	int	start,
		int	num,
		const SbVec2f *	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 SoMFVec2f::setValuesPointer	(	int	num,
		SbVec2f *	userData
	)

See setValuesPointer(int, const SbVec2f *).

void SoMFVec2f::setValuesPointer	(	int	num,
		const SbVec2f *	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 SoMFVec2f::setValuesPointer	(	int	num,
		float *	userData
	)

See setValuesPointer(int, const float *).

void SoMFVec2f::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).

SbVec2f* SoMFVec2f::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/SoMFVec2f.h