SoField.3coin4 - Man Page

enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD, EXPOSED_FIELD }

virtual ~SoField ()
void setIgnored (SbBool ignore)
SbBool isIgnored (void) const
void setDefault (SbBool defaultVal)
SbBool isDefault (void) const
virtual SoType getTypeId (void) const =0
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
void disconnect (SoField *field)
SbBool isConnectedFromField (void) const
SbBool getConnectedField (SoField *&master) const
int getNumConnections (void) const
int getForwardConnections (SoFieldList &slavelist) const
int getConnections (SoFieldList &masterlist) const
void disconnect (void)
SbBool isConnected (void) const
void setContainer (SoFieldContainer *cont)
SoFieldContainer * getContainer (void) const
SbBool set (const char *valuestring)
void get (SbString &valuestring)
SbBool shouldWrite (void) const
virtual void touch (void)
virtual void startNotify (void)
virtual void notify (SoNotList *nlist)
SbBool enableNotify (SbBool on)
SbBool isNotifyEnabled (void) const
void addAuditor (void *f, SoNotRec::Type type)
void removeAuditor (void *f, SoNotRec::Type type)
int operator== (const SoField &f) const
int operator!= (const SoField &f) const
virtual void connectionStatusChanged (int numconnections)
SbBool isReadOnly (void) const
virtual SbBool isSame (const SoField &f) const =0
virtual void copyFrom (const SoField &f)=0
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const
void copyConnection (const SoField *fromfield)
virtual SbBool read (SoInput *input, const SbName &name)
virtual void write (SoOutput *out, const SbName &name) const
virtual void countWriteRefs (SoOutput *out) const
void setFieldType (int type)
int getFieldType (void) const
SbBool getDirty (void) const
void setDirty (SbBool dirty)
void evaluate (void) const

static void initClass (void)
static void initClasses (void)
static void cleanupClass (void)
static SoType getClassTypeId (void)

SoField (void)
void valueChanged (SbBool resetdefault=TRUE)
virtual void evaluateConnection (void) const
virtual SbBool readValue (SoInput *in)=0
virtual void writeValue (SoOutput *out) const =0
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const
virtual SoNotRec createNotRec (SoBase *cont)

Destructor. Disconnects ourself from any connected field or engine before we disconnect all auditors on the field.

This is the base constructor for field classes. It takes care of doing the common parts of data initialization in fields.

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

Initialize all the field classes.

This static method cleans up static data of the SoField class.

Sets the flag which indicates whether or not the field should be ignored during certain operations.

The effect of this flag depends on what type of field it is used on, and the type of the node which includes the field.

This flag is represented in Inventor files by a ~ behind the field name. The flag is in other words persistent.

See also

isIgnored()

Returns the ignore flag.

See also

setIgnored()

Set whether or not this field should be marked as containing a default value.

See also

isDefault()

Check if the field contains its default value. Fields which have their default value intact will normally not be included in the output when writing scene graphs out to a file, for instance.

See also

setDefault()

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also

getClassTypeId(), SoType

Implemented in SoMFBitMask, SoMFBool, SoMFColor, SoMFColorRGBA, SoMFDouble, SoMFEngine, SoMFEnum, SoMFFloat, SoMFInt32, SoMFMatrix, SoMFName, SoMFNode, SoMFPath, SoMFPlane, SoMFRotation, SoMFShort, SoMFString, SoMFTime, SoMFUInt32, SoMFUShort, SoMFVec2b, SoMFVec2d, SoMFVec2f, SoMFVec2i32, SoMFVec2s, SoMFVec3b, SoMFVec3d, SoMFVec3f, SoMFVec3i32, SoMFVec3s, SoMFVec4b, SoMFVec4d, SoMFVec4f, SoMFVec4i32, SoMFVec4s, SoMFVec4ub, SoMFVec4ui32, SoMFVec4us, SoSFBitMask, SoSFBool, SoSFBox2d, SoSFBox2f, SoSFBox2i32, SoSFBox2s, SoSFBox3d, SoSFBox3f, SoSFBox3i32, SoSFBox3s, SoSFColor, SoSFColorRGBA, SoSFDouble, SoSFEngine, SoSFEnum, SoSFFloat, SoSFImage, SoSFImage3, SoSFInt32, SoSFMatrix, SoSFName, SoSFNode, SoSFPath, SoSFPlane, SoSFRotation, SoSFShort, SoSFString, SoSFTime, SoSFTrigger, SoSFUInt32, SoSFUShort, SoSFVec2b, SoSFVec2d, SoSFVec2f, SoSFVec2i32, SoSFVec2s, SoSFVec3b, SoSFVec3d, SoSFVec3f, SoSFVec3i32, SoSFVec3s, SoSFVec4b, SoSFVec4d, SoSFVec4f, SoSFVec4i32, SoSFVec4s, SoSFVec4ub, SoSFVec4ui32, and SoSFVec4us.

