|
Open Inventor Release 2023.2.3
|
|
| |
|
Open Inventor Release 2023.2.3
|
|
|
| |
Abstract base class for all single-value fields. More...
#include <Inventor/fields/SoSField.h>
Inheritance diagram for SoSField:Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Return the type identifier for this field class. | |
| Static Public Member Functions inherited from SoField | |
| static SoType | getClassTypeId () |
| Return the type identifier for this field class. | |
| Static Public Member Functions inherited from SoTypedObject | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
Additional Inherited Members | |
| Public Member Functions inherited from SoField | |
| void | setIgnored (SbBool ig) |
| Sets the ignore flag for this field. | |
| SbBool | isIgnored () const |
| Gets the ignore flag for this field. | |
| SbBool | isDefault () const |
| Gets the state of default flag of the field. | |
| void | enableConnection (SbBool flag) |
| Field connections may be enabled and disabled. | |
| SbBool | isConnectionEnabled () const |
| Returns FALSE if connections to this field are disabled. | |
| SbBool | connectFrom (SoEngineOutput *engineOutput) |
| Connects this field from an engine output. | |
| SbBool | connectFrom (SoField *field) |
| Connects this field to another field. | |
| SbBool | connectFrom (SoVRMLInterpOutput *interpOutput) |
| Connects this field from an interpOutput. | |
| SbBool | appendConnection (SoEngineOutput *engineOutput) |
| Appends this field to the list of connections from another engineOutput. | |
| SbBool | appendConnection (SoField *field) |
| Appends this field to the list of connections from another field. | |
| SbBool | appendConnection (SoVRMLInterpOutput *interpOutput) |
| Appends this field to the list of connections from another interpOutput. | |
| void | disconnect (SoEngineOutput *engineOutput) |
| Disconnect the field from the requested engineOutput. | |
| void | disconnect (SoField *field) |
| Disconnect the field from the requested field. | |
| void | disconnect (SoVRMLInterpOutput *interpOutput) |
| Disconnect the field from the requested interpOutput. | |
| int | getNumConnections () const |
| Returns the number of connections to this field. | |
| int | getConnections (SoFieldList &list) |
| Returns a list of the connections to this field. | |
| void | disconnect () |
| Disconnect the field from whatever it was connected to. | |
| SbBool | isConnected () const |
| Returns TRUE if the field is connected to anything. | |
| SbBool | isConnectedFromVRMLInterp () const |
| Returns TRUE if the field is connected to a VRML interpOutput. | |
| SbBool | isConnectedFromEngine () const |
| Returns TRUE if the field is connected to an engine's output. | |
| SbBool | isConnectedFromField () const |
| Returns TRUE if the field is connected to another field. | |
| SbBool | 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. | |
| SbBool | getConnectedField (SoField *&writingField) const |
| Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField. | |
| SbBool | getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const |
| Returns the VRMLInterpolator output field is connected to. | |
| int | getForwardConnections (SoFieldList &list) const |
| Adds references 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 object that contains this field. | |
| SoNONUNICODE SbBool | set (const char *valueString) |
| Sets the field to the given value, which is an ASCII string in the Open Inventor file format. | |
| SbBool | set (const SbString &valueString) |
| Sets the field to the given value, which is an ASCII string in the Open Inventor file format. | |
| void | get (SbString &valueString) |
| Returns the value of the field in the Open Inventor file format, even if the field has its default value. | |
| virtual size_t | getValueSize () const |
| Gets the size of the 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. | |
| int | operator== (const SoField &f) const |
| Return TRUE if this field is of the same type and has the same value as f. | |
| int | operator!= (const SoField &f) const |
| Return FALSE if this field is of the same type and has the same value as f. | |
| Public Member Functions inherited from SoTypedObject | |
| virtual SoType | getTypeId () const =0 |
| Returns the type identifier for a specific instance. | |
| SbBool | isOfType (const SoType &type) const |
| Returns TRUE if this object is of the type specified in type or is derived from that type. | |
| template<typename TypedObjectClass > | |
| SbBool | isOfType () const |
| Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Abstract base class for all single-value fields.
Each class derived from SoSField begins with an SoSF prefix and contains one value of a particular type. Each has setValue() and getValue() methods that are used to change or access this value. In addition, some field classes have extra convenience routines that allow values to be set or retrieved in other related formats (see below).
In addition to setValue(), all single-value fields overload the "=" assignment operator to set the field value from the correct datatype or from another field instance of the same type.
The value of a single-value field is written to file in a format dependent on the field type; see the subclass reference pages for details.
A field that is ignored has a tilde (~) either in place of the value (if the actual value is the default) or after it (otherwise).
Definition at line 93 of file SoSField.h.
|
static |
Return the type identifier for this field class.
1.9.8 