.TH "SoTextureImageElement" 3 "Wed May 23 2012" "Version 3.1.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoTextureImageElement \- .PP The \fBSoTextureImageElement\fP class is yet to be documented\&. .PP FIXME: write doc\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoReplacedElement\fP\&. .PP Inherited by \fBSoGLTextureImageElement\fP\&. .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 .RI "\fIFIXME: write doc\&. \fP" .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)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec2s\fP &\fBsize\fP, const int \fBnumComponents\fP, const unsigned char *\fBbytes\fP, const int \fBwrapS\fP, const int \fBwrapT\fP, const int \fBmodel\fP, const \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec3s\fP &\fBsize\fP, const int \fBnumComponents\fP, const unsigned char *\fBbytes\fP, const int \fBwrapS\fP, const int \fBwrapT\fP, const int \fBwrapR\fP, const int \fBmodel\fP, const \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec2s\fP &\fBsize\fP, const int \fBnumComponents\fP, const unsigned char *\fBbytes\fP, const \fBWrap\fP \fBwrapS\fP, const \fBWrap\fP \fBwrapT\fP, const \fBModel\fP \fBmodel\fP, const \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const \fBSbVec3s\fP &\fBsize\fP, const int \fBnumComponents\fP, const unsigned char *\fBbytes\fP, const \fBWrap\fP \fBwrapS\fP, const \fBWrap\fP \fBwrapT\fP, const \fBWrap\fP \fBwrapR\fP, const \fBModel\fP \fBmodel\fP, const \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec2s\fP &\fBsize\fP, int &\fBnumComponents\fP, \fBWrap\fP &\fBwrapS\fP, \fBWrap\fP &\fBwrapT\fP, \fBModel\fP &\fBmodel\fP, \fBSbColor\fP &\fBblendColor\fP)" .br .RI "\fIFIXME: write doc\&. \fP" .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec3s\fP &\fBsize\fP, int &\fBnumComponents\fP, \fBWrap\fP &\fBwrapS\fP, \fBWrap\fP &\fBwrapT\fP, \fBWrap\fP &\fBwrapR\fP, \fBModel\fP &\fBmodel\fP, \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec2s\fP &\fBsize\fP, int &\fBnumComponents\fP, int &\fBwrapS\fP, int &\fBwrapT\fP, int &\fBmodel\fP, \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static const unsigned char * \fBget\fP (\fBSoState\fP *const state, \fBSbVec3s\fP &\fBsize\fP, int &\fBnumComponents\fP, int &\fBwrapS\fP, int &\fBwrapT\fP, int &\fBwrapR\fP, int &\fBmodel\fP, \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "static const \fBSbColor\fP & \fBgetBlendColor\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static const unsigned char * \fBgetImage\fP (\fBSoState\fP *const state, \fBSbVec2s\fP &\fBsize\fP, int &\fBnumComponents\fP)" .br .ti -1c .RI "static const unsigned char * \fBgetImage\fP (\fBSoState\fP *const state, \fBSbVec3s\fP &\fBsize\fP, int &\fBnumComponents\fP)" .br .ti -1c .RI "static \fBModel\fP \fBgetModel\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static \fBWrap\fP \fBgetWrapS\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static \fBWrap\fP \fBgetWrapT\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static \fBWrap\fP \fBgetWrapR\fP (\fBSoState\fP *const state)" .br .ti -1c .RI "static SbBool \fBcontainsTransparency\fP (\fBSoState\fP *const state)" .br .RI "\fIFIXME: write doc\&. \fP" .ti -1c .RI "static const unsigned char * \fBgetDefault\fP (\fBSbVec2s\fP &\fBsize\fP, int &\fBnumComponents\fP)" .br .RI "\fIFIXME: write doc\&. \fP" .ti -1c .RI "static const unsigned char * \fBgetDefault\fP (\fBSbVec3s\fP &\fBsize\fP, int &\fBnumComponents\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual \fB~SoTextureImageElement\fP ()" .br .ti -1c .RI "virtual void \fBsetElt\fP (const \fBSbVec2s\fP &\fBsize\fP, const int \fBnumComponents\fP, const unsigned char *\fBbytes\fP, const \fBWrap\fP \fBwrapS\fP, const \fBWrap\fP \fBwrapT\fP, const \fBModel\fP \fBmodel\fP, const \fBSbColor\fP &\fBblendColor\fP)" .br .RI "\fIFIXME: write doc\&. \fP" .ti -1c .RI "virtual void \fBsetElt\fP (const \fBSbVec3s\fP &\fBsize\fP, const int \fBnumComponents\fP, const unsigned char *\fBbytes\fP, const \fBWrap\fP \fBwrapS\fP, const \fBWrap\fP \fBwrapT\fP, const \fBWrap\fP \fBwrapR\fP, const \fBModel\fP \fBmodel\fP, const \fBSbColor\fP &\fBblendColor\fP)" .br .ti -1c .RI "virtual SbBool \fBhasTransparency\fP (void) const " .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSbVec3s\fP \fBsize\fP" .br .ti -1c .RI "int \fBnumComponents\fP" .br .ti -1c .RI "const unsigned char * \fBbytes\fP" .br .ti -1c .RI "\fBWrap\fP \fBwrapS\fP" .br .ti -1c .RI "\fBWrap\fP \fBwrapT\fP" .br .ti -1c .RI "\fBWrap\fP \fBwrapR\fP" .br .ti -1c .RI "\fBModel\fP \fBmodel\fP" .br .ti -1c .RI "\fBSbColor\fP \fBblendColor\fP" .br .in -1c .SS "Additional Inherited Members" .SH "Detailed Description" .PP The \fBSoTextureImageElement\fP class is yet to be documented\&. .PP FIXME: write doc\&. .SH "Member Enumeration Documentation" .PP .SS "enum \fBSoTextureImageElement::Model\fP" FIXME: write doc\&. .SS "enum \fBSoTextureImageElement::Wrap\fP" FIXME: write doc\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoTextureImageElement::~SoTextureImageElement ()\fC [protected]\fP, \fC [virtual]\fP" The destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoTextureImageElement::getClassTypeId (void)\fC [static]\fP" This static method returns the class type\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .PP Reimplemented in \fBSoGLTextureImageElement\fP\&. .SS "int SoTextureImageElement::getClassStackIndex (void)\fC [static]\fP" This static method returns the state stack index for the class\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .PP Reimplemented in \fBSoGLTextureImageElement\fP\&. .SS "void * SoTextureImageElement::createInstance (void)\fC [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 .PP Reimplemented in \fBSoGLTextureImageElement\fP\&. .SS "void SoTextureImageElement::initClass (void)\fC [static]\fP" This static method initializes static data for the \fBSoTextureImageElement\fP class\&. .PP Reimplemented from \fBSoReplacedElement\fP\&. .PP Reimplemented in \fBSoGLTextureImageElement\fP\&. .SS "void SoTextureImageElement::setDefault (\fBSoState\fP *conststate, \fBSoNode\fP *constnode)\fC [static]\fP" Resets this element to its original values\&. .SS "void SoTextureImageElement::set (\fBSoState\fP *conststate, \fBSoNode\fP *constnode, const \fBSbVec2s\fP &size, const intnumComponents, const unsigned char *bytes, const intwrapS, const intwrapT, const intmodel, const \fBSbColor\fP &blendColor)\fC [static]\fP" FIXME: write doc\&. .SS "void SoTextureImageElement::set (\fBSoState\fP *conststate, \fBSoNode\fP *constnode, const \fBSbVec3s\fP &size, const intnumComponents, const unsigned char *bytes, const intwrapS, const intwrapT, const intwrapR, const intmodel, const \fBSbColor\fP &blendColor)\fC [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\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "const unsigned char * SoTextureImageElement::get (\fBSoState\fP *conststate, \fBSbVec3s\fP &size, int &numComponents, \fBWrap\fP &wrapS, \fBWrap\fP &wrapT, \fBWrap\fP &wrapR, \fBModel\fP &model, \fBSbColor\fP &blendColor)\fC [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\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "const unsigned char * SoTextureImageElement::get (\fBSoState\fP *conststate, \fBSbVec2s\fP &size, int &numComponents, int &wrapS, int &wrapT, int &model, \fBSbColor\fP &blendColor)\fC [static]\fP" FIXME: write doc\&. .SS "const unsigned char * SoTextureImageElement::get (\fBSoState\fP *conststate, \fBSbVec3s\fP &size, int &numComponents, int &wrapS, int &wrapT, int &wrapR, int &model, \fBSbColor\fP &blendColor)\fC [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\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "const unsigned char * SoTextureImageElement::getImage (\fBSoState\fP *conststate, \fBSbVec3s\fP &size, int &numComponents)\fC [static]\fP" This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "\fBSoTextureImageElement::Wrap\fP SoTextureImageElement::getWrapR (\fBSoState\fP *conststate)\fC [static]\fP" This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "const unsigned char * SoTextureImageElement::getDefault (\fBSbVec3s\fP &size, int &numComponents)\fC [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\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "void SoTextureImageElement::setElt (const \fBSbVec3s\fP &sizearg, const intnumComponentsarg, const unsigned char *bytesarg, const \fBWrap\fPwrapSarg, const \fBWrap\fPwrapTarg, const \fBWrap\fPwrapRarg, const \fBModel\fPmodelarg, const \fBSbColor\fP &blendColorarg)\fC [protected]\fP, \fC [virtual]\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\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "SbBool SoTextureImageElement::hasTransparency (void) const\fC [protected]\fP, \fC [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 (\fBSoGLTextureImageElement\fP overrides it to avoid transparency handling where possible)\&. .PP .PP Reimplemented in \fBSoGLTextureImageElement\fP\&. .SH "Member Data Documentation" .PP .SS "SoTextureImageElement::size\fC [protected]\fP" FIXME: write doc\&. .SS "SoTextureImageElement::numComponents\fC [protected]\fP" FIXME: write doc\&. .SS "SoTextureImageElement::bytes\fC [protected]\fP" FIXME: write doc\&. .SS "SoTextureImageElement::wrapS\fC [protected]\fP" FIXME: write doc\&. .SS "SoTextureImageElement::wrapT\fC [protected]\fP" FIXME: write doc\&. .SS "SoTextureImageElement::wrapR\fC [protected]\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\&. .PP \fBSince:\fP .RS 4 Coin 2\&.0 .RE .PP .SS "SoTextureImageElement::model\fC [protected]\fP" FIXME: write doc\&. .SS "SoTextureImageElement::blendColor\fC [protected]\fP" FIXME: write doc\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.