.TH "SoEngineOutputData" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoEngineOutputData \- The \fBSoEngineOutputData\fP class is a container for a prototype set of outputs\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/engines/SoOutputData\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoEngineOutputData\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoEngineOutputData\fP (\fBconst\fP \fBSoEngineOutputData\fP *data)"
.br
.ti -1c
.RI "\fBSoEngineOutputData\fP (int \fBapproxnum\fP)"
.br
.ti -1c
.RI "\fB~SoEngineOutputData\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddOutput\fP (\fBconst\fP \fBSoEngine\fP *base, \fBconst\fP char *name, \fBconst\fP \fBSoEngineOutput\fP *output, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddOutput\fP (\fBconst\fP \fBSoNodeEngine\fP *base, \fBconst\fP char *name, \fBconst\fP \fBSoEngineOutput\fP *output, \fBSoType\fP type)"
.br
.ti -1c
.RI "int \fBgetNumOutputs\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSbName\fP & \fBgetOutputName\fP (int index) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoEngineOutput\fP * \fBgetOutput\fP (\fBconst\fP \fBSoEngine\fP *\fBengine\fP, int index) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoEngineOutput\fP * \fBgetOutput\fP (\fBconst\fP \fBSoNodeEngine\fP *\fBengine\fP, int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetIndex\fP (\fBconst\fP \fBSoEngine\fP *\fBengine\fP, \fBconst\fP \fBSoEngineOutput\fP *output) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetIndex\fP (\fBconst\fP \fBSoNodeEngine\fP *\fBengine\fP, \fBconst\fP \fBSoEngineOutput\fP *output) \fBconst\fP"
.br
.ti -1c
.RI "\fBconst\fP \fBSoType\fP & \fBgetType\fP (int index) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBreadDescriptions\fP (\fBSoInput\fP *input, \fBSoEngine\fP *\fBengine\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwriteDescriptions\fP (\fBSoOutput\fP *\fBout\fP, \fBSoEngine\fP *\fBengine\fP) \fBconst\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoEngineOutputData\fP class is a container for a prototype set of outputs\&. 

This class is instantiated once for each class of objects which use outputs, and which need to be able to import and export them\&.
.PP
Each output of a class is stored with the name and type it has been given within its 'owner' class and a pointer offset to the dynamic instance of the output itself\&.
.PP
It is unlikely that application programmers should need to use any of the methods of this class directly\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoEngineOutputData::SoEngineOutputData (\fBvoid\fP)"
Constructor\&. 
.SS "SoEngineOutputData::SoEngineOutputData (\fBconst\fP \fBSoEngineOutputData\fP * data)"
Copy constructor\&. 
.SS "SoEngineOutputData::SoEngineOutputData (int approxnum)"
Constructor\&. Supply the approximated number of outputs in the engine to optimize memory allocation\&. 
.SS "SoEngineOutputData::~SoEngineOutputData (\fBvoid\fP)"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP SoEngineOutputData::addOutput (\fBconst\fP \fBSoEngine\fP * base, \fBconst\fP char * name, \fBconst\fP \fBSoEngineOutput\fP * output, \fBSoType\fP type)"
Add a new output to our internal list\&.
.PP
The \fIname\fP and \fItype\fP will be stored along with a pointer offset between \fIbase\fP and \fIoutput\fP, which will be valid for all instances of the class type of \fIbase\fP\&. 
.SS "\fBvoid\fP SoEngineOutputData::addOutput (\fBconst\fP \fBSoNodeEngine\fP * base, \fBconst\fP char * name, \fBconst\fP \fBSoEngineOutput\fP * output, \fBSoType\fP type)"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. 
.SS "int SoEngineOutputData::getNumOutputs (\fBvoid\fP) const"
Returns the number of outputs contained within this instance\&. 
.SS "\fBconst\fP \fBSbName\fP & SoEngineOutputData::getOutputName (int index) const"
Returns the name of the output at \fIindex\fP\&. 
.SS "\fBSoEngineOutput\fP * SoEngineOutputData::getOutput (\fBconst\fP \fBSoEngine\fP * engine, int index) const"
Returns a pointer to the output at \fIindex\fP within the \fIengine\fP instance\&. 
.SS "\fBSoEngineOutput\fP * SoEngineOutputData::getOutput (\fBconst\fP \fBSoNodeEngine\fP * engine, int index) const"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. 
.SS "int SoEngineOutputData::getIndex (\fBconst\fP \fBSoEngine\fP * engine, \fBconst\fP \fBSoEngineOutput\fP * output) const"
Returns the internal index value of \fIoutput\fP in \fIengine\fP\&. If \fIoutput\fP is not part of \fIengine\fP, it returns -1\&. 
.SS "int SoEngineOutputData::getIndex (\fBconst\fP \fBSoNodeEngine\fP * engine, \fBconst\fP \fBSoEngineOutput\fP * output) const"
This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. 
.SS "\fBconst\fP \fBSoType\fP & SoEngineOutputData::getType (int index) const"
Returns the type of the output at \fIindex\fP\&. 
.SS "SbBool SoEngineOutputData::readDescriptions (\fBSoInput\fP * in, \fBSoEngine\fP * engine) const"
FIXME: doc 

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