SoSFBox2f(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 NAME 🎀

SoSFBox2f — the class that is literally a container for an SbBox2f vector. That's it. That's the whole job bestie 💅

✨ SYNOPSIS ✨

Welcome to the Library Functions Manual corner of the world, where all the Coin header goodness lives 🫶

#include <Inventor/fields/SoSFBox2f.h>

Inherits SoSField.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFBox2f & operator= (const SoSFBox2f &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbBox2f & getValue (void) const
  • void setValue (const SbBox2f &newvalue)
  • const SbBox2f & operator= (const SbBox2f &newvalue)
  • int operator== (const SoSFBox2f &field) const
  • int operator!= (const SoSFBox2f &field) const
  • void setValue (float xmin, float ymin, float xmax, float ymax)
  • void setValue (const SbVec2f &minvec, const SbVec2f &maxvec)
  • void getValue (SbBox2f &box) const

🦋 Public Member Functions inherited from SoSField 🦋

  • virtual ~SoSField ()

🌈 Public Member Functions inherited from SoField 🌈

okay so this is a lot of inherited power, and yes, you get all of it, no cap ✨

  • 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 🍓

  • SbBox2f value — yeah the actual box lives right here, iconic

🌸 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 SoSFBox2f class is a container for an SbBox2f vector. bestie it holds a box. that's the vibe 💅

This field is used where nodes, engines or other field containers needs to store a box.

⚠️ ok so important heads up: 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 SGI-land, this one is not coming with you, sorry babe 😭

Since: Coin 2.5 🌈

👑 Member Function Documentation 👑

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also: getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field. no mixing and matching, fr fr 🙈

Implements SoField.

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

Check for equal type and value(s).

Implements SoField.

void SoSFBox2f::setValue (float xmin, float ymin, float xmax, float ymax)

Set value of vector. four floats, one box, slay ✨

void SoSFBox2f::setValue (const SbVec2f & minvec, const SbVec2f & maxvec)

Set value of vector. min corner, max corner, done 🎀

void SoSFBox2f::getValue (SbBox2f & box) const

Set value of vector. (yes the doc really says "Set" here, we're just the messengers bestie, keeping it exactly as written 💀)

💖 Author 💖

Generated automatically by Doxygen for Coin from the source code. not a human, just a very thorough robot 🫶

and that's the whole page, mwah 💋 — this was Coin, Version 2.5.0, page SoSFBox2f(3), from the Library Functions Manual. go forth and store your boxes, you absolute icon 👑✨

📦 where this page comes from