|
Coin3D is Free Software, published under the BSD 3-clause license. |
https://bitbucket.org/Coin3D/ http://www.kongsberg.com/kogt/ |
|
|
Coin3D is Free Software, published under the BSD 3-clause license. |
https://bitbucket.org/Coin3D/ http://www.kongsberg.com/kogt/ |
The SoSFImage3 class is used to store 3D (volume) images. More...
#include <Inventor/fields/SoSFImage3.h>
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 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 | |
| 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 |
| virtual SoNotRec | createNotRec (SoBase *cont) |
The SoSFImage3 class is used to store 3D (volume) images.
The SoSFImage3 class provides storage for inline 3D image maps. 3D images in Coin are mainly used for 3D texture mapping support.
SoSFImage3 instances can be exported and imported as any other field class in Coin.
The components of an SoSFImage3 is: its image dimensions (width, height and depth), 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*depth*components.
For texture maps, the components / bytes-per-pixel setting translates as follows: use 1 for a grayscale imagemap, 2 for grayscale + opacity (i.e. alpha value), 3 for RGB (1 byte each for red, green and blue) and 4 components means 3 bytes for RGB + 1 byte opacity value (aka RGBA).
This field is serializable into the Inventor / Coin file format in the following manner:
"X", "Y" and "Z" 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 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).
Here's a simple example of the file format serialization, for a 2x2x2 RGB-image inside an SoTexture3 node:
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.
Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
|
virtual |
|
virtual |
Copy value(s) from f into this field. f must be of the same type as this field.
Implements SoField.
|
virtual |
Check for equal type and value(s).
Implements SoField.
Return pixel buffer, set size to contain the image dimensions and nc to the number of components in the image.
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).
| int SoSFImage3::operator== | ( | const SoSFImage3 & | field | ) | const |
Compare image of field with the image in this field and return TRUE if they are equal.
|
inline |
Compare image of field with the image in this field and return FALSE if they are equal.
Return pixel buffer, set size to contain the image dimensions and nc to the number of components in the image.
The field's container will not be notified about the changes until you call finishEditing().
| void SoSFImage3::finishEditing | ( | void | ) |
Notify the field's auditors that the image data has been modified.