SoSFString(3)

💖 SoSFString 💖

okay bestie, gather round, because we're talking about SoSFString from the Coin library — a whole entire manual page, third section of the manual (3), filed under Library Functions Manual. she's a container, she holds one string, and she's lowkey iconic. let's get into it 🎀

---

✨ NAME ✨

SoSFString — the SoSFString class is a container for an SbString.

---

🦋 SYNOPSIS 🦋

#include <Inventor/fields/SoSFString.h>

Inherits SoSField.

👑 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 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 💜

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=1)
virtual void evaluateConnection (void) const
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const

---

🍓 Detailed Description 🍓

The SoSFString class is a container for an SbString. periodt.

So basically, this field is what you reach for when nodes, engines, or other field containers need to store a single string. one string. that's the whole job. and she does it flawlessly 💅

And here's a lil detail that matters: fields of this type store their value to file as the string, wrapped up in quotes. so when you peek at the file, expect "quotes", bestie.

See also

• SoMFString

---

🔥 Member Function Documentation 🔥

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's giving "who am I, really?" but for types 🦋

See also

• getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field — no mixing, no mashups, no "close enough". 🙈

Implements SoField.

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

Check for equal type and value(s). yes bestie, type and value. both. 🎀

Implements SoField.

void SoSFString::setValue (const char * str)

Set string field value from str. that's it, that's the function. short queen. 👑

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. she was born in a doc generator and she's thriving ✨

---

and that's the whole page, bestie!! no notes, ate and left no crumbs 💖

so this manual page came from Coin, Version 2.5.0 — that's the source and the version right there in the footer, and the page itself is SoSFString(3). mwah, bye 🫶🌈