SOMFROTATION(3iv)

📦 version 2.1.6.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

SoMFRotation 💅

okay bestie, welcome to SoMFRotation(3IV) — that's the whole manual page id, we're doing this properly. this one is about a field that holds any number of rotations, and yes it is exactly as iconic as it sounds. 🦋

INHERITS FROM 👑

SoField > SoMField > SoMFRotation

it's giving field royalty. it inherits from SoMField, which inherits from SoField. the family tree is eating, fr fr. 🌸

✨ SYNOPSIS ✨

#include <Inventor/fields/SoMFRotation.h>

🎀 Methods from class SoMFRotation

void                set1Value(int index, const SbVec3f &axis, float angle)
void                setValue(const SbVec3f &axis, float angle)
void                set1Value(int index, float q0, float q1, float q2,
                         float q3)
void                set1Value(int index, const float q[4])
void                setValue(float q0, float q1, float q2, float q3)
void                setValue(float q[4])
static SoType       getClassTypeId()
virtual void        getTypeId() const
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)
const SbRotation &  operator =(const SbRotation & newValue)
void                setValue(const SbRotation & newValue)
int                 operator ==(const SoMFRotation &f) const
int                 operator !=(const SoMFRotation &f) const
SbRotation *        startEditing()
void                finishEditing()

🦋 Methods from class SoMField

int                 getNum() const
void                setNum(int num)
virtual void        deleteValues(int start, int num = -1)
virtual void        insertSpace(int start, int num)
SbBool              set1(int index, const char *valueString)
void                get1(int index, SbString &valueString)

💜 Methods from class SoField

void                setIgnored(SbBool ignore)
SbBool              isIgnored() const
SbBool              isDefault() const
virtual SbBool      isOfType(SoType type) const
SbBool              set(const char *valueString)
void                get(SbString &valueString)
void                touch()
SbBool              connectFrom(SoField *fromField)
SbBool              connectFrom(SoEngineOutput *fromEngine)
void                disconnect()
SbBool              isConnected() const
SbBool              isConnectedFromField() const
SbBool              getConnectedField(SoField *&writingField) const
SbBool              isConnectedFromEngine() const
SbBool              getConnectedEngine(SoEngineOutput *&engineOutput)
                         const
void                enableConnection(SbBool flag)
SbBool              isConnectionEnabled() const
int                 getForwardConnections(SoFieldList &list) const
SoFieldContainer *  getContainer() const

🌈 DESCRIPTION 🌈

so, multiple-value field that contains any number of SbRotations. that's the whole vibe. it's a field, it's multiple, it holds rotations. periodt. 💅

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. no cap, that's just how it goes. 🧚

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

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

obsessed with her honestly. 🍓

💖 METHODS 💖

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

Sets the index'th value to the given axis/angle. one value, one slot, done. ✨

void setValue(const SbVec3f &axis, float angle)

Makes this field have exactly one value, given by axis and angle. exactly one. not two. not zero. one. 💅

void                set1Value(int index, float q0, float q1, float q2,
                         float q3)
void                set1Value(int index, const float q[4])

Sets the index'th value to the given quaternion. quaternion besties rise 🫶

void                setValue(float q0, float q1, float q2, float q3)
void                setValue(float q[4])

Makes this field have exactly one value, given by the quaternion. again: one. singular. main character energy, no entourage. 👑

static SoType       getClassTypeId()
virtual void        getTypeId() const

Returns the type for this class or a particular object of this class. iykyk, it's the standard type-id moment. ⭐

const SbRotation & operator [](int i) const

Returns the i'th value of the field. 💖

heads up bestie!! indexing past the end of the field (passing in i greater than getNum()) will return garbage. not a joke, not a vibe, literally garbage. do not do this. 💀

const SbRotation * getValues(int start) const

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

int                 find(const SbRotation & targetValue, SbBool
                         addIfNotFound = FALSE)

Finds the given value 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. yes, still. that's the rule, don't shoot the messenger. 🙈

void                setValues(int start, int num, const SbRotation
                         *newValues)

Sets num values starting at index start to the values in newValues. the array will be automatically be made larger to accomodate the new values, if necessary. slay, it grows for you. 🌱

void set1Value(int index, const SbRotation & newValue)

Sets the index'th value in the array to newValue. the array will be automatically expanded, if necessary. it's got you. 🫶

const SbRotation &  operator =(const SbRotation & newValue)
void                setValue(const SbRotation & newValue)

Sets the first value in the array to newValue, and deletes the second and subsequent values. brutal? maybe. iconic? also yes. 💅

int                 operator ==(const SoMFRotation &f) const
int                 operator !=(const SoMFRotation &f) const

Returns TRUE if all of the values of this field equal (do not equal) those of the given field.

and if the fields are different types, FALSE will always be returned — even if one field is an SoMFFloat with one value of 1.0 and the other is an SoMFInt with a value of 1, for example. yeah. different types, no match, no matter how cute the numbers look together. 😭
SbRotation *        startEditing()
void                finishEditing()

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). illegal illegal. do not.

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. it's dramatic like that. it tells everyone regardless. 💅

🌸 SEE ALSO 🌸

  • SbRotation

and that's the whole page bestie!! 🎀🦋✨💖 source/version + date tea: this one is filed under SoMFRotation(3IV) — that's the footer, that's the ID, that's the whole signature. go forth and rotate responsibly. periodt. 👑💜

📦 where this page comes from