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

#include <Inventor/fields/SoMFInstanceParameter.h>

Inheritance diagram for SoMFInstanceParameter:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

const SoMFInstanceParameter &	operator= (const SoMFInstanceParameter &f)
	Copy from another field of same type.

	SoMFInstanceParameter ()
	Default constructor.

virtual	~SoMFInstanceParameter ()
	Destructor.

SoInstanceParameter *	operator[] (int i) const
	Returns the i'th value of the field.

const SoInstanceParameter **	getValues (int start) const
	Returns a pointer into the array of values in the field, starting at index start.

int	find (SoInstanceParameter *targetValue, SbBool addIfNotFound=FALSE)
	Finds the given targetValue in the array and returns the index of that value.

void	setValues (int start, int num, const SoInstanceParameter **newValues)
	Sets num values starting at index start to the values.

void	set1Value (int index, SoInstanceParameter *newValue)
	Sets the index'th value in the array to newValue.

void	setValue (SoInstanceParameter *newValue)
	Sets the first value in the array to newValue, and deletes.

SoInstanceParameter *	operator= (SoInstanceParameter *newValue)
	Sets the first value in the array to newValue, and deletes.

int	operator== (const SoMFInstanceParameter &f) const
	Returns TRUE if all of the values of this field equal those of.

int	operator!= (const SoMFInstanceParameter &f) const
	Returns TRUE if all of the values of this field do not equal.

virtual void	enableDeleteValues ()
	Sets the enableDeleteValues flag.

virtual void	disableDeleteValues ()
	Temporary disable value deleting.

virtual SbBool	isDeleteValuesEnabled ()
	Returns FALSE if user data array has been given to

virtual size_t	getValueSize () const
	Get size of the value.

void	setValuesPointer (int num, const SoInstanceParameter **userData)
	Sets the field to contain the num values stored in userData array.

void	setValuesPointer (int num, SoInstanceParameter **userData)
	See setValuesPointer(int, const SoInstanceParameter * *)

SoInstanceParameter *	findParameterByName (const SbString &name) const
	Returns the first parameter with the specified name.

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

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

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

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

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

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

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

bool	removeParameterByName (const SbString &name)
	Remove the instance parameter with the specified name.

SoInstanceParameter **	startEditing ()
	Returns a pointer to the internally maintained array that can be modified.

void	finishEditing ()
	Indicates that batch edits have finished.

Public Member Functions inherited from SoMField
int	getNum () const
	Returns the number of values currently in the field.

void	setNum (int num)
	Forces this field to have exactly num values, inserting or deleting values as necessary.

virtual void	deleteValues (int start, int num=-1)
	Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created).

virtual void	insertSpace (int start, int num)
	Inserts space for num values at index start .

