SoSFShort(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoSFShort 💖

okay bestie, welcome to SoSFShort(3) — that's the Library Functions Manual, and today's main character is the SoSFShort class. She's a container for a short integer value, and honestly? she's iconic for it. no cap. 🫶

✨ NAME ✨

SoSFShort — the class that is a container for a short integer value. one (1) lil short int, held tenderly, protected at all costs. 🌸

🌈 SYNOPSIS 🌈

#include <Inventor/fields/SoSFShort.h>

Inherits SoSField.

👑 Public Member Functions 👑

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFShort & operator= (const SoSFShort &field)
  • virtual SbBool isSame (const SoField &field) const
  • short getValue (void) const
  • void setValue (short newvalue)
  • short operator= (short newvalue)
  • int operator== (const SoSFShort &field) const
  • int operator!= (const SoSFShort &field) const

🦋 Public Member Functions inherited from SoSField 🦋

  • virtual ~SoSField ()

🧚 Public Member Functions inherited from SoField 🧚

these are the hand-me-downs, and there are a LOT of them. she got them all from SoField, and we're listing every single one because that's just what we do here 💅

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

  • short value — yes bestie, that's the whole vibe right there. the short. 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=1)
  • virtual void evaluateConnection (void) const
  • virtual SbBool readConnection (SoInput *in)
  • virtual void writeConnection (SoOutput *out) const
  • SbBool isDestructing (void) const

🌸 DETAILED DESCRIPTION 🌸

So SoSFShort is literally just a container for a short integer value. that's the whole job description. 🎀

She shows up whenever nodes, engines or other field containers need to store a single short integer value. one short. singular. that's her moment.

See also

  • SoMFShort

(it's giving "single field, multi field, sisters" energy, and we love that for them 🦋)

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also

  • getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

lowkey important: f must be the same type as this field. don't be out here copy-pasting from a random other field type, bestie, that's not the move 🙈

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

Check for equal type and value(s).

Implements SoField.

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, babe! this was SoSFShort(3) from Coin, Version 2.5.0 — thank you for coming to my ted talk, go forth and hold exactly one short integer with main character energy 💅✨

📦 where this page comes from