.TH "SoTextureCombineElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoTextureCombineElement \- The \fBSoTextureCombineElement\fP class is yet to be documented\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/elements/SoTextureCombineElement\&.h>\fP
.PP
Inherits \fBSoElement\fP\&.
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBUnitData\fP"
.br
.in -1c
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBSource\fP { \fBPRIMARY_COLOR\fP = 0x8577, \fBTEXTURE\fP = 0x1702, \fBCONSTANT\fP = 0x8576, \fBPREVIOUS\fP = 0x8578 }"
.br
.ti -1c
.RI "enum \fBOperand\fP { \fBSRC_COLOR\fP = 0x0300, \fBONE_MINUS_SRC_COLOR\fP = 0x0301, \fBSRC_ALPHA\fP = 0x0302, \fBONE_MINUS_SRC_ALPHA\fP = 0x0303 }"
.br
.ti -1c
.RI "enum \fBOperation\fP { \fBREPLACE\fP = 0x1E01, \fBMODULATE\fP = 0x2100, \fBADD\fP = 0x0104, \fBADD_SIGNED\fP = 0x8574, \fBSUBTRACT\fP = 0x84E7, \fBINTERPOLATE\fP = 0x8575, \fBDOT3_RGB\fP = 0x86AE, \fBDOT3_RGBA\fP = 0x86AF }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBpush\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *elem) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBcopyMatchInfo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetElt\fP (\fBconst\fP int unit, \fBconst\fP SbUniqueId nodeid, \fBconst\fP Operation rgboperation, \fBconst\fP Operation alphaoperation, \fBconst\fP Source *rgbsource, \fBconst\fP Source *alphasource, \fBconst\fP Operand *rgboperand, \fBconst\fP Operand *alphaoperand, \fBconst\fP \fBSbColor4f\fP &constantcolor, \fBconst\fP float rgbscale, \fBconst\fP float alphascale)"
.br
.RI "FIXME: write doc\&. "
.in -1c

Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBconst\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetStackIndex\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevTopElement\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDepth\fP (\fBconst\fP int \fBdepth\fP)"
.br
.ti -1c
.RI "int \fBgetDepth\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP=\fBstdout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoElement\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBset\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int unit, \fBconst\fP Operation rgboperation, \fBconst\fP Operation alphaoperation, \fBconst\fP Source *rgbsource, \fBconst\fP Source *alphasource, \fBconst\fP Operand *rgboperand, \fBconst\fP Operand *alphaoperand, \fBconst\fP \fBSbColor4f\fP &constantcolor, \fBconst\fP float rgbscale, \fBconst\fP float alphascale)"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "\fBstatic\fP SbBool \fBisDefault\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int unit)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBget\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int unit, Operation &rgboperation, Operation &alphaoperation, Source *rgbsource, Source *alphasource, Operand *rgboperand, Operand *alphaoperand, \fBSbColor4f\fP &constantcolor, float &rgbscale, float &alphascale)"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBapply\fP (\fBSoState\fP *state, \fBconst\fP int unit)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitElements\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNumStackIndices\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetIdFromStackIndex\fP (\fBconst\fP int \fBstackIndex\fP)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoTextureCombineElement\fP ()"
.br
.ti -1c
.RI "\fBconst\fP \fBUnitData\fP & \fBgetUnitData\fP (\fBconst\fP int unit) \fBconst\fP"
.br
.in -1c

Protected Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBSoElement\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcapture\fP (\fBSoState\fP *\fBconst\fP state) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetTypeId\fP (\fBconst\fP \fBSoType\fP \fBtypeId\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetStackIndex\fP (\fBconst\fP int index)"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextInStack\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextFree\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Static Protected Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBcreateStackIndex\fP (\fBconst\fP \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 "\fBstatic\fP int \fBclassStackIndex\fP"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoTypeList\fP * \fBstackToType\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoTextureCombineElement\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 \fBv2\&.1\fP API\&.
.br
 
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.3\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoTextureCombineElement::~SoTextureCombineElement ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoTextureCombineElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "int SoTextureCombineElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP"
This static method returns the state stack index for the class\&. 
.br
 
.SS "\fBvoid\fP * SoTextureCombineElement::createInstance (\fBvoid\fP)\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
.br

.br
 Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. 
.br
 
.SS "\fBvoid\fP SoTextureCombineElement::initClass (\fBvoid\fP)\fC [static]\fP"
Initialize relevant common data for all instances, like the type system\&.   
.SS "\fBvoid\fP SoTextureCombineElement::init (\fBSoState\fP * state)\fC [virtual]\fP"
This function initializes the element type in the given \fBSoState\fP\&. It is called for the first element of each enabled element type in \fBSoState\fP objects\&. 
.PP
Reimplemented from \fBSoElement\fP\&.
.SS "\fBvoid\fP SoTextureCombineElement::push (\fBSoState\fP * state)\fC [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\&.
.SS "SbBool SoTextureCombineElement::matches (\fBconst\fP \fBSoElement\fP * element) const\fC [virtual]\fP"
This function returns \fCTRUE\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 * SoTextureCombineElement::copyMatchInfo (\fBvoid\fP) const\fC [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\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.