SoSField(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoSField 💖

okay so bestie, welcome to SoSField(3), straight out of the Library Functions Manual ✨ and lemme tell you, this one is foundational. It's the blueprint, the moment, the blueprint-moment. Let's get into it 🫶

✨ NAME ✨

SoSField — the base class for fields that hold exactly one value. Just one. Singular. Solo. Main character energy, no ensemble cast 💅

🌈 SYNOPSIS 🌈

#include <Inventor/fields/SoSField.h>

Inherits SoField.

Inherited by SoSFBool, SoSFBox2d, SoSFBox2f, SoSFBox2i32, SoSFBox2s, SoSFBox3d, SoSFBox3f, SoSFBox3i32, SoSFBox3s, SoSFColor, SoSFColorRGBA, SoSFDouble, SoSFEngine, SoSFEnum, SoSFFloat, SoSFImage, SoSFImage3, SoSFInt32, SoSFMatrix, SoSFName, SoSFNode, SoSFPath, SoSFPlane, SoSFRotation, SoSFShort, SoSFString, SoSFTime, SoSFTrigger, SoSFUInt32, SoSFUShort, SoSFVec2b, SoSFVec2d, SoSFVec2f, SoSFVec2i32, SoSFVec2s, SoSFVec3b, SoSFVec3d, SoSFVec3f, SoSFVec3i32, SoSFVec3s, SoSFVec4b, SoSFVec4d, SoSFVec4f, SoSFVec4i32, SoSFVec4s, SoSFVec4ub, SoSFVec4ui32, and SoSFVec4us.

like, the whole family tree fr fr 😭

💜 Public Member Functions

  • 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
  • virtual SoType getTypeId(void) const =0
  • 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 SbBool isSame(const SoField &f) const =0
  • virtual void copyFrom(const SoField &f)=0
  • 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 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 Member Functions

  • SoSField(void)

🎀 Protected Member Functions inherited from SoField

  • SoField(void)
  • void valueChanged(SbBool resetdefault=TRUE)
  • virtual void evaluateConnection(void) const
  • virtual SbBool readValue(SoInput *in)=0
  • virtual void writeValue(SoOutput *out) const =0
  • virtual SbBool readConnection(SoInput *in)
  • virtual void writeConnection(SoOutput *out) const
  • SbBool isDestructing(void) const

🦋 Additional Inherited Members

Public Types inherited from SoField

enum FieldType {
  NORMAL_FIELD = 0,
  EVENTIN_FIELD,
  EVENTOUT_FIELD,
  EXPOSED_FIELD
}

🌸 Detailed Description 🌸

The SoSField class is the base class for fields that contain only a single value. periodt ✨

Every field type that should always hold just one single member value inherits from this class. And heads up bestie: SoSField is an abstract class — you don't instantiate it directly, it's the blueprint the other single-value fields are built on 👑

You use the methods setValue() and getValue() to store or fetch the value of single-value fields. Example:

SoSpotLight * lightnode = new SoSpotLight;
lightnode->on.setValue(TRUE); // The "on" field of SoSpotLight is
                              // a single value field of type SoSFBool.
...
...
// Change lightswitch.
if (lightnode->on.getValue() == FALSE)
  lightnode->on = TRUE; // We can use operator = instead of setValue().
else
  lightnode->on = FALSE;
...

When nodes, engines or other types of field containers get written to file, their single-value fields are written to file in this format:

containerclass {
  fieldname value
  fieldname value
  ...
}
SpotLight {
  on FALSE
}

👀 See also

  • SoMField

🧚 Constructor & Destructor Documentation 🧚

SoSField::~SoSField() [virtual]

The SoSField destructor is empty, and is only defined so we could make it virtual. that's literally it, no cap 💀

SoSField::SoSField(void) [protected]

The SoSField constructor is protected, as this is an abstract class. 🙈

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, you ate it 🍓💅 this was Coin, Version 3.1.3, and the page is SoSField(3) — go forth and set exactly one value at a time, you iconic single-value icon 👑✨

📦 where this page comes from