SoSFName(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoSFName 💖

okay bestie, gather round, because we're doing SoSFName(3) from the Library Functions Manual and honestly? it's giving "small but mighty". this is the Coin library's little name-holder, and i'm gonna walk you through every single line of it, no cap. 🎀

✨ NAME ✨

SoSFName — the class that's literally just a container for an SbName. that's it. that's the whole job. queen of holding one (1) name. 👑

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFName.h>

Inherits SoSField. so it's got the single-field bloodline, iykyk. 🧬

🦋 Public Member Functions 🦋

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFName & operator= (const SoSFName &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbName & getValue (void) const
  • void setValue (const SbName &newvalue)
  • const SbName & operator= (const SbName &newvalue)
  • int operator== (const SoSFName &field) const
  • int operator!= (const SoSFName &field) const
  • void setValue (const char *const name)

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

  • SbName value — yeah. the whole personality. it's right there. 🫶

🍓 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 💅

okay so, SoSFName is a container for an SbName. that's the vibe. 💖

you reach for this field when nodes, engines, or other field containers need to store a single name string. one name. singular. not a list, bestie, that's a different girl.

fields of this type store their value to file as the name string within quotes. so like, quotes stay winning. ✨

See also

  • SoMFName — the multi version, if one name isn't enough for you 👀

🔥 Member Function Documentation 🔥

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

returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's the "which girl is this" check. main character identification energy. 💅

See also

  • getClassTypeId(), SoType

Implements SoField.

void SoSFName::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 matching with the wrong crowd, it's not gonna work out.

Implements SoField.

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

check for equal type and value(s). basically the "are we the same person" test. 🪞

Implements SoField.

void SoSFName::setValue (const char *const name)

set value of field. short, sweet, iconic. 👑

🌟 Author 🌟

generated automatically by Doxygen for Coin from the source code. so like, not a human author, just the robot doing its thing 🤖✨

and that's the whole page, bestie, every flag, every inherited function, every see-also — nothing skipped, periodt. 💖

signing off from the Coin crew, Version 2.5.0, with the page dated SoSFName(3) in the manual — ily, go hold some names responsibly 🎀🦋💜

📦 where this page comes from