SoSFBox2s(3)

🎀 SoSFBox2s 🎀

bestie. sit down. we're talking about SoSFBox2s(3) from the Library Functions Manual, and honestly? it's giving "small class, big job." it's a Coin field class, it holds a box, and it's about to be your new fave. no cap. 💖

---

✨ NAME ✨

SoSFBox2s — the class that is literally a container for an SbBox2s vector. that's it, that's the whole vibe. 🎁

---

🌸 SYNOPSIS 🌸

first things first, you gotta let the compiler know she exists:

#include <Inventor/fields/SoSFBox2s.h>

Inherits SoSField. (so she's got family. she's connected. 💅)

🫶 Public Member Functions

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFBox2s & operator= (const SoSFBox2s &field)
virtual SbBool isSame (const SoField &field) const
const SbBox2s & getValue (void) const
void setValue (const SbBox2s &newvalue)
const SbBox2s & operator= (const SbBox2s &newvalue)
int operator== (const SoSFBox2s &field) const
int operator!= (const SoSFBox2s &field) const
void setValue (short xmin, short ymin, short xmax, short ymax)
void setValue (SbVec2s minvec, SbVec2s maxvec)
void getValue (SbBox2s &box) const

🌈 Public Member Functions inherited from SoSField

virtual ~SoSField ()

💜 Public Member Functions inherited from SoField

okay this is a LOT but we do not skip. every single one. she's thorough and we respect her for it:

virtual ~SoField ()
void setIgnored (SbBool ignore)
SbBool isIgnored (void) const
void setDefault (SbBool defaultVal)
SbBool isDefault (void) const
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE,
    SbBool append=FALSE)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool
    append=FALSE)
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
void disconnect (SoField *field)
SbBool isConnectedFromField (void) const
SbBool getConnectedField (SoField *&master) const
int getNumConnections (void) const
int getForwardConnections (SoFieldList &slavelist) const
int getConnections (SoFieldList &masterlist) const
void disconnect (void)
SbBool isConnected (void) const
void setContainer (SoFieldContainer *cont)
SoFieldContainer * getContainer (void) const
SbBool set (const char *valuestring)
void get (SbString &valuestring)
SbBool shouldWrite (void) const
virtual void touch (void)
virtual void startNotify (void)
virtual void notify (SoNotList *nlist)
SbBool enableNotify (SbBool on)
SbBool isNotifyEnabled (void) const
void addAuditor (void *f, SoNotRec::Type type)
void removeAuditor (void *f, SoNotRec::Type type)
int operator== (const SoField &f) const
int operator!= (const SoField &f) const
virtual void connectionStatusChanged (int numconnections)
SbBool isReadOnly (void) const
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const
void copyConnection (const SoField *fromfield)
virtual SbBool read (SoInput *input, const SbName &name)
virtual void write (SoOutput *out, const SbName &name) const
virtual void countWriteRefs (SoOutput *out) const
void setFieldType (int type)
int getFieldType (void) const
SbBool getDirty (void) const
void setDirty (SbBool dirty)
void evaluate (void) const

⭐ Static Public Member Functions

static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

🦋 Static Public Member Functions inherited from SoSField

static void initClass (void)
static SoType getClassTypeId (void)
static void atexit_cleanup (void)

🍓 Static Public Member Functions inherited from SoField

static void initClass (void)
static void initClasses (void)
static void cleanupClass (void)
static SoType getClassTypeId (void)

👑 Protected Attributes

SbBox2s value

🧚 Additional Inherited Members

Public Types inherited from SoField

enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD,
    EXPOSED_FIELD }

Protected Member Functions inherited from SoSField

SoSField (void)

Protected Member Functions inherited from SoField

SoField (void)
void valueChanged (SbBool resetdefault=TRUE)
virtual void evaluateConnection (void) const
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const

---

💖 Detailed Description 💖

SoSFBox2s is a container for an SbBox2s vector. periodt. 📦

so like, whenever nodes, engines or other field containers need to store a box? this is the field they reach for. she's the storage unit of the Coin universe. 🫶

⚠️ bestie listen up: this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so if you're kicking it old-school, she simply does not exist. 💀

Since — Coin 2.5 ✨

---

🔥 Member Function Documentation 🔥

SoType SoSFBox2s::getTypeId (void ) const [virtual]

hands you back the type identification instance — the thing that uniquely identifies which Coin field class this object belongs to. it's her government name. 💅

See also — getClassTypeId(), SoType

Implements SoField.

void SoSFBox2s::copyFrom (const SoField & f) [virtual]

copies the value(s) from f into this field. 🫶 and like — f must be of the same type as this field, no mixing, no matching with a random. f has to be her type. periodt.

Implements SoField.

SbBool SoSFBox2s::isSame (const SoField & f) const [virtual]

checks for equal type and equal value(s). basically the vibe check. if they don't match, she will know. 🙈

Implements SoField.

void SoSFBox2s::setValue (short xmin, short ymin, short xmax, short ymax)

set value of vector. 🎀

void SoSFBox2s::setValue (SbVec2s minvec, SbVec2s maxvec)

set value of vector. (same energy, different args — you got this.) 🌸

void SoSFBox2s::getValue (SbBox2s & box) const

set value of vector. (yes, the docs literally say "set" here — that's what the original says, and I am NOT editing the source material, that's not the move. 😭)

---

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code. she was written by a robot and raised by the Coin devs. iconic honestly. 🤖💖

---

and that's the whole page bestie!! 🎀✨ this was Coin, Version 3.1.3, and she lives at SoSFBox2s(3). go forth and store your boxes. slay. 💅🦋