Returns a unique type identifier for this field class.

See also

getTypeId(), SoType

Check if this instance is of a derived type or is the same type as the one given with the type parameter.

This sets a flag value which indicates whether or not the set up connection should be considered active. For as long as the 'enable connection' flag is FALSE, no value propagation will be done from any connected source field, engine or interpolator into this field.

If the connection is first disabled and then enabled again, the field will automatically be synchronized with any master field, engine or interpolator.

See also

isConnectionEnabled()

Return the current status of the connection enabled flag.

See also

enableConnection()

Connects this field as a slave to master. This means that the value of this field will be automatically updated when master is changed (as long as the connection also is enabled).

If this field had any master-relationships beforehand, these are all broken up if append is FALSE.

Call with notnotify if you want to avoid the initial notification of connected auditors (a.k.a. slaves).

Function will return TRUE unless:

• If the field output connected from is of a different type from the engine output field-type connected to, a field converter is inserted. For some combinations of fields no such conversion is possible, and we'll return FALSE.
• If this field is already connected to the master, we will return FALSE.

See also

enableConnection(), isConnectionEnabled(), isConnectedFromField()

getConnectedField(), appendConnection(SoEngineOutput *)

Connect ourself as slave to another object, while still keeping the other connections currently in place.

See also

connectFrom()

Disconnect this field as a slave from master.

Returns TRUE if we're connected from an engine.

See also

isConnected(), isConnectedFromField()

connectFrom(SoEngineOutput *)

Returns TRUE if we are connected as a slave to at least one engine. master will be set to the source of the last engine connection made.

See also

isConnectedFromEngine(), connectFrom(SoEngineOutput *)

appendConnection(SoEngineOutput *)

Connects this field as a slave to master. This means that the value of this field will be automatically updated when master is changed (as long as the connection also is enabled).

If this field had any connections to master fields beforehand, these are all broken up if append is FALSE.

Call with notnotify if you want to avoid the initial notification of connected auditors (a.k.a. slaves).

Function will return TRUE unless:

• If the field connected from has a different type from the field connected to, a field converter is inserted. For some combinations of fields no such conversion is possible, and we'll return FALSE.
• If this field is already connected to the master, we will return FALSE.

See also

enableConnection(), isConnectionEnabled(), isConnectedFromField()

getConnectedField(), appendConnection(SoField *)

Connect ourself as slave to another object, while still keeping the other connections currently in place.

See also

connectFrom()

Disconnect this field as a slave from master.

Returns TRUE if we're a slave of at least one field.

See also

isConnected(), isConnectedFromEngine()

connectFrom(SoField *)

Returns TRUE if we are connected as a slave to at least one other field. master will be set to the source field in the last field connection made.

See also

isConnectedFromField(), connectFrom(SoField *),

appendConnection(SoField *)

Returns number of fields this field is a slave of.

See also

getConnections()

Appends all the fields which are auditing this field in slavelist, and returns the number of fields which are our slaves.

Returns number of masters this field is connected to, and places pointers to all of them into masterlist.

Note that we replace the contents of masterlist, i.e. we're not appending new data.

See also

getNumConnections()

Disconnect all connections from this field as a slave to master fields or engine outputs.

Returns TRUE if we're connected from another field, engine or interpolator.

See also

isConnectedFromField(), isConnectedFromEngine()

connectFrom()

Let the field know to which container it belongs.

