SoSFImage(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoSFImage(3) — Library Functions Manual 💖

✨ NAME ✨

SoSFImage — bestie, this class is literally used to store pixel images. That's the whole point. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFImage.h>

Inherits SoSField.

🎀 Public Types 🎀

  • enum CopyPolicy { COPY, NO_COPY, NO_COPY_AND_DELETE, NO_COPY_AND_FREE }

🦋 Public Types inherited from SoField 🦋

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

✨ Public Member Functions ✨

okay so here's the entire roster, and I mean entire — no skipping, no cap:

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFImage & operator= (const SoSFImage &field)
  • virtual SbBool isSame (const SoField &field) const
  • const unsigned char * getValue (SbVec2s &size, int &nc) const
  • const SbImage & getValue () const
  • void setValue (const SbVec2s &size, const int nc, const unsigned char *pixels, CopyPolicy copypolicy=COPY)
  • int operator== (const SoSFImage &field) const
  • int operator!= (const SoSFImage &field) const
  • unsigned char * startEditing (SbVec2s &size, int &nc)
  • void finishEditing (void)
  • void setSubValue (const SbVec2s &dims, const SbVec2s &offset, unsigned char *pixels)
  • void setSubValues (const SbVec2s *dims, const SbVec2s *offsets, int num, unsigned char **pixelblocks)
  • unsigned char * getSubTexture (int idx, SbVec2s &dims, SbVec2s &offset) const
  • SbBool hasSubTextures (int &numsubtextures)
  • void setNeverWrite (SbBool flag)
  • SbBool isNeverWrite (void) const
  • SbBool hasTransparency (void) const

🫶 Public Member Functions inherited from SoSField 🫶

  • virtual ~SoSField ()

💙 Public Member Functions inherited from SoField 💙

and the SoField inheritance is giving a whole encyclopedia, bestie:

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

🎁 Additional Inherited Members 🎁

🔒 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

💅 Detailed Description 💅

So SoSFImage? It's literally the class that stores pixel images. No cap. 💖

It gives you storage for inline 2D image maps. In Coin, images are mainly used for texture mapping support. That's the vibe.

SoSFImage instances can be exported and imported as any other field class in Coin. Slay.

So the components of an SoSFImage are: its image dimensions (width and height), the number of bytes used for describing each pixel (number of components), and an associated pixel buffer. The size of the pixel buffer will be width*height*components. Math girlie behavior, honestly.

For texture maps, the components / bytes-per-pixel setting translates as follows:

  • 1 — grayscale imagemap
  • 2 — grayscale + opacity (i.e. alpha value)
  • 3 — RGB (1 byte each for red, green and blue)
  • 4 — 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 C 0xRRGGBBAA 0xRRGGBBAA ...

"X" and "Y" are the image dimensions along the given axes, "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 of course is given by X*Y. 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) and columns along Y (height, bottom to top). 🌈

Here's a simple example of the file format serialization, for a 2x2 RGB-image inside an SoTexture2 node, as mapped onto an SoCube:

Complexity { textureQuality 0.1 }   # set low to avoid smoothing

Texture2 {
   image 2 2 4

   0xffffffff 0x00ff0088   # white   semi-transparent green
   0xff0000ff 0xffff00ff   #  red    yellow
}

Cube { }

The mini-scenegraph above results in the following mapping on the cube:

The cube has only been slightly rotated, so as you can see from the snapshot, the Y-rows are mapped from bottom to top, while the X-column pixels are mapped onto the cube from left to right.

👀 See also 👀

  • SoTexture2
  • SoSFImage3

💖 Member Function Documentation 💖

okay bestie, this is the good part — literally every method on SoSFImage, no skips, no cuts, nothing left on read. grab a snack 🍓

🌟 getTypeId

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

hands you back the type identification instance — the lil unique ID badge that says exactly which Coin field class this object belongs to 💅

See also: getClassTypeId(), SoType

Implements SoField.

📋 copyFrom

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

copies the value(s) out of f and into this field. and like — f must be the same type as this field, no mixing allowed, that's the whole rule 🫶

Implements SoField.

🔍 isSame

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

checks for equal type and value(s). both, not just one, okay?

Implements SoField.

🖼️ getValue

const unsigned char * SoSFImage::getValue (SbVec2s & size, int & nc) const

returns the pixel buffer, sets size to hold the image dimensions, and sets nc to the number of components in the image. three-for-one deal, we love to see it ✨

🖼️ getValue (the other one)

const SbImage & SoSFImage::getValue () const

Return values:

  • the SbImage contained by this SoSFImage

🎨 setValue

void SoSFImage::setValue (const SbVec2s & size, const int nc, const unsigned char * pixels, SoSFImage::CopyPolicy copypolicy = COPY)

initializes this field to size and nc. okay so:

  • if pixels is not NULL, the image data gets copied from pixels into this field.
  • if pixels is NULL, the image data is cleared by setting all bytes to 0.
bestie, heads up: that NULL-pointer behavior is specific to Coin. Open Inventor will straight up crash if you try it. not a vibe 😭

The image dimensions come from the size argument, and the nc argument is the number of bytes-pr-pixel. a 24-bit RGB image would for instance have an nc equal to 3. math is mathing ✨

The copypolicy argument is the ✨iconic✨ one — it makes it possible to share image data with SoSFImage without the data being copied, which means using less memory resources. the default is to copy the image data from the pixels source into an internal copy.

⚠️ Important note: if you call this with copypolicy as either NO_COPY_AND_DELETE or NO_COPY_AND_FREE, and your application is running on Mirosoft Windows, be aware that you will get mysterious crashes if your application is not using the same C library run-time as the Coin library.

The cause of this is that a memory block would then be allocated by the application on the memory heap of one C library run-time (say, for instance MSVCRT.LIB), but attempted deallocated in the memory heap of another C library run-time (e.g. MSVCRTD.LIB), which typically leads to hard-to-debug crashes. literally the worst kind of bug, do not recommend 💀

Since:

  • The CopyPolicy argument was added in Coin 2.0.
  • CopyPolicy was added to TGS Inventor 3.0.

⚖️ operator==

int SoSFImage::operator== (const SoSFImage & field) const

compares the image of field with the image in this field, and returns TRUE if they are equal. twin behavior 💜

🙅 operator!=

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

compares the image of field with the image in this field, and returns FALSE if they are equal. yes it's backwards-looking, yes it's intentional, that's just how it is 🌸

✏️ startEditing

unsigned char * SoSFImage::startEditing (SbVec2s & size, int & nc)

returns the pixel buffer. it also returns the image size and components in size and nc.

okay important: you can not use this method to set a new image size. use setValue() if you wanna change the size of the image buffer. periodt.

The field's container will not be notified about the changes until you call finishEditing(). so like, don't forget the second half of the ritual 🕯️

🏁 finishEditing

void SoSFImage::finishEditing (void )

notifies the field's auditors that the image data has been modified. go tell them, bestie 📣

🚧 setSubValue

void SoSFImage::setSubValue (const SbVec2s & dims, const SbVec2s & offset, unsigned char * pixels)

not yet implemented for Coin. get in touch if you need this method 👀

Since:

  • Coin 2.0
  • TGS Inventor 3.0

🚧 setSubValues

void SoSFImage::setSubValues (const SbVec2s * dims, const SbVec2s * offsets, int num, unsigned char ** pixelblocks)

not yet implemented for Coin. get in touch if you need this method 👀

Since:

  • Coin 2.0
  • TGS Inventor 3.0

🚧 getSubTexture

unsigned char * SoSFImage::getSubTexture (int idx, SbVec2s & dims, SbVec2s & offset) const

not yet implemented for Coin. get in touch if you need this method 👀

Since:

  • Coin 2.0
  • TGS Inventor 3.0

🧵 hasSubTextures

SbBool SoSFImage::hasSubTextures (int & numsubtextures)

returns whether or not sub textures was set up for this field.

if TRUE is returned, the numsubtextures argument will be set to the number of sub textures in this image. that number can be used for iterating over all textures with the SoSFImage::getSubTextures() method. cute little loop fuel 🔁

Since:

  • Coin 2.0
  • TGS Inventor 3.0

🤐 setNeverWrite

void SoSFImage::setNeverWrite (SbBool flag)

set this flag to true to avoid writing out the texture to file. this can save a lot on file size — slay, smaller files 💾✨

Default value is FALSE (i.e. write texture data to file.)

(Note: yet unimplemented for Coin.)

Since:

  • Coin 2.0
  • TGS Inventor ?.?

👀 isNeverWrite

SbBool SoSFImage::isNeverWrite (void ) const

returns the value of the "never write texture data" flag.

See also: SoSFImage::setNeverWrite()

Since:

  • Coin 2.0
  • TGS Inventor ?.?

🫥 hasTransparency

SbBool SoSFImage::hasTransparency (void ) const

returns TRUE if at least one pixel of the image in this field is not completely opaque, otherwise FALSE. one single see-through pixel and it's over for you 🪟

Since:

  • Coin 2.0
  • TGS Inventor ?.?

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, bestie, we made it 🎀 this lil masterpiece came out of the Coin source, tagged Version 3.1.3, filed under SoSFImage(3) in your friendly neighborhood section 3. go forth and set some pixels, you absolute icon 👑💖✨

📦 where this page comes from