SoCalculator(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 NAME 💖

SoCalculator — General purpose calculator for floats and 3D float vectors. That's the whole entire vibe, bestie. It's the engine that does math for you, with floats and 3D float vectors. slay.

✨ SYNOPSIS ✨

okay so first things first, you gotta include this header, no cap:

#include <Inventor/engines/SoCalculator.h>

Inherits SoEngine.

💅 Public Member Functions 💅

virtual SoType getTypeId (void) const — the type id getter, iconic.
virtual const SoFieldData * getFieldData (void) const — field data pointer, yes bestie.
virtual const SoEngineOutputData * getOutputData (void) const — output data pointer, periodt.
SoCalculator (void) — the constructor, main character energy.

🦋 Public Member Functions inherited from `SoEngine` 🦋

void evaluateWrapper (void) — evaluate wrapper, slay.
virtual int getOutputs (SoEngineOutputList &l) const — get the outputs list.
SoEngineOutput * getOutput (const SbName &outputname) const — get one output by name.
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const — get the output name.
SbBool isNotifying (void) const — are we notifying? iykyk.
virtual void notify (SoNotList *nl) — notify, periodt.
SoEngine * copy (void) const — copy, iconic.
virtual SoFieldContainer * copyThroughConnection (void) const — copy through connection.
SbBool shouldCopy (void) const — should copy?
virtual void writeInstance (SoOutput *out) — write instance.

🌸 Public Member Functions inherited from `SoFieldContainer` 🌸

void setToDefaults (void) — set to defaults.
SbBool hasDefaultValues (void) const — has default values?
SbBool fieldsAreEqual (const SoFieldContainer *container) const — fields are equal?
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copy field values.
SbBool set (const char *const fielddata) — set from field data.
void get (SbString &fielddata) — get field data.
virtual int getFields (SoFieldList &l) const — get fields.
virtual int getAllFields (SoFieldList &l) const — get all fields.
virtual SoField * getField (const SbName &name) const — get field by name.
virtual SoField * getEventIn (const SbName &name) const — get event in by name.
virtual SoField * getEventOut (const SbName &name) const — get event out by name.
SbBool getFieldName (const SoField *const field, SbName &name) const — get field name.
SbBool enableNotify (const SbBool flag) — enable notify.
SbBool isNotifyEnabled (void) const — is notify enabled?
SbBool set (const char *fielddata, SoInput *input) — set with input.
void get (SbString &fielddata, SoOutput *out) — get with output.
virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validate new field value.
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — add write reference.
SbBool getIsBuiltIn (void) const — get is built in.
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copy contents.
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — get fields memory size.
void setUserData (void *userdata) const — set user data.
void * getUserData (void) const — get user data.

🎀 Public Member Functions inherited from `SoBase` 🎀

void ref (void) const — ref.
void unref (void) const — unref.
void unrefNoDelete (void) const — unref no delete.
int32_t getRefCount (void) const — get ref count.
void touch (void) — touch.
SbBool isOfType (SoType type) const — returns TRUE if the type of this object is either of the same type or inherited from type. periodt.
virtual SbName getName (void) const — get name.
virtual void setName (const SbName &newname) — set name.
virtual void startNotify (void) — start notify.
void addAuditor (void *const auditor, const SoNotRec::Type type) — add auditor.
void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove auditor.
const SoAuditorList & getAuditors (void) const — get auditors.
SbBool shouldWrite (void) — should write?
void assertAlive (void) const — assert alive.

🌈 Static Public Member Functions 🌈

static SoType getClassTypeId (void) — get class type id.
static void * createInstance (void) — create instance.
static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

⭐ Static Public Member Functions inherited from `SoEngine` ⭐

static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static void initClasses (void) — init classes.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
static SoEngine * getByName (const SbName &name) — get by name.
static int getByName (const SbName &name, SoEngineList &el) — get by name into list.

💜 Static Public Member Functions inherited from `SoFieldContainer` 💜

static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
static void cleanupClass (void) — cleanup class.
static void initCopyDict (void) — init copy dict.
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — add copy.
static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check copy.
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find copy.
static void copyDone (void) — copy done.

🍓 Static Public Member Functions inherited from `SoBase` 🍓

static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
static void addName (SoBase *const base, const char *const name) — add name.
static void removeName (SoBase *const base, const char *const name) — remove name.
static void incrementCurrentWriteCounter (void) — increment current write counter.
static void decrementCurrentWriteCounter (void) — decrement current write counter.
static SoBase * getNamedBase (const SbName &name, SoType type) — get named base.
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — get named bases.
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read.
static void setInstancePrefix (const SbString &c) — set instance prefix.
static void setTraceRefs (SbBool trace) — set trace refs.
static SbBool getTraceRefs (void) — get trace refs.
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connect route.
static SbBool readRoute (SoInput *input) — read route.

👑 Public Attributes 👑

SoMFFloat a
SoMFFloat b
SoMFFloat c
SoMFFloat d
SoMFFloat e
SoMFFloat f
SoMFFloat g
SoMFFloat h
SoMFVec3f A
SoMFVec3f B
SoMFVec3f C
SoMFVec3f D
SoMFVec3f E
SoMFVec3f F
SoMFVec3f G
SoMFVec3f H
SoMFString expression
SoEngineOutput oa
SoEngineOutput ob
SoEngineOutput oc
SoEngineOutput od
SoEngineOutput oA
SoEngineOutput oB
SoEngineOutput oC
SoEngineOutput oD

🧚 Protected Member Functions 🧚

virtual ~SoCalculator (void) — destructor, bye bestie.
virtual void inputChanged (SoField *which) — input changed.

💀 Protected Member Functions inherited from `SoEngine` 💀

SoEngine (void) — constructor.
virtual ~SoEngine (void) — destructor.
virtual SbBool readInstance (SoInput *in, unsigned short flags) — read instance.
void writeOutputTypes (SoOutput *out) — write output types.

🙈 Protected Member Functions inherited from `SoFieldContainer` 🙈

SoFieldContainer (void) — constructor.
virtual ~SoFieldContainer () — destructor.

💜 Protected Member Functions inherited from `SoBase` 💜

SoBase (void) — constructor.
virtual ~SoBase () — destructor.
SbBool hasMultipleWriteRefs (void) const — has multiple write refs.
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write header.
void writeFooter (SoOutput *out) const — write footer.
virtual const char * getFileFormatName (void) const — get file format name.
virtual SoNotRec createNotRec (void) — create not rec.

🫶 Static Protected Member Functions 🫶

static const SoFieldData ** getInputDataPtr (void) — get input data ptr.
static const SoEngineOutputData ** getOutputDataPtr (void) — get output data ptr.

🌟 Static Protected Member Functions inherited from `SoEngine` 🌟

static const SoFieldData ** getInputDataPtr (void) — get input data ptr.
static const SoEngineOutputData ** getOutputDataPtr (void) — get output data ptr.

✨ Static Protected Member Functions inherited from `SoBase` ✨

static uint32_t getCurrentWriteCounter (void) — get current write counter.
static void staticDataLock (void) — static data lock.
static void staticDataUnlock (void) — static data unlock.

💖 Additional Inherited Members 💖

Protected Types inherited from `SoBase`

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the base flags, iykyk.

Protected Attributes inherited from `SoFieldContainer`

SbBool isBuiltIn — protected attribute, slay.

✨ Detailed Description ✨

Okay bestie, listen — this is a general purpose calculator, but make it ✨extra✨. It does floats and 3D float vectors. Both. At the same time. Main character energy fr fr.

Here's the whole vibe: SoCalculator takes the values sitting in its input fields (each one is either a single floating point value or a vector) and uses them as variables in free-form engine expressions, then drops the results onto the output fields. That's it. That's the whole thing. 💅

The engine has sixteen input fields:

eight scalar inputs: a, b, c, d, e, f, g, and h
eight vector inputs: A, B, C, D, E, F, G, and H

And there are eight output fields:

four scalar outputs: oa, ob, oc, and od
four vector outputs: oA, oB, oC, and oD

The expression syntax is quite similar to C/C++, just with a very limited set of keywords and functions. Lowkey cozy.

An example:

oa = a * (0.5 + b) / c

So that multiplies the value in a with the value in b plus 0.5, divides that result with c, and parks the result in oa. 🎀

But here's the important bit — since this is an engine, the expression is only evaluated when someone tries to read the value in oa. Not every time an input changes. Lazy evaluation, and honestly? Relatable. 😭

All inputs are multi-fields, and if there are several values in an input, the expression gets evaluated once for every input field value, and the output creates as many values as there are input field values. Yes bestie, it multiplies out like that. 🔥

If there's more than one input field, and those input fields don't have the same number of values, the engine creates as many output values as the input field with the biggest number of values. And when the index goes out of bounds for some other input field, the last field value gets used. That's the rule, no cap.

Vector expressions are basically the same as scalar expressions. An example:

oA = A + vec3f(1.0, 0.0, 0.0) * B

That takes the vector in A, adds the value in B multiplied with (1,0,0), and drops the result in oA. Slay. 🦋

In addition to regular arithmetics, the SoCalculator syntax also includes some functions.

🌸 Scalar functions 🌸

cos(x) — cosine function (x in radians)
sin(x) — sinus function
tan(x) — tangent function
acos(x) — arc cosine function
asin(x) — arc sinus function
atan(x) — arc tangent function
atan2(y, x) — arc tangent function of two variables (y, x).
cosh(x) — hyperbolic cosine function
sinh(x) — hyperbolic sinus function
tanh(x) — hyperbolic tangent function
sqrt(x) — square root function
pow(x,y) — x raised to the power of y
exp(x) — e to the power of x
log(x) — natural logarithm of x
log10() — base-10 logarithm of x
ceil(x) — rounds x upwards to the nearest integer
floor(x) — rounds x downwards to the nearest integer
fabs(x) — absolute value
fmod(x, y) — remainder of dividing x by y
rand(x) — pseudo-random value between 0 and 1

🧚 Vector functions 🧚

cross(x, y) — cross product of x and y
dot(x,y) — dot product of x and y (returns scalar value)
length(x) — length of x (returns scalar value)
normalize(x) — returns normalized version of x
x[y] — access components in x (y should be a scalar value in the range [0,2])

There are also some named constants that can be used:

MAXFLOAT
MINFLOAT
M_E
M_LOG2E
M_LOG10E
M_LN2
M_PI
M_SQRT2 — sqrt(2)
M_SQRT1_2 — sqrt(1/2)

The only control flow available is the ? operator. An example:

oa = (a > b) ? (a * 0.5) : (b * c)

(The parentheses are not necessary, they're there just to make the example easier to read. Considerate of them honestly 🫶)

In addition to the standard comparison operators (<, >, <=, >=, ==, !=), you can also use && (AND) and || (OR) to combine expression, and the unary ! (NOT) operator.

One final thing worth mentioning are the temporary variables. There exist sixteen temporary variables that can be used in expressions. ta, tb, tc, td, te, tf, tg, and th are scalar variables, and tA, tB, tC, tD, tE, tF, tG, and tH are vector variables. They're usually used when you have more than one expression that should be evaluated in order. ✨

An example with three expressions:

ta = a * b; tb = c + d; tc = e - f
tA = vec3f(ta, tb, tc) + A
oA = tA * B

That example just shows how temporary variables can be used to make your expressions easier to read. And please note — it's possible to have several statements in one expression. You just separate them with semicolons. Periodt. 💅

Here's a simple example of how an SoCalculator engine may be used in an .iv file:

DEF mycamera PerspectiveCamera {
  orientation 1 0 0 1.57
}

DEF headlight DirectionalLight {
  intensity 0.8
  direction 0 0 1
}

Separator {
  # Render a cube not affected by lighting
  LightModel { model BASE_COLOR }
  BaseColor { rgb = Calculator {
                      a = USE headlight . intensity
                      expression [ "oA = vec3f( a, a, a)" ]
                    } . oA }
  Cube {}
}

In the example, the color of the Cube is a function of the intensity of the DirectionalLight, even though the Cube is rendered without lighting because of the BASE_COLOR LightModel. It's giving sneaky little dependency, and we're obsessed. 😌

🎀 Constructor & Destructor Documentation 🎀

`SoCalculator::SoCalculator (void )`

Constructor. ✨

`SoCalculator::~SoCalculator (void )` [protected], [virtual]

Destructor. 💀

👑 Member Function Documentation 👑

`SoType SoCalculator::getClassTypeId (void )` [static]

This static method returns the SoType object associated with objects of this class.

`SoType SoCalculator::getTypeId (void ) const` [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

`const SoFieldData ** SoCalculator::getInputDataPtr (void )` [static], [protected]

Returns the SoFieldData class which holds information about inputs in this engine.

`const SoEngineOutputData ** SoCalculator::getOutputDataPtr (void )` [static], [protected]

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

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

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoFieldContainer.

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

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Implements SoEngine.

`void * SoCalculator::createInstance (void )` [static]

Creates a new instance of the class type corresponding to the SoType object.

`void SoCalculator::inputChanged (SoField * which)` [protected], [virtual]

Called when an input is changed. The default method does nothing, but subclasses may override this method to do The Right Thing when a specific field is changed. 🫡

Reimplemented from SoEngine.