See also

getContainer(), SoFieldContainer

Returns the SoFieldContainer object 'owning' this field.

See also

SoFieldContainer, setContainer()

Set the field's value through the given valuestring. The format of the string must adhere to the ASCII format used in Coin data format files.

Only the value should be specified - not the name of the field.

FALSE is returned if the field value is invalid for the field type and can't be parsed in any sensible way.

See also

get()

Returns the field's value as an ASCII string in the export data format for Inventor files.

See also

set()

Returns TRUE if it is necessary to write the field when dumping a scene graph. This needs to be done if the field is not default (it has been changed from its default value), if it is ignored, or if it is connected from another field or engine.

Notify the field as well as the field's owner / container that it has been changed.

Touching a field which is part of any component (engine or node) in a scene graph will lead to a forced redraw. This is useful if you have been doing several updates to the field wrapped in a pair of enableNotify() calls to notify the field's auditors that its value has changed.

See also

setValue(), enableNotify()

Reimplemented in SoSFTrigger.

Trigger a notification sequence.

At the end of a notification sequence, all 'immediate' sensors (i.e. sensors set up with a zero priority) are triggered.

Reimplemented in SoSFTrigger.

Notify auditors that this field has changed.

Reimplemented in SoMFPath, SoSFPath, and SoSFTrigger.

This method sets whether notification will be propagated on changing the value of the field. The old value of the setting is returned.

See also

isNotifyEnabled()

This method returns whether notification of changes to the field value are propagated to the auditors.

See also

enableNotify()

Add an auditor to the list. All auditors will be notified whenever this field changes its value(s).

Remove an auditor from the list.

Checks for equality. Returns 0 if the fields are of different type or the field's value(s) are not equal.

Returns TRUE if the fields are of different type or have different value.

Called whenever another slave attaches or detaches itself to us. numconnections is the difference in number of connections made (i.e. if stuff is disconnected, numconnections will be a negative number).

The default method is empty. Override in subclasses if you want do something special on connections/disconnections.

Returns TRUE if this field should not be written into at the moment the method is called.

This method is used internally in Coin during notification and evaluation processes, and should normally not be of interest to the application programmer.

Check for equal type and value(s).

Implemented in SoMFBitMask, SoMFBool, SoMFColor, SoMFColorRGBA, SoMFDouble, SoMFEngine, SoMFEnum, SoMFFloat, SoMFInt32, SoMFMatrix, SoMFName, SoMFNode, SoMFPath, SoMFPlane, SoMFRotation, SoMFShort, SoMFString, SoMFTime, SoMFUInt32, SoMFUShort, SoMFVec2b, SoMFVec2d, SoMFVec2f, SoMFVec2i32, SoMFVec2s, SoMFVec3b, SoMFVec3d, SoMFVec3f, SoMFVec3i32, SoMFVec3s, SoMFVec4b, SoMFVec4d, SoMFVec4f, SoMFVec4i32, SoMFVec4s, SoMFVec4ub, SoMFVec4ui32, SoMFVec4us, SoSFBitMask, SoSFBool, SoSFBox2d, SoSFBox2f, SoSFBox2i32, SoSFBox2s, SoSFBox3d, SoSFBox3f, SoSFBox3i32, SoSFBox3s, SoSFColor, SoSFColorRGBA, SoSFDouble, SoSFEngine, SoSFEnum, SoSFFloat, SoSFImage, SoSFImage3, SoSFInt32, SoSFMatrix, SoSFName, SoSFNode, SoSFPath, SoSFPlane, SoSFRotation, SoSFShort, SoSFString, SoSFTime, SoSFTrigger, SoSFUInt32, SoSFUShort, SoSFVec2b, SoSFVec2d, SoSFVec2f, SoSFVec2i32, SoSFVec2s, SoSFVec3b, SoSFVec3d, SoSFVec3f, SoSFVec3i32, SoSFVec3s, SoSFVec4b, SoSFVec4d, SoSFVec4f, SoSFVec4i32, SoSFVec4s, SoSFVec4ub, SoSFVec4ui32, and SoSFVec4us.

Copy value(s) from f into this field. f must be of the same type as this field.

