SoSFBool(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

okay so bestie, listen — SoSFBool is a container for an SbBool value. That's it, that's the whole personality. One (1) boolean. Living its little single-value life. ✨

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFBool.h>

Inherits SoSField. 👑

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFBool & operator= (const SoSFBool &field)
  • virtual SbBool isSame (const SoField &field) const
  • SbBool getValue (void) const
  • void setValue (SbBool newvalue)
  • SbBool operator= (SbBool newvalue)
  • int operator== (const SoSFBool &field) const
  • int operator!= (const SoSFBool &field) 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 🎀

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

Okay so real talk: the SoSFBool class is a container for an SbBool value.

This field is the main character whenever nodes, engines or other field containers need to store a boolean on/off or TRUE/FALSE value — like for instance as the "on" field of the SoPointLight, SoSpotLight and SoDirectionalLight node classes. Lights literally cannot turn themselves on without it. Slay. 💡✨

🫶 See also

SoMFBool — the multi-value version, for when one boolean just isn't enough energy for you.

💅 Member Function Documentation 💅

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. Basically it's the field's little ID card. 🪪

See also

getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. Heads up bestie — f must be of the same type as this field. No mixing, no matching, no exceptions. 🙈

Implements SoField.

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

Check for equal type <em>and</em> value(s). A little vibe check, if you will. 💅

Implements SoField.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. (Not a human, not a bestie — a documentation generator. Respect tho. 🫡)

and that's the whole page, no cap. This was Coin, Version 2.5.0, manual page SoSFBool(3) — part of the Library Functions Manual. go forth and boolean responsibly 💖✨🎀🦋

📦 where this page comes from