SoSFBox2s(3)

πŸ“¦ version 2.5.0, in fedora 43, fedora 44

🌸 SoSFBox2s 🌸

okay bestie, welcome to the SoSFBox2s page πŸ’– this is from the Library Functions Manual and it's lowkey one of the cutest little container classes out there. sit down, grab a strawberry πŸ“, we're doing this.


✨ NAME ✨

SoSFBox2s β€” the SoSFBox2s class is a container for an SbBox2s vector. that's it, that's the whole vibe πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/fields/SoSFBox2s.h>

Inherits SoSField. yes queen, it's in the family tree πŸ‘‘

πŸ’œ 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

virtual ~SoField ()
void setIgnored (SbBool ignore)
SbBool isIgnored (void) const
void setDefault (SbBool def)
SbBool isDefault (void) const
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0)
SbBool appendConnection (SoField *master, SbBool notnotify=0)
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 *in, 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 Public Member Functions inherited from SoField

static void initClass (void)
static void initClasses (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=1)
virtual void evaluateConnection (void) const
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const

πŸŽ€ Detailed Description πŸŽ€

The SoSFBox2s class is a container for an SbBox2s vector. no cap, that's literally its whole job and it does it flawlessly πŸ’–

This field is used where nodes, engines or other field containers needs to store a box. it's giving "storage unit but make it glamorous" 🎁

heads up bestie!! be aware that 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 this on the OGs, it's gonna be a no. πŸ’€

Since: Coin 2.5 🌈


🫢 Member Function Documentation 🫢

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's the lil ID card your field carries around so everyone knows exactly who it is πŸͺͺ✨

See also: getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field. matching types only, bestie, we don't do mismatches here πŸ’…

Implements SoField.

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

Check for equal type and value(s). twin check fr fr πŸ‘―

Implements SoField.

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

Set value of vector. give it the four corners and she's set 🎯

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

Set value of vector. min vector + max vector = a whole mood πŸ¦‹

⭐ void SoSFBox2s::getValue (SbBox2s & box) const

Set value of vector. yes the description says "set" but the function is literally getValue, that's just what the docs say, i don't make the rules πŸ™ˆ


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. so technically not a human author, just robot magic doing its thing πŸ€–βœ¨


and that's the whole page, bestie!! 🫢 this was Coin, Version 2.5.0, filed under SoSFBox2s(3) β€” slay, ate, no crumbs left. go forth and store your boxes πŸ’–πŸŒΈπŸ’…

πŸ“¦ where this page comes from