SoSFName(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoSFName 💖

okay bestie, welcome to SoSFName(3) — this is the Library Functions Manual page for SoSFName, and it's a whole vibe. It's the class that's just a lil container for an SbName. That's it. That's the girl. 🎀

✨ NAME ✨

SoSFName — a container for an SbName. lowkey simple, highkey essential. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFName.h>

Inherits SoSField. yes she's a single-field girlie, not a multi-field mess. 🦋

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

bestie there's a LOT here. she's connected. she's got auditors. she's got opinions. 😭

  • 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

  • SbName value — the actual name, chillin' right there, protected. 🫶

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 🌈

okay so the SoSFName class is a container for an SbName. periodt. 💜

This field is the one you reach for when nodes, engines or other field containers need to store a single name string. just one. not a list. she's monogamous. 👑

Fields of this type store their value to file as the name string within quotes. so when it hits the file, it's all "like this". no cap. ✨

See also

  • SoMFName — the multi-field version, if you're feeling chaotic. 🙈

🎀 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 giving "who am I" but make it type-safe. 💅

See also

  • getClassTypeId(), SoType

Implements SoField.

void SoSFName::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, or it's not gonna go how you want it to. 😭

Implements SoField.

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

Check for equal type and value(s). the vibe check, but for fields. ✅

Implements SoField.

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

Set value of field. that's the whole job description, and she does it flawlessly. 🌟

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. not me being a whole robot-authored baddie. 🤖✨

and that's the page, bestie!! 🫶 this was the SoSFName(3) manual from Coin, Version 3.1.3, and yes it's giving iconic. go forth and name things responsibly. 💖🎀🦋🌸💅👑🌈⭐🍓🧚💜

📦 where this page comes from