Click or drag to resize
SoSField Class

Abstract base class for all single-value fields.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.FieldsSoField
      OIV.Inventor.FieldsSoSField
        More...

Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
Syntax
public class SoSField : SoField

The SoSField type exposes the following members.

Methods
  NameDescription
Public methodAppendConnection(SoEngineOutput)

Appends this field to the list of connections from another engineOutput.

(Inherited from SoField.)
Public methodAppendConnection(SoField)

Appends this field to the list of connections from another field.

(Inherited from SoField.)
Public methodConnectFrom(SoEngineOutput)

Connects this field from an engine output.

(Inherited from SoField.)
Public methodConnectFrom(SoField)

Connects this field to another field.

(Inherited from SoField.)
Public methodDisconnect

Disconnect the field from whatever it was connected to.

(Inherited from SoField.)
Public methodDisconnect(SoEngineOutput)

Disconnect the field from the requested engineOutput.

(Inherited from SoField.)
Public methodDisconnect(SoField)

Disconnect the field from the requested field.

(Inherited from SoField.)
Public methodEnableConnection

Field connections may be enabled and disabled.

(Inherited from SoField.)
Public methodEquals
(Inherited from SoField.)
Public methodGet

Returns the value of the field in the Open Inventor file format, even if the field has its default value.

(Inherited from SoField.)
Public methodGetConnectedEngine

Returns true if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.

(Inherited from SoField.)
Public methodGetConnectedField

Returns true if this field is being written into by another field, and returns the field it is connected to in writingField.

(Inherited from SoField.)
Public methodGetConnections

Returns a list of the connections to this field.

(Inherited from SoField.)
Public methodGetContainer

Returns the object that contains this field.

(Inherited from SoField.)
Public methodGetForwardConnections

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.

(Inherited from SoField.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetNumConnections

Returns the number of connections to this field.

(Inherited from SoField.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValueSize

Gets the size of the value.

(Inherited from SoField.)
Public methodIsConnected

Returns true if the field is connected to anything.

(Inherited from SoField.)
Public methodIsConnectedFromEngine

Returns true if the field is connected to an engine's output.

(Inherited from SoField.)
Public methodIsConnectedFromField

Returns true if the field is connected to another field.

(Inherited from SoField.)
Public methodIsConnectedFromVRMLInterp

Returns true if the field is connected to a VRML interpOutput.

(Inherited from SoField.)
Public methodIsConnectionEnabled

Returns false if connections to this field are disabled.

(Inherited from SoField.)
Public methodIsDefault

Gets the state of default flag of the field.

(Inherited from SoField.)
Public methodIsIgnored

Gets the ignore flag for this field.

(Inherited from SoField.)
Public methodSet

Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

(Inherited from SoField.)
Public methodSetIgnored

Sets the ignore flag for this field.

(Inherited from SoField.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTouch

Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.

(Inherited from SoField.)
Top
Remarks

Each class derived from OIV.Inventor.Fields.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).

See Also
Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.FieldsSoField
      OIV.Inventor.FieldsSoSField
        OIV.Inventor.FieldsSoSFArray
        OIV.Inventor.FieldsSoSFBool
        OIV.Inventor.FieldsSoSFBox2f
        OIV.Inventor.FieldsSoSFBox3f
        OIV.Inventor.FieldsSoSFBox3i32
        OIV.Inventor.FieldsSoSFBox3s
        OIV.Inventor.FieldsSoSFBox4i32
        OIV.Inventor.FieldsSoSFBufferObject
        OIV.Inventor.FieldsSoSFColor
        OIV.Inventor.FieldsSoSFColorRGBA
        OIV.Inventor.FieldsSoSFDouble
        OIV.Inventor.FieldsSoSFEngine
        OIV.Inventor.FieldsSoSFEnumEnumType
        OIV.Inventor.FieldsSoSFFieldContainer
        OIV.Inventor.FieldsSoSFFloat
        OIV.Inventor.FieldsSoSFImage
        OIV.Inventor.FieldsSoSFImage3
        OIV.Inventor.FieldsSoSFInt32
        OIV.Inventor.FieldsSoSFInt64
        OIV.Inventor.FieldsSoSFMatrix
        OIV.Inventor.FieldsSoSFMatrix3
        OIV.Inventor.FieldsSoSFMemObj
        OIV.Inventor.FieldsSoSFName
        OIV.Inventor.FieldsSoSFNode
        OIV.Inventor.FieldsSoSFPath
        OIV.Inventor.FieldsSoSFPlane
        OIV.Inventor.FieldsSoSFRotation
        OIV.Inventor.FieldsSoSFShort
        OIV.Inventor.FieldsSoSFString
        OIV.Inventor.FieldsSoSFTime
        OIV.Inventor.FieldsSoSFTrigger
        OIV.Inventor.FieldsSoSFUByte
        OIV.Inventor.FieldsSoSFUInt32
        OIV.Inventor.FieldsSoSFUShort
        OIV.Inventor.FieldsSoSFVec2d
        OIV.Inventor.FieldsSoSFVec2f
        OIV.Inventor.FieldsSoSFVec2i32
        OIV.Inventor.FieldsSoSFVec2s
        OIV.Inventor.FieldsSoSFVec3d
        OIV.Inventor.FieldsSoSFVec3f
        OIV.Inventor.FieldsSoSFVec3i32
        OIV.Inventor.FieldsSoSFVec4f
        OIV.Inventor.FieldsSoSFVec4i32
        OIV.MeshViz.FieldsPoSFMesh