SoSFBox3s(3)

👑 SoSFBox3s 👑

okay bestie, welcome to the Library Functions Manual page for SoSFBox3s, aka the little field class that holds a whole box for you. pull up a chair, grab a strawberry 🍓, we're doing this.

---

✨ NAME ✨

SoSFBox3s — the class that's literally just a container for an SbBox3s vector. that's it. that's the whole job. and it does it gorgeously. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFBox3s.h>

Inherits SoSField.

💫 Public Member Functions 💫

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFBox3s & operator= (const SoSFBox3s &field)
virtual SbBool isSame (const SoField &field) const
const SbBox3s & getValue (void) const
void setValue (const SbBox3s &newvalue)
const SbBox3s & operator= (const SbBox3s &newvalue)
int operator== (const SoSFBox3s &field) const
int operator!= (const SoSFBox3s &field) const
void setValue (short xmin, short ymin, short zmin, short xmax, short
    ymax, short zmax)
void setValue (const SbVec3s &minvec, const SbVec3s &maxvec)
void getValue (SbBox3s &box) const

🫶 Public Member Functions inherited from SoSField 🫶

virtual ~SoSField ()

🫶 Public Member Functions inherited from SoField 🫶

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 🔒

SbBox3s 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 💖

SoSFBox3s is a container for an SbBox3s vector. no notes. iconic.

this field is what you reach for when nodes, engines, or other field containers need to store a box. 📦 so if you've got a box and you need it stored somewhere official, this is the girl for the job.

⚠️ heads up bestie: 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 out here trying to run it on ancient SGI vibes, it's simply not giving. 😭

Since

Coin 2.0 ✨

---

🧚 Member Function Documentation 🧚

💜 SoType SoSFBox3s::getTypeId (void ) const [virtual]

returns the type identification instance that uniquely identifies the Coin field class this object belongs to. your class's little name tag, if you will. 🏷️

See also

getClassTypeId(), SoType

Implements SoField.

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

copies the value(s) from f into this field. important: f must be the same type as this field, or this is not going to go how you want it to go. 👀

Implements SoField.

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

checks for equal type and equal value(s). both. not one or the other. both. 🎀

Implements SoField.

💜 void SoSFBox3s::setValue (short xmin, short ymin, short zmin, short xmax, short ymax, short zmax)

sets the value of the vector. six numbers, one box. slay.

💜 void SoSFBox3s::setValue (const SbVec3s & minvec, const SbVec3s & maxvec)

sets the value of the vector. this time you hand it a minvec and a maxvec instead of six loose shorts. equally valid, equally cute. 🦋

💜 void SoSFBox3s::getValue (SbBox3s & box) const

sets the value of the vector. (yes, getValue and "sets" — that's what the docs say, and we're reporting it faithfully, bestie. the lore is the lore. 💀)

---

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code. so like, a robot wrote this and i'm just the messenger. 🙈

---

and that's the whole page!! this was Coin, Version 3.1.3, SoSFBox3s(3) — thanks for reading, ily, go store a box. 🫶💖✨