SoBoolOperation(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

SoBoolOperation — the engine that evaluates expressions of boolean logic 💅 no cap, it's literally a little logic machine.

okay so this page lives in the Library Functions Manual, and it's all about one very cute engine. let's get into it 🫶

🦋 SYNOPSIS 🦋

#include <Inventor/engines/SoBoolOperation.h>

Inherits SoEngine. 💖

🎀 Public Types 🎀

enum Operation { CLEAR, SET, A, NOT_A, B, NOT_B, A_OR_B, NOT_A_OR_B,
    A_OR_NOT_B, NOT_A_OR_NOT_B, A_AND_B, NOT_A_AND_B, A_AND_NOT_B,
    NOT_A_AND_NOT_B, A_EQUALS_B, A_NOT_EQUALS_B }

✨ Public Member Functions ✨

virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const
SoBoolOperation ()

🌸 Public Member Functions inherited from SoEngine 🌸

void evaluateWrapper (void)
virtual int getOutputs (SoEngineOutputList &l) const
SoEngineOutput * getOutput (const SbName &outputname) const
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname)
    const
SbBool isNotifying (void) const
virtual void notify (SoNotList *nl)
SoEngine * copy (void) const
virtual SoFieldContainer * copyThroughConnection (void) const
SbBool shouldCopy (void) const
virtual void writeInstance (SoOutput *out)

💜 Public Member Functions inherited from SoFieldContainer 💜

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=0)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
void setUserData (void *userdata) const
void * getUserData (void) const

🦋 Public Member Functions inherited from SoBase 🦋

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
virtual void startNotify (void)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass ()

🌈 Static Public Member Functions inherited from SoEngine 🌈

static void initClass (void)
static void initClasses (void)
static SoType getClassTypeId (void)
static SoEngine * getByName (const SbName &name)
static int getByName (const SbName &name, SoEngineList &el)

🍓 Static Public Member Functions inherited from SoFieldContainer 🍓

static void initClass (void)
static SoType getClassTypeId (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)

🧚 Static Public Member Functions inherited from SoBase 🧚

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *in)

👑 Public Attributes 👑

SoMFBool a
SoMFBool b
SoMFEnum operation
SoEngineOutput output
SoEngineOutput inverse

💅 Protected Member Functions 💅

~SoBoolOperation ()

🌸 Protected Member Functions inherited from SoEngine 🌸

SoEngine (void)
virtual ~SoEngine ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void inputChanged (SoField *which)
void writeOutputTypes (SoOutput *out)

💖 Protected Member Functions inherited from SoFieldContainer 💖

SoFieldContainer (void)
~SoFieldContainer ()

🦋 Protected Member Functions inherited from SoBase 🦋

SoBase (void)
virtual ~SoBase ()
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine)
    const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

✨ Static Protected Member Functions ✨

static const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

💜 Static Protected Member Functions inherited from SoEngine 💜

static const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

🌈 Static Protected Member Functions inherited from SoBase 🌈

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🎀 Additional Inherited Members 🎀

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

💖 Detailed Description 💖

The SoBoolOperation engine evaluates expressions of boolean logic. it's giving "logic gate but make it a Coin engine" 🧠✨

The multivalue fields SoBoolOperation::a and SoBoolOperation::b are combined according to the operations set in SoBoolOperation::operation, with the resulting TRUE or FALSE value set on SoBoolOperation::output. literally that's the whole vibe: you feed it booleans, it does math on them, it hands you back the answer 🫶

🍓 Member Enumeration Documentation 🍓

🌸 enum `SoBoolOperation::Operation` 🌸

Enumeration of available boolean logic operators. here's every single one, bestie, no skipping 💅

Enumerator

CLEAR — always set SoBoolOperation::output to FALSE, no matter the input values. it does not care. it will not be moved. 💀
SET — always set SoBoolOperation::output to TRUE, no matter the input values. same energy, opposite direction 👑
A — Output result = SoBoolOperation::a
NOT_A — Output result = ! SoBoolOperation::a
B — Output result = SoBoolOperation::b
NOT_B — Output result = ! SoBoolOperation::b
A_OR_B — r = a || b
NOT_A_OR_B — r = !a || b
A_OR_NOT_B — r = a || !b
NOT_A_OR_NOT_B — r = !a || !b
A_AND_B — r = a && b
NOT_A_AND_B — r = !a && b
A_AND_NOT_B — r = a && !b
NOT_A_AND_NOT_B — r = !a && !b
A_EQUALS_B — r = a==b
A_NOT_EQUALS_B — r = ! a==b

🧚 Constructor & Destructor Documentation 🧚

💜 `SoBoolOperation::SoBoolOperation (void )` 💜

Default constructor. the classic, the icon, the one that sets everything up for you ✨

References A, a, A_AND_B, A_AND_NOT_B, A_EQUALS_B, A_NOT_EQUALS_B, A_OR_B, A_OR_NOT_B, B, b, CLEAR, inverse, NOT_A, NOT_A_AND_B, NOT_A_AND_NOT_B, NOT_A_OR_B, NOT_A_OR_NOT_B, NOT_B, operation, output, SET, and SoBoolOperation().

Referenced by getFieldData(), and SoBoolOperation().

💜 `SoBoolOperation::~SoBoolOperation ()` [protected] 💜

Destructor. saying bye to your little logic engine 🥲

⭐ Member Function Documentation ⭐

🌟 `SoType SoBoolOperation::getTypeId (void ) const` [virtual] 🌟

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. iykyk 🎯

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. so like, yes you do have to do the homework, bestie 📚

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

🌟 `const SoFieldData * SoBoolOperation::getFieldData (void ) const` [virtual] 🌟

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. simple as that 💅

Reimplemented from SoFieldContainer.

References SoBoolOperation().

🌟 `const SoEngineOutputData * SoBoolOperation::getOutputData (void ) const` [virtual] 🌟

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like, not your problem unless you're doing deep library stuff 🙈

Implements SoEngine.