SoSFString(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

SoSFString — bestie, it's a container for an SbString 🎀

🦋 SYNOPSIS 🦋

okay so first things first, this page is SoSFString(3) from the Library Functions Manual, and here's how you pull it in:

#include <Inventor/fields/SoSFString.h>

It 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 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

💖 DETAILED DESCRIPTION 💖

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

So like, whenever a node, an engine, or literally any other field container needs to hold onto one single string, this is the field that shows up. it's giving "one string, one vibe" 🫶

And when a field of this type writes its value out to a file, it stores it as the string wrapped in quotes. so cute, so quotable 💅

🔍 See also

  • SoMFString

📝 MEMBER FUNCTION DOCUMENTATION 📝

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

Hands you the type identification instance — the one that uniquely identifies which Coin field class your object belongs to. iykyk ✨

See also: getClassTypeId(), SoType

Implements SoField.

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

Copies the value(s) out of f and into this field. bestie, f has to be the same type as this field, no exceptions 😭

Implements SoField.

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

Checks whether the type and the value(s) match. same type + same value = TRUE, slay 🔥

Implements SoField.

void SoSFString::setValue (const char * str)

Sets the string field's value from str. that's it, that's the whole job 💜

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. not a human, just vibes 🌸

okay bestie that's the whole page, ily, go forth and store exactly one string 💖 this was SoSFString(3) from Coin, Version 3.1.3 — signing off, mwah 🎀✨🦋

📦 where this page comes from