SOSFPLANE(3iv)

💖 SoSFPlane(3IV) 💖

okay bestie, sit down, hydrate, because today we're learning about a whole entire field whose only job is holding one (1) plane equation. she's small. she's focused. she's iconic. this is the SoSFPlane manual page, manual section 3IV, and yes we're doing the whole thing, no skipping 🫶

---

✨ NAME ✨

SoSFPlane — a field containing a plane equation. that's it. that's the whole vibe. a single-value field, one plane, no drama 💅

---

🌸 INHERITS FROM 🌸

SoField > SoSField > SoSFPlane

so the family tree goes: SoField is the ancestor, SoSField is the single-value branch, and SoSFPlane is the baby of the family that specifically knows about planes. slay 💖

---

🦋 SYNOPSIS 🦋

#include <Inventor/fields/SoSFPlane.h>

Methods from class SoSFPlane:

static SoType       getClassTypeId()
virtual void        getTypeId() const
const SbPlane &     getValue() const
const SbPlane &     operator =(const SbPlane & newValue)
void                setValue(const SbPlane & newValue)
int                 operator ==(const SoSFPlane &f) const
int                 operator !=(const SoSFPlane &f) const

Methods from class SoField (she inherited these, and honestly they ate):

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 💜

A field containing a plane equation (an SbPlane). so basically it's a little box and inside the box is one plane equation, and she's thriving 💖

here's the tea about how SoSFPlanes get written to file, and this part is important so listen up: they're written as four floating point values separated by whitespace.

1. the first three are the normal direction of the plane ✨
2. the fourth is the distance of the plane from the origin (in the direction of the normal) 🎀

so like... nx ny nz dist, four numbers, whitespace between them, done. that's the whole format. no cap 🫶

---

👑 METHODS 👑

• static SoType getClassTypeId()
• virtual void getTypeId() const

Returns the type for this class, or for a particular object of this class. i.e. "who am i" but for the class, or for the specific object. main character energy tbh 💅

• const SbPlane & getValue() const

Returns this field's value. the plane. the one she's been holding this whole time. give it back 🥺

• const SbPlane & operator =(const SbPlane & newValue)
• void setValue(const SbPlane & newValue)

Sets this field to newValue. so now the field is holding the new plane instead of the old one. glow up achieved ✨

• int operator ==(const SoSFPlane &f) const
• int operator !=(const SoSFPlane &f) const

Returns TRUE if f is of the same type and has the same value as this field. both. same type AND same value. not one or the other. fr fr 💀

---

🌈 SEE ALSO 🌈

SbPlane, SoField, SoSField, SoMFPlane — go read those too bestie, they're all in the same friend group 🦋

---

and that's the whole page!! 🎀 this was SoSFPlane(3IV)() — manual section 3IV, no version or date info beyond that on the page, so that's genuinely all the deets i have. go forth, hold exactly one plane, stay iconic 👑💖✨