SoFieldConverter(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoFieldConverter(3) 💖

okay bestie, you found the manual page for SoFieldConverter(3) from the Coin library. this is part 1 of 2, so don't go anywhere. we're gonna get into it. 💖

🌸 NAME 🌸

SoFieldConverter — the abstract base class for field converters. periodt.

✨ SYNOPSIS ✨

#include <Inventor/engines/SoFieldConverter.h>

Inherits SoEngine.

so it inherits from SoEngine, no cap. 💅

💅 Public Member Functions 💅

these are the public methods you get on this class. they're giving main character energy.

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • virtual SoField * getInput (SoType type)=0
  • virtual SoEngineOutput * getOutput (SoType type)=0
  • virtual SoField * getConnectedInput (void)
  • int getForwardConnections (SoFieldList &l) const

🎀 Public Member Functions inherited from SoEngine 🎀

these are the ones you get for free from SoEngine. slay.

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 🦋

okay this is a long list but we're not skipping any, bestie. every single one matters.

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
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 *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
void setUserData (void *userdata) const
void * getUserData (void) const

🌈 Public Member Functions inherited from SoBase 🌈

and here's the SoBase squad.

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

oh and btw, isOfType has a little description: it returns TRUE if the type of this object is either of the same type or inherited from type. so there you go. 💅

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static void initClass (void) — this sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. iconic.
  • static void initClasses (void)

💫 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. yes queen.
  • static void initClasses (void)
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. periodt.
  • 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) — 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)
  • 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) — 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)
  • 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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

🛡️ Protected Member Functions 🛡️

  • SoFieldConverter (void)
  • virtual ~SoFieldConverter (void)

🧚 Protected Member Functions inherited from SoEngine 🧚

SoEngine (void)
virtual ~SoEngine (void)
virtual void evaluate (void)=0
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)
  • virtual ~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
virtual SoNotRec createNotRec (void)

🔮 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 💖

okay so here's the tea. SoFieldConverter is the abstract base class for field converters. when fields of different types are attempted connected, the Coin library tries to find a field converter class which can be inserted between them, acting as a filter converting values from the master field to values matching the type of the slave field. it's giving matchmaker energy, fr fr.

if a value type conversion is possible (like between an SoSFFloat field and an SoSFInt32 field, for instance, where we could do a simple typecast for converting the value of one to the other), an SoFieldConverter derived object is inserted. iconic.

this class is the abstract base superclass which all such field converters needs to inherit. no cap.

Coin comes with one built-in field converter class which takes care of all possible field-to-field conversions we know about. this means applications programmers should seldom need to care about this class, it will probably only be useful if you expand the Coin library with your own field type classes. (doing so is considered advanced use of the library.) so if you're not doing that, you can lowkey ignore it. 💅

See also

  • SoDB::addConverter()

🎂 Constructor & Destructor Documentation 🎂

SoFieldConverter::SoFieldConverter (void ) [protected]

default constructor. that's it.

SoFieldConverter::~SoFieldConverter (void ) [protected], [virtual]

default destructor. bye bestie. ✨

🧁 Member Function Documentation 🧁

  • SoType SoFieldConverter::getClassTypeId (void ) [static] — this static method returns the SoType object associated with objects of this class. slay.
  • SoType SoFieldConverter::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. periodt.
  • const SoFieldData ** SoFieldConverter::getInputDataPtr (void ) [static], [protected] — returns the SoFieldData class which holds information about inputs in this engine. 💖
  • const SoEngineOutputData ** SoFieldConverter::getOutputDataPtr (void ) [static], [protected] — returns the SoEngineOutputData class which holds information about the outputs in this engine. 🎀
  • const SoFieldData * SoFieldConverter::getFieldData (void ) const [virtual] — returns the SoFieldData class which holds information about inputs in this engine. reimplemented from SoFieldContainer. 🦋
  • const SoEngineOutputData * SoFieldConverter::getOutputData (void ) const [virtual] — returns the SoEngineOutputData class which holds information about the outputs in this engine. implements SoEngine. 🌈
  • void SoFieldConverter::initClasses (void ) [static] — initializes all field conversions. automatically called from SoFieldConverter::initClass() upon initialization of Coin. ⭐
  • virtual SoField * SoFieldConverter::getInput (SoType type) [pure virtual] — returns input field for the converter engine. must be overridden in non-abstract converter engine classes. 🔥
  • virtual SoEngineOutput * SoFieldConverter::getOutput (SoType type) [pure virtual] — returns output for the converter engine. must be overridden in non-abstract converter engine classes. 💥
  • SoField * SoFieldConverter::getConnectedInput (void ) [virtual] — this method is obsoleted in Coin. it should probably have been private in OIV. 💀
  • int SoFieldConverter::getForwardConnections (SoFieldList & l) const — returns fields which are connected as slaves of the engine output. 👑

and that's part 1, bestie. part 2 is gonna be even more. stay tuned. 👀

✨ AUTHOR ✨

okay so bestie, plot twist: nobody actually sat down and hand-wrote this one. it's Generated automatically by Doxygen for Coin from the source code. so like… the author is literally a documentation generator doing its little robot thing 🫶 the source code is the main character here, doxygen just did its hair and took the pics 💅

and that's a wrap on SoFieldConverter(3) fr fr 🎀 this page came from Coin version 4.0.10, stamped Thu Jun 25 2026 00:00:00 — go forth, convert those fields, and stay iconic 👑💖

📦 where this page comes from