SoSFImage3(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

SoSFImage3 — bestie, this class is where you store 3D (volume) images. That's it, that's the whole job. 🧊✨

🌸 SYNOPSIS 🌸

So this lives in the library functions manual, section 3, and here's how you pull it in:

#include <Inventor/fields/SoSFImage3.h>

And it inherits SoSField 👑 (which itself goes all the way back up to SoField, so there's a whole family tree of stuff you get for free).

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFImage3 & operator= (const SoSFImage3 &field)
  • virtual SbBool isSame (const SoField &field) const
  • const unsigned char * getValue (SbVec3s &size, int &nc) const
  • void setValue (const SbVec3s &size, const int nc, const unsigned char *bytes)
  • int operator== (const SoSFImage3 &field) const
  • int operator!= (const SoSFImage3 &field) const
  • unsigned char * startEditing (SbVec3s &size, int &nc)
  • void finishEditing (void)

🫶 Public Member Functions inherited from SoSField

  • virtual ~SoSField ()

🫶 Public Member Functions inherited from SoField

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

🦋 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 💅

Okay so SoSFImage3? It's the class you use to store 3D (volume) images. Periodt. 💖

It gives you storage for inline 3D image maps. And like, what are 3D images in Coin even for? Mainly 3D texture mapping support. That's the whole vibe. 🧊

SoSFImage3 instances can be exported and imported just like any other field class in Coin. Slay, portable. ✈️

The components of an SoSFImage3 are literally:

  • its image dimensions — width, height and depth
  • the number of bytes used for describing each pixel (that's the number of components)
  • and an associated pixel buffer

And the size of that pixel buffer? It's width*height*depth*components. Math, bestie. 🔢

For texture maps, the components / bytes-per-pixel setting translates like this:

  • 1 → a grayscale imagemap
  • 2 → grayscale + opacity (i.e. an alpha value)
  • 3 → RGB (1 byte each for red, green and blue)
  • 4 components → 3 bytes for RGB + 1 byte opacity value (aka RGBA) 💅

This field is serializable into the Inventor / Coin file format in the following manner:

FIELDNAME X Y Z C 0xRRGGBBAA 0xRRGGBBAA ...

"X", "Y" and "Z" are the image dimensions along the given axes, and "C" is the number of components in the image. The number of 0xRRGGBBAA pixel color specifications needs to equal the exact number of pixels, which is X*Y*Z. Each part of the pixel color value is in the range 0x00 to 0xff (hexadecimal, 0 to 255 decimal). 🔥

For 3-component images, the pixel-format is 0xXXRRGGBB, where the byte in the pixel color value marked as "XX" is ignored and can be left out.

For 2-component images, the pixel-format is 0xXXXXGGAA, where the bytes in the pixel color values marked as "XX" are ignored and can be left out. "GG" is the part which gives a grayscale value and "AA" is for opacity.

For 1-component images, the pixel-format is 0xXXXXXXGG, where the bytes in the pixel color values marked as "XX" are ignored and can be left out.

The pixels are read as being ordered in rows along X (width), columns along Y (height, bottom to top) and Z "planes" (depth, front to back). Keep that order in mind, bestie, it matters. 👀

Here's a simple example of the file format serialization, for a 2x2x2 RGB-image inside an SoTexture3 node:

Texture3 {
       images 2 2 2 3

       0x000000 0x00ff00
       0xff0000 0xffff00

       0x000000 0x0000ff
       0x00ff00 0x00ffff
}

The image above is colored black+green on the first line and red+yellow on the second line in the first Z plane. The second Z plane is colored black+blue on the first line and green+cyan on the second line. 🌈✨

⚠️ Heads up! Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. So don't go looking for it there, she's not home. 💀

👀 See also

SoTexture3, SoSFImage

🎀 Since

  • Coin 2.0
  • TGS Inventor 2.6

🧚 Member Function Documentation 🧚

🌟 SoType SoSFImage3::getTypeId (void ) const [virtual]

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. It's giving ✨identity✨.

See also: getClassTypeId(), SoType

Implements SoField.

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

Copy value(s) from f into this field. And f must be of the same type as this field, no mixing bestie. 🙅

Implements SoField.

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

Check for equal type and value(s). Both, not just one. 👑

Implements SoField.

🌟 const unsigned char * SoSFImage3::getValue (SbVec3s & size, int & nc) const

Return the pixel buffer, set size to contain the image dimensions and nc to the number of components in the image. Three things at once, multitasking queen. 💅

🌟 void SoSFImage3::setValue (const SbVec3s & size, const int nc, const unsigned char * bytes)

Initialize this field to size and nc.

If bytes is not NULL, the image data is copied from bytes into this field. If bytes is NULL, the image data is cleared by setting all bytes to 0.

⚠️ Note that the behavior on passing a NULL pointer is specific for Coin — Open Inventor will crash if you try it. So like, don't. 😭💀

References SoField::valueChanged().

🌟 int SoSFImage3::operator== (const SoSFImage3 & field) const

Compare image of field with the image in this field and return TRUE if they are equal. ✅

🌟 int SoSFImage3::operator!= (const SoSFImage3 & field) const [inline]

Compare image of field with the image in this field and return FALSE if they are equal. (Yes, FALSE. That's the whole bit. 🙈)

References SoField::operator==().

🌟 unsigned char * SoSFImage3::startEditing (SbVec3s & size, int & nc)

Return the pixel buffer, set size to contain the image dimensions and nc to the number of components in the image.

👑 Important: the field's container will not be notified about the changes until you call finishEditing(). So don't forget, or nobody will know you did anything.

🌟 void SoSFImage3::finishEditing (void )

Notify the field's auditors that the image data has been modified. You did the edit, now you gotta announce it. 📣

References SoField::valueChanged().

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. Not me, bestie, the robot did it. 🤖✨

okay that's the whole page, you're so welcome 🫶 This is from Coin, Version 2.5.0, manual page SoSFImage3(3) in the Library Functions Manual — go forth and texture your volumes, main character. 💖🎀🦋🌈⭐👑💅

📦 where this page comes from