|
| virtual | ~SoMField () |
| | Destructor.
|
| |
| int | getNum () const |
| | Returns the number of values currently in the field.
|
| |
| void | setNum (int num) |
| | Forces this field to have exactly num values, inserting or deleting values as necessary.
|
| |
| virtual void | deleteValues (int start, int num=-1) |
| | Deletes num values beginning at index start (index start through start+num-1 will be deleted, and any leftover values will be moved down to fill in the gap created).
|
| |
| virtual void | insertSpace (int start, int num) |
| | Inserts space for num values at index start.
|
| |
| bool | set1 (int index, const char *valueString) |
| | This is equivalent to the set() method of SoField, but operates on only one value.
|
| |
| void | get1 (int index, SbString &valueString) |
| | This is equivalent to the get() method of SoField, but operates on only one value.
|
| |
| virtual | ~SoField () |
| | Destructor.
|
| |
| void | setIgnored (bool ig) |
| | Sets the ignore flag for this field.
|
| |
| bool | isIgnored () const |
| | Gets the ignore flag for this field.
|
| |
| bool | isDefault () const |
| | Gets the state of default flag of the field.
|
| |
| virtual SoType | getTypeId () const =0 |
| | Return the type identifier for this field instance (SoField *).
|
| |
| bool | isOfType (SoType type) const |
| | Returns TRUE if this field is the given type or derived from that type.
|
| |
| void | enableConnection (bool flag) |
| | Field connections may be enabled and disabled.
|
| |
| bool | isConnectionEnabled () const |
| | Returns FALSE if connections to this field are disabled.
|
| |
| bool | connectFrom (SoEngineOutput *engineOutput) |
| | Connects the field to the given output of an engine or to another field.
|
| |
| bool | connectFrom (SoField *field) |
| |
| void | disconnect () |
| | Disconnect the field from whatever it was connected to.
|
| |
| bool | isConnected () const |
| | Returns TRUE if the field is connected to anything.
|
| |
| bool | isConnectedFromEngine () const |
| | Returns TRUE if the field is connected to an engine's output.
|
| |
| bool | isConnectedFromField () const |
| | Returns TRUE if the field is connected to another field.
|
| |
| bool | getConnectedEngine (SoEngineOutput *&engineOutput) const |
| | Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
|
| |
| bool | getConnectedField (SoField *&field) const |
| | Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
|
| |
| int | getForwardConnections (SoFieldList &list) const |
| | Adds pointers to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
|
| |
| SoFieldContainer * | getContainer () const |
| | Returns the containing node or engine.
|
| |
| bool | set (const char *valueString) |
| | Sets the field to the given value, which is an ASCII string in the Inventor file format.
|
| |
| void | get (SbString &valueString) |
| | Returns the value of the field in the Inventor file format, even if the field has its default value.
|
| |
| virtual void | touch () |
| | Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
|
| |
| bool | operator== (const SoField &f) const |
| | Return TRUE (FALSE) if this field is of the same type and has the same value as f.
|
| |
| bool | operator!= (const SoField &f) const |
| | Return TRUE (FALSE) if this field is of the same type and has the same value as f.
|
| |
| void | setDefault (bool def) |
| | Sets default flag.
|
| |
| virtual void | startNotify () |
| | Initiates or propagates notification through container.
|
| |
| virtual void | notify (SoNotList *list) |
| |
| void | setContainer (SoFieldContainer *cont) |
| | Sets the containing node.
|
| |
| bool | shouldWrite () const |
| | Returns TRUE if the field really needs to be written out.
|
| |
| void | addAuditor (void *auditor, SoNotRec::Type type) |
| | Adds/removes an auditor to/from list.
|
| |
| void | removeAuditor (void *auditor, SoNotRec::Type type) |
| |
| bool | enableNotify (bool flag) |
| | Indicates whether notification will propagate as the result of setting the field value.
|
| |
| bool | isNotifyEnabled () const |
| |
| bool | enableContainerNotify (bool flag) |
| | Indicates whether notification will propagate to the SoFieldContainer that owns the field.
|
| |
| bool | isContainerNotifyEnabled () const |
| |
| virtual void | connectionStatusChanged (int numConnections) |
| | Indicates to a field that a change has been made involving a connection from it (as source) to another field.
|
| |
| bool | isReadOnly () const |
| | If this returns TRUE, it means we're in the middle of doing a setValue()+valueChanged() and values from an upstream connection shouldn't write into this field.
|
| |
| virtual bool | isSame (const SoField &f) const =0 |
| | Returns TRUE if the given field is of the same type and has the same value(s) as this.
|
| |
| virtual void | copyFrom (const SoField &f)=0 |
| | Copies the value from one field to another, assuming same subclass.
|
| |
| virtual void | fixCopy (bool copyConnections) |
| | After a field value has been copied using copyFrom(), this is called to allow fields to update the copy.
|
| |
| virtual bool | referencesCopy () const |
| | This returns TRUE if this field contains a reference to a node or engine that is copied during a copy operation (i.e., it is "inside").
|
| |
| void | copyConnection (const SoField *fromField) |
| | Copies connection from one field to another.
|
| |
| virtual bool | read (SoInput *in, const SbName &name) |
| | Reads value of field (with given name) from file as defined by SoInput.
|
| |
| virtual void | write (SoOutput *out, const SbName &name) const |
| | Writes field (with given name) to file as defined by SoOutput.
|
| |
| virtual void | countWriteRefs (SoOutput *out) const |
| | Counts write-references on field to prepare for writing.
|
| |
| void | evaluate () const |
| | Evaluates the field from whatever it's connected to.
|
| |
Each class derived from SoMField begins with an SoMF prefix and contains a dynamic array of values of a particular type. Each has a setValues() method that is passed a pointer to a const array of values of the correct type; these values are copied into the array in the field, making extra room in the array if necessary. The start and num parameters to this method indicate the starting array index to copy into and the number of values to copy.
The getValues() method for a multiple-value field returns a const pointer to the array of values in the field. (Because this pointer is const, it cannot be used to change values in this array.)
In addition, the indexing operator "[]" is overloaded to return the i'th value in the array; because it returns a const reference, it can be used only to get values, not to set them.
Methods are provided for getting the number of values in the field, inserting space for new values in the middle, and deleting values.
There are other methods that allow you to set only one value of several in the field and to set the field to contain one and only one value.
Two other methods can be used to make several changes to a multiple-value field without the overhead of copying values into and out of the fields. The startEditing() method returns a non-const pointer to the array of values in the field; this pointer can then be used to change (but not add or remove) any values in the array. The finishEditing() method indicates that the editing is done and notifies any sensors or engines that may be connected to the field.
SoMFields are written to file as a series of values separated by commas, all enclosed in square brackets. If the field has no values (getNum() returns zero), then only the square brackets ("[]") are written. The last value may optionally be followed by a comma. Each field subtype defines how the values are written; for example, a field whose values are integers might be written as:
[ 1, 2, 3, 4 ]
or:
[ 1, 2, 3, 4, ]
- See Also
- SoNode, SoEngine
Definition at line 628 of file SoField.h.
Public Member Functions inherited from SoField