SBNAME(3iv)

💖 SbName — the character string that lives in a hash table 💖

okay so bestie, welcome to SbName(3IV) — yes that's the manual page name, yes I'm folding it in right here at the top, you're welcome. It's giving ✨string but make it interned✨. Let's get into it.

🌸 NAME 🌸

SbName — character string stored in a hash table 🗂️✨

🦋 INHERITS FROM 🦋

SbName

(yeah she inherits from herself, main character energy only, no cap 👑)

✨ SYNOPSIS ✨

#include <Inventor/SbString.h>

Methods from class SbName:

                     SbName()
                     SbName(const char *s)
                     SbName(const SbString &s)
                     SbName(const SbName &n)
                     ~SbName()
 const char *        getString() const
 int                 getLength() const
 static SbBool       isIdentStartChar(char c)
 static SbBool       isIdentChar(char c)
 int                 operator !() const
 int                 operator ==(const char *s, const SbName &n)
 int                 operator ==(const SbName &n1, const SbName &n2)
 int                 operator ==(const SbName &n, const char *s)
 int                 operator !=(const char *s, const SbName &n)
 int                 operator !=(const SbName &n1, const SbName &n2)
 int                 operator !=(const SbName &n, const char *s)

💅 DESCRIPTION 💅

so like, this class of strings stores the string in a hash table. It's used by the Inventor toolkit for keywords and other unique names. It is not recommended for general use — only in the context of Inventor objects, bestie, stay in your lane 🫶.

When a string is stored in this table, a pointer to the storage is returned. Two identical strings will return the same pointer. This means that comparison of two SbNames for equality can be accomplished by comparing their identifiers. SbNames are used for strings which are expected to show up frequently, such as node names. literally the interned-string trick before it was cool 💀✨

🎀 METHODS 🎀

                     SbName()
                     SbName(const char *s)
                     SbName(const SbString &s)
                     SbName(const SbName &n)
                     ~SbName()

Constructors and destructor. birth, birth, birth, birth, and the lil goodbye 🥹

• const char * getString() const — Returns pointer to the character string. just handin' you the pointer, no drama ✨
• int getLength() const — Returns length of string. how many characters, fr fr 📏
• static SbBool isIdentStartChar(char c) — Returns TRUE if given character is a legal starting character for an identifier. (starters only, this char has to be first 🥇)
• static SbBool isIdentChar(char c) — Returns TRUE if given character is a legal nonstarting character for an identifier. (so like, allowed, but NOT allowed to go first — know your role 💅)
• int operator !() const — Unary "not" operator; returns TRUE if string is empty (""). not me checking if you're empty 🙈
• int operator ==(const char *s, const SbName &n) int operator ==(const SbName &n1, const SbName &n2) int operator ==(const SbName &n, const char *s) — Equality operator for SbName/char* and SbName/SbName comparison. are y'all the same?? 👯‍♀️
• int operator !=(const char *s, const SbName &n) int operator !=(const SbName &n1, const SbName &n2) int operator !=(const SbName &n, const char *s) — Inequality operator for SbName/char* and SbName/SbName comparison. and are y'all NOT the same?? 💀

🌈 SEE ALSO 🌈

SbString

bestie reminder: SbNames are for strings that show up frequently — node names, keywords, the usual suspects. Don't be out here using it for random general-purpose strings, it's not built for that 🫶

k bye, this has been SbName(3IV) from the Inventor toolkit docs, 3IV edition, no date on the page so we're just gonna say "timeless" 💅✨ stay interned, stay iconic, periodt 🎀🦋