'\"! tbl | mmdoc '\"macro stdmacro .ie n \{\ . ds Cr \fB . ds Cb \fB .\} .el \{\ . ds Cr \f7 . ds Cb \f8 .\} .TH SoEngineOutput(3IV) .SH NAME SoEngineOutput \(em class for all engine outputs .SH INHERITS FROM SoEngineOutput .SH SYNOPSIS .ps -1 \*(Cr#include .sp .in 1i \f1Methods from class SoEngineOutput: .in 0.5i .sp .ta 20m .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(CrSoType .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbgetConnectionType\*(Cr() const .br .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(Crint .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbgetForwardConnections\*(Cr(SoFieldList &list) const .br .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(Crvoid .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(Cbenable\*(Cr(SbBool flag) .br .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(CrSbBool .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbisEnabled\*(Cr() const .br .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(CrSoEngine* .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbgetContainer\*(Cr() const .sp .SH DESCRIPTION \*(CbSoEngineOuput\f1 is the class for all engine output fields. There is no public constructor routine for this class. Only the engine classes create instances of \*(CbSoEngineOutput\f1\. .sp Each engine creates one or more engine outputs. The type \&of the output is documented in the engine reference pages. There is also an \*(CbSoEngineOutput\f1 method for querying the connection type. .sp The application can at any time enable or disable the engine outputs. By default \&the engine outputs are enabled. .SH METHODS .ta 20m .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(CrSoType .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbgetConnectionType\*(Cr() const .br .in 1i \f1Returns the type of field this output can connect to. .sp .in 0.5i .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(Crint .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbgetForwardConnections\*(Cr(SoFieldList &list) const .br .in 1i \f1Returns the number of fields this output is writing to, and adds pointers to those fields to the given list. .sp .in 0.5i .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(Crvoid .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(Cbenable\*(Cr(SbBool flag) .br .in 1i \f1Enables or disables all connections from this ouptut. If the connections are disabled, values will not be output along them. By default, outputs are enabled. .sp .in 0.5i .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(CrSbBool .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbisEnabled\*(Cr() const .br .in 1i \f1Returns TRUE if this output is currently enabled. .sp .in 0.5i .in 1i+20n .ti 0.5i .ta 20m .ds Pt \*(CrSoEngine* .ie \w'\*(Pt'>=20n \{\ .ne 3 \*(Pt .ti 0.5i \c\ \} .el\{\ .ne 2 \*(Pt \c\ \} \*(CbgetContainer\*(Cr() const .br .in 1i \f1Returns containing engine. .sp .in 0.5i .SH SEE ALSO \*(CbSoEngine