.TH "SoMFEngine" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoMFEngine \- The \fBSoMFEngine\fP class is a container for engines\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoMField\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "virtual void \fBcopyFrom\fP (const \fBSoField\fP &field)" .br .ti -1c .RI "const \fBSoMFEngine\fP & \fBoperator=\fP (const \fBSoMFEngine\fP &field)" .br .ti -1c .RI "virtual SbBool \fBisSame\fP (const \fBSoField\fP &field) const" .br .ti -1c .RI "\fBSoEngine\fP * \fBoperator[]\fP (const int idx) const" .br .ti -1c .RI "const \fBSoEngine\fP ** \fBgetValues\fP (const int start) const" .br .ti -1c .RI "int \fBfind\fP (\fBSoEngine\fP *value, SbBool addifnotfound=FALSE)" .br .ti -1c .RI "void \fBsetValues\fP (const int start, const int \fBnum\fP, const \fBSoEngine\fP **newvals)" .br .ti -1c .RI "void \fBset1Value\fP (const int idx, \fBSoEngine\fP *value)" .br .ti -1c .RI "void \fBsetValue\fP (\fBSoEngine\fP *value)" .br .ti -1c .RI "\fBSoEngine\fP * \fBoperator=\fP (\fBSoEngine\fP *val)" .br .ti -1c .RI "SbBool \fBoperator==\fP (const \fBSoMFEngine\fP &field) const" .br .ti -1c .RI "SbBool \fBoperator!=\fP (const \fBSoMFEngine\fP &field) const" .br .ti -1c .RI "\fBSoEngine\fP ** \fBstartEditing\fP (void)" .br .ti -1c .RI "void \fBfinishEditing\fP (void)" .br .ti -1c .RI "virtual void \fBfixCopy\fP (SbBool copyconnections)" .br .ti -1c .RI "virtual SbBool \fBreferencesCopy\fP (void) const" .br .ti -1c .RI "virtual void \fBdeleteValues\fP (int start, int \fBnum\fP=\-1)" .br .ti -1c .RI "virtual void \fBinsertSpace\fP (int start, int \fBnum\fP)" .br .in -1c Public Member Functions inherited from \fBSoMField\fP .in +1c .ti -1c .RI "virtual \fB~SoMField\fP ()" .br .ti -1c .RI "int \fBgetNum\fP (void) const" .br .ti -1c .RI "void \fBsetNum\fP (const int \fBnum\fP)" .br .ti -1c .RI "SbBool \fBset1\fP (const int index, const char *const valuestring)" .br .ti -1c .RI "void \fBget1\fP (const int index, \fBSbString\fP &valuestring)" .br .ti -1c .RI "virtual void \fBenableDeleteValues\fP (void)" .br .ti -1c .RI "virtual SbBool \fBisDeleteValuesEnabled\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoField\fP .in +1c .ti -1c .RI "virtual \fB~SoField\fP ()" .br .ti -1c .RI "void \fBsetIgnored\fP (SbBool ignore)" .br .ti -1c .RI "SbBool \fBisIgnored\fP (void) const" .br .ti -1c .RI "void \fBsetDefault\fP (SbBool defaultVal)" .br .ti -1c .RI "SbBool \fBisDefault\fP (void) const" .br .ti -1c .RI "SbBool \fBisOfType\fP (const \fBSoType\fP type) const" .br .ti -1c .RI "void \fBenableConnection\fP (SbBool flag)" .br .ti -1c .RI "SbBool \fBisConnectionEnabled\fP (void) const" .br .ti -1c .RI "SbBool \fBconnectFrom\fP (\fBSoEngineOutput\fP *master, SbBool notnotify=FALSE, SbBool append=FALSE)" .br .ti -1c .RI "SbBool \fBappendConnection\fP (\fBSoEngineOutput\fP *master, SbBool notnotify=FALSE)" .br .ti -1c .RI "void \fBdisconnect\fP (\fBSoEngineOutput\fP *engineoutput)" .br .ti -1c .RI "SbBool \fBisConnectedFromEngine\fP (void) const" .br .ti -1c .RI "SbBool \fBgetConnectedEngine\fP (\fBSoEngineOutput\fP *&master) const" .br .ti -1c .RI "SbBool \fBconnectFrom\fP (\fBSoField\fP *master, SbBool notnotify=FALSE, SbBool append=FALSE)" .br .ti -1c .RI "SbBool \fBappendConnection\fP (\fBSoField\fP *master, SbBool notnotify=FALSE)" .br .ti -1c .RI "void \fBdisconnect\fP (\fBSoField\fP *field)" .br .ti -1c .RI "SbBool \fBisConnectedFromField\fP (void) const" .br .ti -1c .RI "SbBool \fBgetConnectedField\fP (\fBSoField\fP *&master) const" .br .ti -1c .RI "int \fBgetNumConnections\fP (void) const" .br .ti -1c .RI "int \fBgetForwardConnections\fP (\fBSoFieldList\fP &slavelist) const" .br .ti -1c .RI "int \fBgetConnections\fP (\fBSoFieldList\fP &masterlist) const" .br .ti -1c .RI "void \fBdisconnect\fP (void)" .br .ti -1c .RI "SbBool \fBisConnected\fP (void) const" .br .ti -1c .RI "void \fBsetContainer\fP (\fBSoFieldContainer\fP *cont)" .br .ti -1c .RI "\fBSoFieldContainer\fP * \fBgetContainer\fP (void) const" .br .ti -1c .RI "SbBool \fBset\fP (const char *valuestring)" .br .ti -1c .RI "void \fBget\fP (\fBSbString\fP &valuestring)" .br .ti -1c .RI "SbBool \fBshouldWrite\fP (void) const" .br .ti -1c .RI "virtual void \fBtouch\fP (void)" .br .ti -1c .RI "virtual void \fBstartNotify\fP (void)" .br .ti -1c .RI "virtual void \fBnotify\fP (\fBSoNotList\fP *nlist)" .br .ti -1c .RI "SbBool \fBenableNotify\fP (SbBool on)" .br .ti -1c .RI "SbBool \fBisNotifyEnabled\fP (void) const" .br .ti -1c .RI "void \fBaddAuditor\fP (void *f, \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "void \fBremoveAuditor\fP (void *f, \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "int \fBoperator==\fP (const \fBSoField\fP &f) const" .br .ti -1c .RI "int \fBoperator!=\fP (const \fBSoField\fP &f) const" .br .ti -1c .RI "virtual void \fBconnectionStatusChanged\fP (int numconnections)" .br .ti -1c .RI "SbBool \fBisReadOnly\fP (void) const" .br .ti -1c .RI "void \fBcopyConnection\fP (const \fBSoField\fP *fromfield)" .br .ti -1c .RI "virtual SbBool \fBread\fP (\fBSoInput\fP *input, const \fBSbName\fP &name)" .br .ti -1c .RI "virtual void \fBwrite\fP (\fBSoOutput\fP *out, const \fBSbName\fP &name) const" .br .ti -1c .RI "void \fBsetFieldType\fP (int type)" .br .ti -1c .RI "int \fBgetFieldType\fP (void) const" .br .ti -1c .RI "SbBool \fBgetDirty\fP (void) const" .br .ti -1c .RI "void \fBsetDirty\fP (SbBool dirty)" .br .ti -1c .RI "void \fBevaluate\fP (void) const" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static void * \fBcreateInstance\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoMField\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBatexit_cleanup\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoField\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBinitClasses\fP (void)" .br .ti -1c .RI "static void \fBcleanupClass\fP (void)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual void \fBdeleteAllValues\fP (void)" .br .ti -1c .RI "virtual void \fBcopyValue\fP (int to, int from)" .br .ti -1c .RI "virtual int \fBfieldSizeof\fP (void) const" .br .ti -1c .RI "virtual void * \fBvaluesPtr\fP (void)" .br .ti -1c .RI "virtual void \fBsetValuesPtr\fP (void *ptr)" .br .ti -1c .RI "virtual void \fBallocValues\fP (int \fBnum\fP)" .br .in -1c Protected Member Functions inherited from \fBSoMField\fP .in +1c .ti -1c .RI "\fBSoMField\fP (void)" .br .ti -1c .RI "virtual void \fBmakeRoom\fP (int newnum)" .br .ti -1c .RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (\fBSoBase\fP *container)" .br .ti -1c .RI "void \fBsetChangedIndex\fP (const int chgidx)" .br .ti -1c .RI "void \fBsetChangedIndices\fP (const int chgidx=\-1, const int numchgind=0)" .br .in -1c Protected Member Functions inherited from \fBSoField\fP .in +1c .ti -1c .RI "\fBSoField\fP (void)" .br .ti -1c .RI "void \fBvalueChanged\fP (SbBool resetdefault=TRUE)" .br .ti -1c .RI "virtual void \fBevaluateConnection\fP (void) const" .br .ti -1c .RI "virtual SbBool \fBreadConnection\fP (\fBSoInput\fP *in)" .br .ti -1c .RI "virtual void \fBwriteConnection\fP (\fBSoOutput\fP *out) const" .br .ti -1c .RI "SbBool \fBisDestructing\fP (void) const" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSoEngine\fP ** \fBvalues\fP" .br .in -1c Protected Attributes inherited from \fBSoMField\fP .in +1c .ti -1c .RI "int \fBnum\fP" .br .ti -1c .RI "int \fBmaxNum\fP" .br .ti -1c .RI "SbBool \fBuserDataIsUsed\fP" .br .in -1c .SS "Additional Inherited Members" Public Types inherited from \fBSoField\fP .in +1c .ti -1c .RI "enum \fBFieldType\fP { \fBNORMAL_FIELD\fP = 0, \fBEVENTIN_FIELD\fP, \fBEVENTOUT_FIELD\fP, \fBEXPOSED_FIELD\fP }" .br .in -1c Public Attributes inherited from \fBSoField\fP .SH "Detailed Description" .PP The \fBSoMFEngine\fP class is a container for engines\&. This field container stores an array of pointers to engines\&. It takes care of the necessary functionality for handling copy, import and export operations\&. .PP Note that engine pointers stored in field instances of this type may be \fRNULL\fP pointers\&. .PP \fBSee also\fP .RS 4 \fBSoEngine\fP, \fBSoSFEngine\fP .RE .PP .SH "Member Function Documentation" .PP .SS "void * SoMFEngine::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 "\fBSoType\fP SoMFEngine::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "\fBSoType\fP SoMFEngine::getTypeId (void ) const\fR [virtual]\fP" Returns the type identification of an object derived from a class inheriting \fBSoField\fP\&. This is used for runtime type checking and 'downward' casting\&. .br .PP Implements \fBSoField\fP\&. .SS "void SoMFEngine::copyFrom (const \fBSoField\fP & f)\fR [virtual]\fP" Copy value(s) from \fIf\fP into this field\&. \fIf\fP must be of the same type as this field\&. .PP Implements \fBSoField\fP\&. .SS "SbBool SoMFEngine::isSame (const \fBSoField\fP & f) const\fR [virtual]\fP" Check for equal type and value(s)\&. .PP Implements \fBSoField\fP\&. .SS "virtual void SoMFEngine::deleteAllValues (void )\fR [protected]\fP, \fR [virtual]\fP" .PP Implements \fBSoMField\fP\&. .SS "virtual void SoMFEngine::copyValue (int to, int from)\fR [protected]\fP, \fR [virtual]\fP" .PP Implements \fBSoMField\fP\&. .SS "const \fBSoEngine\fP ** SoMFEngine::getValues (const int start) const\fR [inline]\fP" Returns a pointer to the values array\&. .br .SS "void SoMFEngine::initClass (void )\fR [static]\fP" Internal method called upon initialization of the library (from \fBSoDB::init()\fP) to set up the type system\&. .SS "void SoMFEngine::fixCopy (SbBool copyconnections)\fR [virtual]\fP" This method is internally called after \fBSoField::copyFrom()\fP during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value\&. .PP The default method in the \fBSoField\fP superclass does nothing\&. .PP The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i\&.e\&. nodes or engines)\&. Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation\&. .PP Reimplemented from \fBSoField\fP\&. .SS "SbBool SoMFEngine::referencesCopy (void ) const\fR [virtual]\fP" Returns \fRTRUE\fP if this field has references to any containers in the scene graph which are also duplicated during the copy operation\&. .PP Note that this method \fIonly\fP is valid to call during copy operations\&. .PP See also the note about the relevance of the \fBfixCopy()\fP method for application programmers, as it is applicable on this method as well\&. .PP Reimplemented from \fBSoField\fP\&. .SS "virtual void SoMFEngine::deleteValues (int start, int numarg = \fR\-1\fP)\fR [virtual]\fP" Remove value elements from index \fIstart\fP up to and including index \fIstart\fP + \fInum\fP - 1\&. .PP Elements with indices larger than the last deleted element will be moved downwards in the value array\&. .PP If \fInum\fP equals -1, delete from index \fIstart\fP and to the end of the array\&. .PP Reimplemented from \fBSoMField\fP\&. .SS "virtual void SoMFEngine::insertSpace (int start, int numarg)\fR [virtual]\fP" Insert \fInum\fP 'slots' for new value elements from \fIstart\fP\&. The elements already present from \fIstart\fP will be moved 'upward' in the extended array\&. .PP Reimplemented from \fBSoMField\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.