SoSFBox2d(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoSFBox2d 💖

okay so bestie, we're doing a whole manual page today and the manual name is SoSFBox2d — it lives in the Library Functions Manual section, section 3, and it is literally just a lil container field. no cap. let's go 🦋

✨ NAME ✨

SoSFBox2d — the SoSFBox2d class is a container for an SbBox2d vector. that's it. that's the whole job. she's a box holder 💅

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFBox2d.h>

Inherits SoSField.

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFBox2d & operator= (const SoSFBox2d &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbBox2d & getValue (void) const
  • void setValue (const SbBox2d &newvalue)
  • const SbBox2d & operator= (const SbBox2d &newvalue)
  • int operator== (const SoSFBox2d &field) const
  • int operator!= (const SoSFBox2d &field) const
  • void setValue (double xmin, double ymin, double xmax, double ymax)
  • void setValue (const SbVec2d &minvec, const SbVec2d &maxvec)
  • void getValue (SbBox2d &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 🎀

  • SbBox2d 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 🦋

The SoSFBox2d class is a container for an SbBox2d vector. periodt.

This field is used where nodes, engines or other field containers needs to store a box. 🎁 like, if your scene graph has a box-shaped secret, this is where she lives.

⚠️ 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 porting back to the O.G., she will not be there. it's giving exclusive. 💅

Since

Coin 2.5 — yeah she's been around a minute, but she's still iconic 👑

💜 Member Function Documentation 💜

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's the vibe check that says "yes, this is that field class, no imposter energy here." 🕵️♀️

See also

getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field. not "similar type," not "spiritually the same type" — the same type. don't try it with a stranger. 😭

Implements SoField.

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

Check for equal type and value(s). both of them. type and value. she is thorough like that 🫶

Implements SoField.

void SoSFBox2d::setValue (double xmin, double ymin, double xmax, double ymax)

Set value of vector. give her four numbers and she's fed ✨

void SoSFBox2d::setValue (const SbVec2d & minvec, const SbVec2d & maxvec)

Set value of vector. this overload wants the min corner and the max corner as vectors instead, because options are self-care 💅

void SoSFBox2d::getValue (SbBox2d & box) const

Set value of vector. yes, the doc really says "set" on a getter — we are reporting the manual faithfully, bestie, don't shoot the messenger 🙈

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. so nobody hand-wrote this, a robot did, and honestly? the robot ate. 🔥

and that's the whole page!! 💖 thanks for reading this far, you're the main character fr fr.

this was brought to you by Coin, Version 3.1.3 — that's the source and the version, straight from the footer, no cap. see you in the next manual, bestie 🦋✨🎀

📦 where this page comes from