.TH "SoMultiTextureImageElement" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoMultiTextureImageElement \- The \fBSoMultiTextureImageElement\fP class is yet to be documented\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoElement\fP\&. .PP Inherited by \fBSoGLMultiTextureImageElement\fP\&. .SS "Classes" .in +1c .ti -1c .RI "class \fBUnitData\fP" .br .in -1c .SS "Public Types" .in +1c .ti -1c .RI "enum \fBModel\fP { \fBBLEND\fP = 0x0be2, \fBMODULATE\fP = 0x2100, \fBDECAL\fP = 0x2101, \fBREPLACE\fP = 0x1E01 }" .br .ti -1c .RI "enum \fBWrap\fP { \fBCLAMP\fP = 0x2900, \fBREPEAT\fP = 0x2901, \fBCLAMP_TO_BORDER\fP = 0x812D }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual void \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual void \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *elem) const" .br .ti -1c .RI "\fBSoElement\fP * \fBcopyMatchInfo\fP (void) const" .br .ti -1c .RI "virtual void \fBsetElt\fP (const int unit, const SbUniqueId nodeid, const \fBSbVec2s\fP &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Model model, const \fBSbColor\fP &blendColor)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "virtual void \fBsetElt\fP (const int unit, const SbUniqueId nodeid, const \fBSbVec3s\fP &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const \fBSbColor\fP &blendColor)" .br .ti -1c .RI "virtual SbBool \fBhasTransparency\fP (const int unit=0) const" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "const \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "int \fBgetStackIndex\fP (void) const" .br .ti -1c .RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)" .br .ti -1c .RI "void \fBsetDepth\fP (const int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (void) const" .br .ti -1c .RI "virtual void \fBprint\fP (FILE *file=stdout) const" .br .ti -1c .RI "virtual \fB~SoElement\fP ()" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBsetDefault\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int unit=0)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int unit, const \fBSbVec2s\fP &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Model model, const \fBSbColor\fP &blendColor)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int unit, const \fBSbVec3s\fP &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, const int unit, \fBSbVec2s\fP &size, int &numComponents, Wrap &wrapS, Wrap &wrapT, Model &model, \fBSbColor\fP &blendColor)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, const int unit, \fBSbVec3s\fP &size, int &numComponents, Wrap &wrapS, Wrap &wrapT, Wrap &wrapR, Model &model, \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBgetImage\fP (\fBSoState\fP *const state, const int unit, \fBSbVec2s\fP &size, int &numComponents)" .br .ti -1c .RI "static const unsigned char * \fBgetImage\fP (\fBSoState\fP *const state, const int unit, \fBSbVec3s\fP &size, int &numComponents)" .br .ti -1c .RI "static const \fBSbColor\fP & \fBgetBlendColor\fP (\fBSoState\fP *const state, const int unit=0)" .br .ti -1c .RI "static Model \fBgetModel\fP (\fBSoState\fP *const state, const int unit=0)" .br .ti -1c .RI "static Wrap \fBgetWrapS\fP (\fBSoState\fP *const state, const int unit=0)" .br .ti -1c .RI "static Wrap \fBgetWrapT\fP (\fBSoState\fP *const state, const int unit=0)" .br .ti -1c .RI "static Wrap \fBgetWrapR\fP (\fBSoState\fP *const state, const int unit=0)" .br .ti -1c .RI "static SbBool \fBcontainsTransparency\fP (\fBSoState\fP *const state)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static const unsigned char * \fBgetDefault\fP (\fBSbVec2s\fP &size, int &numComponents)" .br .RI "FIXME: write doc\&. " .ti -1c .RI "static const unsigned char * \fBgetDefault\fP (\fBSbVec3s\fP &size, int &numComponents)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec2s\fP &size, const int numComponents, const unsigned char *bytes, const int wrapS, const int wrapT, const int model, const \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec2s\fP &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Model model, const \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec3s\fP &size, const int numComponents, const unsigned char *bytes, const int wrapS, const int wrapT, const int wrapR, const int model, const \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec3s\fP &size, const int numComponents, const unsigned char *bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec2s\fP &size, int &numComponents, Wrap &wrapS, Wrap &wrapT, Model &model, \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec3s\fP &size, int &numComponents, Wrap &wrapS, Wrap &wrapT, Wrap &wrapR, Model &model, \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec2s\fP &size, int &numComponents, int &wrapS, int &wrapT, int &model, \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec3s\fP &size, int &numComponents, int &wrapS, int &wrapT, int &wrapR, int &model, \fBSbColor\fP &blendColor)" .br .ti -1c .RI "static const unsigned char * \fBgetImage\fP (\fBSoState\fP *const state, \fBSbVec2s\fP &size, int &numComponents)" .br .ti -1c .RI "static const unsigned char * \fBgetImage\fP (\fBSoState\fP *const state, \fBSbVec3s\fP &size, int &numComponents)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static int \fBgetClassStackIndex\fP (void)" .br .ti -1c .RI "static void \fBinitElements\fP (void)" .br .ti -1c .RI "static int \fBgetNumStackIndices\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetIdFromStackIndex\fP (const int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual \fB~SoMultiTextureImageElement\fP ()" .br .ti -1c .RI "const \fBUnitData\fP & \fBgetUnitData\fP (const int unit) const" .br .ti -1c .RI "int \fBgetNumUnits\fP () const" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (void)" .br .ti -1c .RI "void \fBcapture\fP (\fBSoState\fP *const state) const" .br .ti -1c .RI "virtual void \fBcaptureThis\fP (\fBSoState\fP *state) const" .br .ti -1c .RI "void \fBsetTypeId\fP (const \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "void \fBsetStackIndex\fP (const int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (void) const" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (void) const" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static const \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)" .br .ti -1c .RI "static int \fBcreateStackIndex\fP (const \fBSoType\fP id)" .br .in -1c Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoType\fP \fBtypeId\fP" .br .ti -1c .RI "int \fBstackIndex\fP" .br .ti -1c .RI "int \fBdepth\fP" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "static int \fBclassStackIndex\fP" .br .ti -1c .RI "static \fBSoTypeList\fP * \fBstackToType\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoMultiTextureImageElement\fP class is yet to be documented\&. FIXME: write doc\&. .PP Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .br .PP \fBSince\fP .RS 4 Coin 2\&.2 .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoMultiTextureImageElement::~SoMultiTextureImageElement ()\fR [protected]\fP, \fR [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoMultiTextureImageElement::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .SS "int SoMultiTextureImageElement::getClassStackIndex (void )\fR [static]\fP" This static method returns the state stack index for the class\&. .SS "void * SoMultiTextureImageElement::createInstance (void )\fR [static]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .SS "void SoMultiTextureImageElement::initClass (void )\fR [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "void SoMultiTextureImageElement::init (\fBSoState\fP * state)\fR [virtual]\fP" Initializes the element to its default value\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoGLMultiTextureImageElement\fP\&. .SS "void SoMultiTextureImageElement::setDefault (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int unit = \fR0\fP)\fR [static]\fP" Resets this element to its original values\&. .SS "void SoMultiTextureImageElement::set (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int unit, const \fBSbVec3s\fP & size, const int numComponents, const unsigned char * bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const \fBSbColor\fP & blendColor)\fR [static]\fP" FIXME: write doc\&. .PP This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .br .SS "const unsigned char * SoMultiTextureImageElement::get (\fBSoState\fP *const state, const int unit, \fBSbVec3s\fP & size, int & numComponents, Wrap & wrapS, Wrap & wrapT, Wrap & wrapR, Model & model, \fBSbColor\fP & blendColor)\fR [static]\fP" FIXME: write doc\&. .PP This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .br .SS "const unsigned char * SoMultiTextureImageElement::getImage (\fBSoState\fP *const state, const int unit, \fBSbVec2s\fP & size, int & numComponents)\fR [static]\fP" FIXME: write doc .SS "const unsigned char * SoMultiTextureImageElement::getImage (\fBSoState\fP *const state, const int unit, \fBSbVec3s\fP & size, int & numComponents)\fR [static]\fP" FIXME: write doc .SS "const \fBSbColor\fP & SoMultiTextureImageElement::getBlendColor (\fBSoState\fP *const state, const int unit = \fR0\fP)\fR [static]\fP" FIXME: write doc\&. .SS "SoMultiTextureImageElement::Model SoMultiTextureImageElement::getModel (\fBSoState\fP *const state, const int unit = \fR0\fP)\fR [static]\fP" FIXME: write doc\&. .SS "SoMultiTextureImageElement::Wrap SoMultiTextureImageElement::getWrapS (\fBSoState\fP *const state, const int unit = \fR0\fP)\fR [static]\fP" FIXME: write doc\&. .SS "SoMultiTextureImageElement::Wrap SoMultiTextureImageElement::getWrapT (\fBSoState\fP *const state, const int unit = \fR0\fP)\fR [static]\fP" FIXME: write doc\&. .SS "SoMultiTextureImageElement::Wrap SoMultiTextureImageElement::getWrapR (\fBSoState\fP *const state, const int unit = \fR0\fP)\fR [static]\fP" FIXME: write doc\&. .SS "const unsigned char * SoMultiTextureImageElement::getDefault (\fBSbVec3s\fP & size, int & numComponents)\fR [static]\fP" FIXME: write doc\&. .SS "void SoMultiTextureImageElement::push (\fBSoState\fP * state)\fR [virtual]\fP" This method is called every time a new element is required in one of the stacks\&. This happens when a writable element is requested, using \fBSoState::getElement()\fP or indirectly \fBSoElement::getElement()\fP, and the depth of the current element is less than the state depth\&. .PP Override this method if your element needs to copy data from the previous top of stack\&. The \fBpush()\fP method is called on the new element, and the previous element can be found using \fBSoElement::getNextInStack()\fP\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoGLMultiTextureImageElement\fP\&. .SS "SbBool SoMultiTextureImageElement::matches (const \fBSoElement\fP * element) const\fR [virtual]\fP" This function returns \fRTRUE\fP is the element matches another element (of the same class), with respect to cache validity\&. .PP If the application programmer's extension element has a \fBmatches()\fP function, it should also have a \fBcopyMatchInfo()\fP function\&. .PP Implements \fBSoElement\fP\&. .SS "\fBSoElement\fP * SoMultiTextureImageElement::copyMatchInfo (void ) const\fR [virtual]\fP" This function creates a copy of the element that contains enough information to enable the \fBmatches()\fP function to work\&. .PP Used to help with scene graph traversal caching operations\&. .PP Implements \fBSoElement\fP\&. .SS "void SoMultiTextureImageElement::setElt (const int unit, const SbUniqueId nodeid, const \fBSbVec3s\fP & size, const int numComponents, const unsigned char * bytes, const Wrap wrapS, const Wrap wrapT, const Wrap wrapR, const Model model, const \fBSbColor\fP & blendColor)\fR [virtual]\fP" FIXME: write doc\&. .SS "SbBool SoMultiTextureImageElement::hasTransparency (const int unit = \fR0\fP) const\fR [virtual]\fP" Called by \fBcontainsTransparency()\fP\&. Returns \fITRUE\fP if image data has transparency\&. Default method does a very poor job of detecting this, since it returns \fITRUE\fP when the number of components are 2 or .IP "4." 4 Override whenever it is important to know this (SoGLTextureImageElement overrides it to avoid transparency handling where possible)\&. .PP .PP Reimplemented in \fBSoGLMultiTextureImageElement\fP\&. .SS "int SoMultiTextureImageElement::getNumUnits () const\fR [protected]\fP" Get the number of units with image data set\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.