SoSFColor(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 NAME 💖

SoSFColor — the manual page for SoSFColor(3), bestie. It's a lil container that holds exactly one SbColor value. That's it. That's the whole vibe. ✨

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFColor.h>

Inherits SoSField. It's giving inheritance, periodt. 👑

🎀 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFColor & operator= (const SoSFColor &field)
  • virtual SbBool isSame (const SoField &field) const
  • const SbColor & getValue (void) const
  • void setValue (const SbColor &newvalue)
  • const SbColor & operator= (const SbColor &newvalue)
  • int operator== (const SoSFColor &field) const
  • int operator!= (const SoSFColor &field) const
  • void setValue (const SbVec3f &vec)
  • void setValue (float red, float green, float blue)
  • void setValue (const float rgb[3])
  • void setHSVValue (float h, float s, float v)
  • void setHSVValue (const float hsv[3])

🫶 Public Member Functions inherited from SoSField

  • virtual ~SoSField ()

💅 Public Member Functions inherited from SoField

Like, all of these come along for the ride because SoField is the mother of the whole field family:

  • 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

  • SbColor value — yeah, the actual color lives right here. Iconic.

🧚 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

🌸 DESCRIPTION 🌸

OK so listen. The SoSFColor class is a container for an SbColor value. Simple, elegant, main character energy.

You use this field whenever a node, an engine, or literally any other field container needs to store one single color value — meaning Red + Green + Blue. Not a whole palette. Just one. One gorgeous color. 💅

Fields of this type store their value to file as a "R G B" triple component, where each color component value is between 0.0 and 1.0. No cap.

See also:

  • SoMFColor — the multi-color cousin, if you're feeling extra 🦋

💜 MEMBER FUNCTION DOCUMENTATION 💜

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

Hands you the type identification instance that uniquely identifies which Coin field class this object belongs to. iykyk.

See also:

  • getClassTypeId(), SoType

Implements SoField.

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

Copies the value(s) from f into this field. Heads up bestie: f must be of the same type as this field, fr fr.

Implements SoField.

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

Checks for equal type and equal value(s). Both, or it's a no from her.

Implements SoField.

void SoSFColor::setValue (const SbVec3f & vec)

Sets the color value from a vector with three elements. The three elements get interpreted as red, green and blue, respectively. In that order, always. 🍓

void SoSFColor::setValue (float red, float green, float blue)

Sets the color value from red, green and blue. Value range for each component is between 0.0 and 1.0.

void SoSFColor::setValue (const float rgb[3])

Sets the color value from a floating point number array with three elements. The three elements get interpreted as red, green and blue, respectively. Again — same order. Consistency is a love language. ✨

void SoSFColor::setHSVValue (float h, float s, float v)

Sets the color value from h, s and v, where h is "hue", s is "saturation" and v is "value".

void SoSFColor::setHSVValue (const float hsv[3])

Sets the color value from a floating point number array with three elements. The three elements get interpreted as hue, saturation and value, respectively. HSV girlies, this one's for you. 🎀

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. Not me writing a single word by hand, the robot did it. Slay, Doxygen.

okay that's the whole page, you understood all of it, I'm so proud of you 🫶

This was Coin, Version 3.1.3, and the page was SoSFColor(3) — go forth and store exactly one color, bestie. 💖✨🎀🦋🌸

📦 where this page comes from