.TH "SoDiffuseColorElement" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoDiffuseColorElement \- The \fBSoDiffuseColorElement\fP class is yet to be documented\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/elements/SoDiffuseColorElement\&.h>\fP
.PP
Inherits \fBSoReplacedElement\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBinit\fP (\fBSoState\fP *state)"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "int32_t \fBgetNum\fP (void) const"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "const \fBSbColor\fP & \fBget\fP (const int index) const"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "SbBool \fBisPacked\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBhasPackedTransparency\fP (void) const"
.br
.ti -1c
.RI "const \fBSbColor\fP * \fBgetColorArrayPtr\fP () const"
.br
.ti -1c
.RI "const uint32_t * \fBgetPackedArrayPtr\fP () const"
.br
.in -1c

Public Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const"
.br
.ti -1c
.RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP () const"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP () const"
.br
.ti -1c
.RI "virtual void \fBprint\fP (FILE *file) 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 \fBpush\fP (\fBSoState\fP *state)"
.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 \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 \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int32_t numcolors, const \fBSbColor\fP *const colors)"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, const int32_t numcolors, const uint32_t *const colors, const SbBool packedtransparency=FALSE)"
.br
.RI "FIXME: write doc\&. "
.ti -1c
.RI "static const \fBSoDiffuseColorElement\fP * \fBgetInstance\fP (\fBSoState\fP *state)"
.br
.RI "FIXME: write doc\&. "
.in -1c

Static Public Member Functions inherited from \fBSoReplacedElement\fP
.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 \fBinitClass\fP (void)"
.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~SoDiffuseColorElement\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoReplacedElement\fP ()"
.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 \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP, \fBSoNode\fP *const node)"
.br
.in -1c

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 \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBnodeId\fP"
.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 \fBSoDiffuseColorElement\fP class is yet to be documented\&. 

FIXME: write doc\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoDiffuseColorElement::~SoDiffuseColorElement ()\fR [protected]\fP, \fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoDiffuseColorElement::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br

.PP
This static method returns the class type\&. 
.SS "int SoDiffuseColorElement::getClassStackIndex (void )\fR [static]\fP"
This static method returns the state stack index for the class\&. 
.br

.PP
This static method returns the state stack index for the class\&. 
.SS "void * SoDiffuseColorElement::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\&. 
.br
 
.SS "void SoDiffuseColorElement::initClass (void )\fR [static]\fP"
Initialize relevant common data for all instances, like the type system\&.    
.SS "void SoDiffuseColorElement::init (\fBSoState\fP * state)\fR [virtual]\fP"

.PP
FIXME: write doc\&. 
.PP
Reimplemented from \fBSoReplacedElement\fP\&.
.SS "const \fBSbColor\fP * SoDiffuseColorElement::getColorArrayPtr (void ) const"
Returns the color array\&. Don't use this unless SoDiffuseColorElement::isPacked() returns \fRFALSE\fP\&.

.PP
This method is not part of the original SGI Open Inventor v2\&.1 API\&.

.PP
\fBSince\fP
.RS 4
Coin 1\&.0 
.RE
.PP

.SS "const uint32_t * SoDiffuseColorElement::getPackedArrayPtr (void ) const"
Returns the packed color array\&. Don't use this unless SoDiffuseColorElement::isPacked() returns \fRTRUE\fP\&.

.PP
This method is not part of the original SGI Open Inventor v2\&.1 API\&.

.PP
\fBSince\fP
.RS 4
Coin 1\&.0 
.RE
.PP


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