SoSFString(3)

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

✨ SoSFString — bestie edition ✨

okay so welcome to the SoSFString page in the Coin manual, and yes we're doing this together 💖

🌸 NAME 🌸

SoSFString — it's literally just a lil container for an SbString, no cap.

🎀 SYNOPSIS 🎀

#include <Inventor/fields/SoSFString.h>

It inherits from SoSField. Family tree moment 🫶

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFString & operator= (const SoSFString &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbString & getValue (void) const
  • void setValue (const SbString &newvalue)
  • const SbString & operator= (const SbString &newvalue)
  • int operator== (const SoSFString &field) const
  • int operator!= (const SoSFString &field) const
  • void setValue (const char *str)

🦋 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 defaultVal)
  • SbBool isDefault (void) const
  • SbBool isOfType (const SoType type) const
  • void enableConnection (SbBool flag)
  • SbBool isConnectionEnabled (void) const
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
  • void disconnect (SoEngineOutput *engineoutput)
  • SbBool isConnectedFromEngine (void) const
  • SbBool getConnectedEngine (SoEngineOutput *&master) const
  • SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
  • SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
  • 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 *input, 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 void atexit_cleanup (void)

💜 Static Public Member Functions inherited from SoField 💜

  • static void initClass (void)
  • static void initClasses (void)
  • static void cleanupClass (void)
  • static SoType getClassTypeId (void)

🔥 Protected Attributes 🔥

  • SbString 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=TRUE)
    • virtual void evaluateConnection (void) const
    • virtual SbBool readConnection (SoInput *in)
    • virtual void writeConnection (SoOutput *out) const
    • SbBool isDestructing (void) const
    • virtual SoNotRec createNotRec (SoBase *cont)

👑 Detailed Description 👑

The SoSFString class is a container for an SbString. That's the whole vibe 💅

So when nodes, engines, or any other field container needs to hold onto one single string, this is the field it reaches for. Just one. Singular. Main character energy ✨

And like — fields of this type store their value to file as a the string within quotes. (yes, keeping that phrasing fr fr, quotes go brrr 🎀)

See also

  • SoMFString — the multi-string sibling, iykyk 🦋

💖 Member Function Documentation 💖

void * SoSFString::createInstance (void ) [static]

okay so this API member is considered internal to the library, since it's not likely to be of interest to the application programmer. Not me telling you to skip it, just telling you what the page says 🙈

It creates a new instance of the class type corresponding to the SoType object. Slay, I guess.

SoType SoSFString::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. The ID check ✅

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

Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and "downward" casting. Basically: "what even are you" but for objects, and it answers correctly 💅

Implements SoField.

void SoSFString::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 substitutions, periodt.

Implements SoField.

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

Check for equal type and value(s). Both. Not just one. Both 🫶

Implements SoField.

void SoSFString::initClass (void ) [static]

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system. Behind-the-scenes iconic behaviour ✨

void SoSFString::setValue (const char * str)

Set string field value from str. That's it, that's the function 🎀

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not a human, just a very diligent robot 🧚

okay that's the whole page bestie, tysm for reading 💖 this was Coin manual page SoSFString(3), Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — go forth and string responsibly, ily, bye 👑✨

📦 where this page comes from