SoNONUNICODE SbBool	set1 (int index, const char *valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.

SbBool	set1 (int index, const SbString &valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.

void	get1 (int index, SbString &valueString)
	This is equivalent to the get() method of SoField, but operates on only one value.

Public Member Functions inherited from SoField
void	setIgnored (SbBool ig)
	Sets the ignore flag for this field.

SbBool	isIgnored () const
	Gets the ignore flag for this field.

SbBool	isDefault () const
	Gets the state of default flag of the field.

void	enableConnection (SbBool flag)
	Field connections may be enabled and disabled.

SbBool	isConnectionEnabled () const
	Returns FALSE if connections to this field are disabled.

SbBool	connectFrom (SoEngineOutput *engineOutput)
	Connects this field from an engine output.

SbBool	connectFrom (SoField *field)
	Connects this field to another field.

SbBool	connectFrom (SoVRMLInterpOutput *interpOutput)
	Connects this field from an interpOutput.

SbBool	appendConnection (SoEngineOutput *engineOutput)
	Appends this field to the list of connections from another engineOutput.

SbBool	appendConnection (SoField *field)
	Appends this field to the list of connections from another field.

SbBool	appendConnection (SoVRMLInterpOutput *interpOutput)
	Appends this field to the list of connections from another interpOutput.

void	disconnect (SoEngineOutput *engineOutput)
	Disconnect the field from the requested engineOutput.

void	disconnect (SoField *field)
	Disconnect the field from the requested field.

void	disconnect (SoVRMLInterpOutput *interpOutput)
	Disconnect the field from the requested interpOutput.

int	getNumConnections () const
	Returns the number of connections to this field.

int	getConnections (SoFieldList &list)
	Returns a list of the connections to this field.

void	disconnect ()
	Disconnect the field from whatever it was connected to.

SbBool	isConnected () const
	Returns TRUE if the field is connected to anything.

SbBool	isConnectedFromVRMLInterp () const
	Returns TRUE if the field is connected to a VRML interpOutput.

SbBool	isConnectedFromEngine () const
	Returns TRUE if the field is connected to an engine's output.

SbBool	isConnectedFromField () const
	Returns TRUE if the field is connected to another field.

SbBool	getConnectedEngine (SoEngineOutput *&engineOutput) const
	Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.

SbBool	getConnectedField (SoField *&writingField) const
	Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.

SbBool	getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
	Returns the VRMLInterpolator output field is connected to.

int	getForwardConnections (SoFieldList &list) const
	Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.

SoFieldContainer *	getContainer () const
	Returns the object that contains this field.

SoNONUNICODE SbBool	set (const char *valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

SbBool	set (const SbString &valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

void	get (SbString &valueString)
	Returns the value of the field in the Open Inventor file format, even if the field has its default value.

virtual void	touch ()
	Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.

int	operator== (const SoField &f) const
	Return TRUE if this field is of the same type and has the same value as f.

int	operator!= (const SoField &f) const
	Return FALSE if this field is of the same type and has the same value as f.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoMField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

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.

Constructor & Destructor Documentation

◆ SoMFInstanceParameter()

SoMFInstanceParameter::SoMFInstanceParameter ( )

Default constructor.

◆ ~SoMFInstanceParameter()

virtual SoMFInstanceParameter::~SoMFInstanceParameter ( )

virtual

Destructor.

Member Function Documentation

◆ disableDeleteValues()

virtual void SoMFInstanceParameter::disableDeleteValues ( )

inlinevirtual

Temporary disable value deleting.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ enableDeleteValues()

virtual void SoMFInstanceParameter::enableDeleteValues ( )

inlinevirtual

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.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ find()

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).

◆ findParameterByName()

SoInstanceParameter * SoMFInstanceParameter::findParameterByName ( const SbString & name ) const

Returns the first parameter with the specified name.

Returns NULL if not found.

◆ finishEditing()

void SoMFInstanceParameter::finishEditing ( )

Indicates that batch edits have finished.

See also: startEditing().

◆ getClassTypeId()

static SoType SoMFInstanceParameter::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoMFInstanceParameter::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValues()

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.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ getValueSize()

virtual size_t SoMFInstanceParameter::getValueSize ( ) const

inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ isDeleteValuesEnabled()

virtual SbBool SoMFInstanceParameter::isDeleteValuesEnabled ( )

inlinevirtual

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.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ operator!=()

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.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ operator=() [1/2]

const SoMFInstanceParameter & SoMFInstanceParameter::operator= ( const SoMFInstanceParameter & f )

Copy from another field of same type.

◆ operator=() [2/2]

SoInstanceParameter * SoMFInstanceParameter::operator= ( SoInstanceParameter * newValue )

inline

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

the second and subsequent values.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ operator==()

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.

◆ operator[]()

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.

Definition at line 58 of file SoMFInstanceParameter.h.

◆ removeParameterByName()

bool SoMFInstanceParameter::removeParameterByName ( const SbString & name )

Remove the instance parameter with the specified name.

Returns true if successful, false if not found.

◆ set1Value()

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.

◆ setColors()

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.

◆ setRotations() [1/2]

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.

◆ setRotations() [2/2]

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.

◆ setScales()

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.

◆ setTranslations()

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.

◆ setTransparencies()

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.

◆ setValue()

void SoMFInstanceParameter::setValue ( SoInstanceParameter * newValue )

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

the second and subsequent values.

◆ setValues()

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.

◆ setValuesPointer() [1/2]

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).

◆ setValuesPointer() [2/2]

void SoMFInstanceParameter::setValuesPointer	(	int	num,
		SoInstanceParameter **	userData
	)

See setValuesPointer(int, const SoInstanceParameter * *)

◆ setVisibilities()

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.

◆ startEditing()

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

Open Inventor Release 2023.2.3

Public Member Functions

Static Public Member Functions

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

◆ SoMFInstanceParameter()

◆ ~SoMFInstanceParameter()

Member Function Documentation

◆ disableDeleteValues()

◆ enableDeleteValues()

◆ find()

◆ findParameterByName()

◆ finishEditing()

◆ getClassTypeId()

◆ getTypeId()

◆ getValues()

◆ getValueSize()

◆ isDeleteValuesEnabled()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ removeParameterByName()

◆ set1Value()

◆ setColors()

◆ setRotations() [1/2]

◆ setRotations() [2/2]

◆ setScales()

◆ setTranslations()

◆ setTransparencies()

◆ setValue()

◆ setValues()

◆ setValuesPointer() [1/2]

◆ setValuesPointer() [2/2]

◆ setVisibilities()

◆ startEditing()