Implemented in SoMFBitMask, SoMFBool, SoMFColor, SoMFColorRGBA, SoMFDouble, SoMFEngine, SoMFEnum, SoMFFloat, SoMFInt32, SoMFMatrix, SoMFName, SoMFNode, SoMFPath, SoMFPlane, SoMFRotation, SoMFShort, SoMFString, SoMFTime, SoMFUInt32, SoMFUShort, SoMFVec2b, SoMFVec2d, SoMFVec2f, SoMFVec2i32, SoMFVec2s, SoMFVec3b, SoMFVec3d, SoMFVec3f, SoMFVec3i32, SoMFVec3s, SoMFVec4b, SoMFVec4d, SoMFVec4f, SoMFVec4i32, SoMFVec4s, SoMFVec4ub, SoMFVec4ui32, SoMFVec4us, SoSFBitMask, SoSFBool, SoSFBox2d, SoSFBox2f, SoSFBox2i32, SoSFBox2s, SoSFBox3d, SoSFBox3f, SoSFBox3i32, SoSFBox3s, SoSFColor, SoSFColorRGBA, SoSFDouble, SoSFEngine, SoSFEnum, SoSFFloat, SoSFImage, SoSFImage3, SoSFInt32, SoSFMatrix, SoSFName, SoSFNode, SoSFPath, SoSFPlane, SoSFRotation, SoSFShort, SoSFString, SoSFTime, SoSFTrigger, SoSFUInt32, SoSFUShort, SoSFVec2b, SoSFVec2d, SoSFVec2f, SoSFVec2i32, SoSFVec2s, SoSFVec3b, SoSFVec3d, SoSFVec3f, SoSFVec3i32, SoSFVec3s, SoSFVec4b, SoSFVec4d, SoSFVec4f, SoSFVec4i32, SoSFVec4s, SoSFVec4ub, SoSFVec4ui32, and SoSFVec4us.

This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing.

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.

Reimplemented in SoMFEngine, SoMFNode, SoMFPath, SoSFEngine, SoSFNode, and SoSFPath.

Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

Note that this method only is valid to call during copy operations.

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method as well.

Reimplemented in SoMFEngine, SoMFNode, SoMFPath, SoSFEngine, SoSFNode, and SoSFPath.

If fromfield contains a connection to another field, make this field also use the same connection.

Reads and sets the value of this field from the given SoInput instance. Returns FALSE if the field value cannot be parsed from the input.

The second argument is the field's context-specific name, which is typically its unique identifier in its field container.

See also

set(), write()

Write the value of the field to the given SoOutput instance (which can be either a memory buffer or a file, in ASCII or in binary format).

See also

get(), read(), SoOutput

This method is called during the first pass of write operations, to count the number of write references to this field and to 'forward' the reference counting operation to the field containers we're connected to.

Set type of this field.

The possible values for type is: 0 for ordinary fields, 1 for eventIn fields, 2 for eventOut fields, 3 for internal fields, 4 for VRML2 exposedField fields. There are also enum values in SoField.h.

Return the type of this field.

See also

setFieldType()

Do we need re-evaluation?

Mark field for re-evaluation (upon next read operation), but do not trigger a notification.

Re-evaluates the value of this field any time a getValue() call is made and the field is marked dirty. This is done in this way to gain the advantages of having lazy evaluation.

This method is always called whenever the field's value has been changed by direct invocation of setValue() or some such. You should never call this method from anywhere in the code where the field value is being set through an evaluation of its connections.

If resetdefault is TRUE, the flag marking whether or not the field has its default value will be set to FALSE.

The method will also notify any auditors that the field's value has changed.

If we're connected to a field/engine/interpolator, copy the value from the master source.

Read field value(s).

Write field value(s).

Read the master field of a field-to-field connection (and its field container).

If input parsing is successful, this field will be connected as a slave to the master field.

Note that this slave field will not be marked as 'dirty' upon connection, i.e. it will retain its value until the first update of the master field is made after the connection was set up. This to be in conformance with how the Inventor Mentor specifies how field connections should be imported (see page 270).

Write out information about this field's connection.

Can be used to check if a field is being destructed.