SoMFRotation Class Reference
[Fields]

Multiple-value field containing any number of SbRotations. More...

#include <Inventor/fields/SoMFRotation.h>

Inheritance diagram for SoMFRotation:

Public Member Functions
virtual SoType	getTypeId () const
const SoMFRotation &	operator= (const SoMFRotation &f)
	SoMFRotation ()
virtual	~SoMFRotation ()
SbRotation *	startEditing ()
void	finishEditing ()
const SbRotation &	operator[] (int i) const
const SbRotation *	getValues (int start) const
int	find (const SbRotation &targetValue, SbBool addIfNotFound=FALSE)
void	setValues (int start, int num, const SbRotation *newValues)
void	set1Value (int index, const SbRotation &newValue)
void	setValue (const SbRotation &newValue)
const SbRotation &	operator= (const SbRotation &newValue)
int	operator== (const SoMFRotation &f) const
int	operator!= (const SoMFRotation &f) const
virtual void	enableDeleteValues ()
virtual void	disableDeleteValues ()
virtual SbBool	isDeleteValuesEnabled ()
virtual size_t	getValueSize () const
void	setValuesPointer (int num, const SbRotation *userData)
void	setValuesPointer (int num, SbRotation *userData)
void	setValues (int start, int num, const float q[][4])
void	set1Value (int index, float q0, float q1, float q2, float q3)
void	set1Value (int index, const float q[4])
void	set1Value (int index, const SbVec3f &axis, float angle)
void	setValue (float q0, float q1, float q2, float q3)
void	setValue (const float q[4])
void	setValue (const SbVec3f &axis, float angle)
void	set1Value (int index, const SbRotationd &rd)
void	setValue (const SbRotationd &rd)
void	setValues (int start, int num, const SbRotationd *rd)
Static Public Member Functions
static SoType	getClassTypeId ()

Detailed Description

Multiple-value field containing any number of SbRotations.

A multiple-value field that contains any number of SbRotations.

SoMFRotations are written to file as one or more sets of four floating point values. Each set of 4 values is an axis of rotation followed by the amount of right-handed rotation about that axis, in radians.

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

      [ 1 0 0 0, -.707 -.707 0 1.57 ]

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

SoMFRotation::SoMFRotation ( )

Default constructor.

virtual SoMFRotation::~SoMFRotation ( ) [virtual]

Destructor.

Member Function Documentation

virtual void SoMFRotation::disableDeleteValues ( ) [inline, virtual]

Temporary disable value deleting.

virtual void SoMFRotation::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 SoMFRotation::find	(	const SbRotation &	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 SoMFRotation::finishEditing ( ) [inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFRotation::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFRotation::getTypeId ( ) const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbRotation* SoMFRotation::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 SoMFRotation::getValueSize ( ) const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFRotation::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 SoMFRotation::operator!= ( const SoMFRotation & 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 SbRotation& SoMFRotation::operator= ( const SbRotation & newValue ) [inline]

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

the second and subsequent values.

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

Copy from another field of same type.

int SoMFRotation::operator== ( const SoMFRotation & 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 SbRotation& SoMFRotation::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 SoMFRotation::set1Value	(	int	index,
		const SbRotationd &	rd
	)

Sets the index 'th value in the array to newValue , a double precision rotation.

The array will be automatically expanded, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.

void SoMFRotation::set1Value	(	int	index,
		const SbVec3f &	axis,
		float	angle
	)

Sets the index 'th value to the given axis/angle.

void SoMFRotation::set1Value	(	int	index,
		const float	q[4]
	)

Sets the index 'th value to the given quaternion (x, y, z, w).

void SoMFRotation::set1Value	(	int	index,
		float	q0,
		float	q1,
		float	q2,
		float	q3
	)

Sets the index 'th value to the given quaternion (x, y, z, w).

void SoMFRotation::set1Value	(	int	index,
		const SbRotation &	newValue
	)

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

The array will be automatically expanded, if necessary.

void SoMFRotation::setValue ( const SbRotationd & rd )

Sets the first value in the array to newValue , a double precision rotation, and deletes the second and subsequent values.

Note that Open Inventor fields still store only single precision values, not double precision values. The specified value is converted to single precision, then stored.

void SoMFRotation::setValue	(	const SbVec3f &	axis,
		float	angle
	)

Makes this field have exactly one value, given by axis and angle .

void SoMFRotation::setValue ( const float q[4] )

Makes this field have exactly one value, given by the quaternion (x, y, z, w).

void SoMFRotation::setValue	(	float	q0,
		float	q1,
		float	q2,
		float	q3
	)

Makes this field have exactly one value, given by the quaternion (x, y, z, w).

void SoMFRotation::setValue ( const SbRotation & newValue )

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

the second and subsequent values.

void SoMFRotation::setValues	(	int	start,
		int	num,
		const SbRotationd *	rd
	)

Sets num values starting at index start to the values in newValues , an array of double precision rotations.

The array will automatically be made larger to accommodate the new values, if necessary. Note that Open Inventor fields still store only single precision values, not double precision values. The specified values are converted to single precision, then stored.

void SoMFRotation::setValues	(	int	start,
		int	num,
		const float	q[][4]
	)

Sets values from an array of arrays of 4 floats.

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

See setValuesPointer(int, const SbRotation *).

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

SbRotation* SoMFRotation::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/SoMFRotation.h

SoMFRotation Class Reference [Fields]

Public Member Functions

Static Public Member Functions

Detailed Description

SEE ALSO

Constructor & Destructor Documentation

Member Function Documentation

SoMFRotation Class Reference
[Fields]