SoMFInstanceParameter Class Reference
[Fields]

Multiple-value field containing any number of SoInstanceParameter nodes. More...

#include <Inventor/fields/SoMFInstanceParameter.h>

Inheritance diagram for SoMFInstanceParameter:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
const SoMFInstanceParameter &	operator= (const SoMFInstanceParameter &f)
	SoMFInstanceParameter ()
virtual	~SoMFInstanceParameter ()
SoInstanceParameter *	operator[] (int i) const
const SoInstanceParameter **	getValues (int start) const
int	find (SoInstanceParameter *targetValue, SbBool addIfNotFound=FALSE)
void	setValues (int start, int num, const SoInstanceParameter **newValues)
void	set1Value (int index, SoInstanceParameter *newValue)
void	setValue (SoInstanceParameter *newValue)
SoInstanceParameter *	operator= (SoInstanceParameter *newValue)
int	operator== (const SoMFInstanceParameter &f) const
int	operator!= (const SoMFInstanceParameter &f) const
virtual void	enableDeleteValues ()
virtual void	disableDeleteValues ()
virtual SbBool	isDeleteValuesEnabled ()
virtual size_t	getValueSize () const
void	setValuesPointer (int num, const SoInstanceParameter **userData)
void	setValuesPointer (int num, SoInstanceParameter **userData)
SoInstanceParameter *	findParameterByName (const SbString &name) const
SoInstanceParameter *	setColors (SbColor *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
SoInstanceParameter *	setTransparencies (float *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
SoInstanceParameter *	setScales (SbVec3f *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
SoInstanceParameter *	setRotations (SbVec4f *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
SoInstanceParameter *	setRotations (SbRotation *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
SoInstanceParameter *	setVisibilities (int32_t *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
SoInstanceParameter *	setTranslations (SbVec3f *values, size_t nbValues, uint32_t divisor=1, SoMemoryObject::CopyPolicy policy=SoMemoryObject::NO_COPY)
bool	removeParameterByName (const SbString &name)
SoInstanceParameter **	startEditing ()
void	finishEditing ()
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

Multiple-value field containing any number of SoInstanceParameter nodes.

This field contains a set of SoInstanceParameter instances , correctly maintaining their reference counts.

An SoMFInstanceParameter is written to file as one or more SoInstanceParameters. When more than one value is present, all of the values are enclosed in square brackets and separated by commas.

Convenience methods, for example setColors(), are provide to more easily set commonly used instance parameters.

SEE ALSO

SoMultipleInstance

NOTE: node available since Open Inventor 9.5

---

Constructor & Destructor Documentation

SoMFInstanceParameter::SoMFInstanceParameter

(

)

Default constructor.

virtual SoMFInstanceParameter::~SoMFInstanceParameter

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void SoMFInstanceParameter::disableDeleteValues

(

)

[inline, virtual]

Temporary disable value deleting.

virtual void SoMFInstanceParameter::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 SoMFInstanceParameter::find	(	SoInstanceParameter *	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).

SoInstanceParameter* SoMFInstanceParameter::findParameterByName

(

const SbString &

name

)

const

Returns the first parameter with the specified name.

Returns NULL if not found.

void SoMFInstanceParameter::finishEditing

(

)

Indicates that batch edits have finished.

See also:

startEditing().

static SoType SoMFInstanceParameter::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFInstanceParameter::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SoInstanceParameter* * SoMFInstanceParameter::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 SoMFInstanceParameter::getValueSize

(

)

const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

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

(

const SoMFInstanceParameter &

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.

SoInstanceParameter* SoMFInstanceParameter::operator=

(

SoInstanceParameter *

newValue

)

[inline]

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

the second and subsequent values.

const SoMFInstanceParameter& SoMFInstanceParameter::operator=

(

const SoMFInstanceParameter &

f

)

Copy from another field of same type.

int SoMFInstanceParameter::operator==

(

const SoMFInstanceParameter &

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.

SoInstanceParameter* SoMFInstanceParameter::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.

bool SoMFInstanceParameter::removeParameterByName

(

const SbString &

name

)

Remove the instance parameter with the specified name.

Returns true if successful, false if not found.

void SoMFInstanceParameter::set1Value	(	int	index,
		SoInstanceParameter *	newValue
	)

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

The array will be automatically expanded, if necessary.

SoInstanceParameter* SoMFInstanceParameter::setColors	(	SbColor *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The color values as SbColor.
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

SoInstanceParameter* SoMFInstanceParameter::setRotations	(	SbRotation *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The rotation values as SbRotation.
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

SoInstanceParameter* SoMFInstanceParameter::setRotations	(	SbVec4f *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The rotation values as SbVec4f (quaternions).
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

SoInstanceParameter* SoMFInstanceParameter::setScales	(	SbVec3f *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The scale values as SbVec3f.
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

SoInstanceParameter* SoMFInstanceParameter::setTranslations	(	SbVec3f *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The translation values as SbVec3f.
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

SoInstanceParameter* SoMFInstanceParameter::setTransparencies	(	float *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The transparency values as float.
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

void SoMFInstanceParameter::setValue

(

SoInstanceParameter *

newValue

)

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

the second and subsequent values.

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

See setValuesPointer(int, const SoInstanceParameter * *).

void SoMFInstanceParameter::setValuesPointer	(	int	num,
		const SoInstanceParameter **	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).

SoInstanceParameter* SoMFInstanceParameter::setVisibilities	(	int32_t *	values,
		size_t	nbValues,
		uint32_t	divisor = 1,
		SoMemoryObject::CopyPolicy	policy = SoMemoryObject::NO_COPY
	)

Sets the value of this parameter from the input array.

Parameters:

	values	The visibility values as int32_t.
	nbValues	The number of values contained in the input array.
	divisor	The number of instances that share the same value.
	policy	Whether to copy the input values or not. NO_COPY_AND_DELETE and NO_COPY_AND_FREE are treated as NO_COPY.

SoInstanceParameter** SoMFInstanceParameter::startEditing

(

)

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/SoMFInstanceParameter.h