SoSField Class

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: 10.12.3.0 (10.12.3.0)

Syntax

C++

Copy

public class SoSField : SoField

Public Class SoSField
	Inherits SoField

public ref class SoSField : public SoField

type SoSField =  
    class
        inherit SoField
    end

The SoSField type exposes the following members.

Methods

	Name	Description
	AppendConnection(SoEngineOutput)	Appends this field to the list of connections from another engineOutput. (Inherited from SoField.)
	AppendConnection(SoField)	Appends this field to the list of connections from another field. (Inherited from SoField.)
	ConnectFrom(SoEngineOutput)	Connects this field from an engine output. (Inherited from SoField.)
	ConnectFrom(SoField)	Connects this field to another field. (Inherited from SoField.)
	Disconnect	Disconnect the field from whatever it was connected to. (Inherited from SoField.)
	Disconnect(SoEngineOutput)	Disconnect the field from the requested engineOutput. (Inherited from SoField.)
	Disconnect(SoField)	Disconnect the field from the requested field. (Inherited from SoField.)
	EnableConnection	Field connections may be enabled and disabled. (Inherited from SoField.)
	Equals	(Inherited from SoField.)
	Get	Returns the value of the field in the Open Inventor file format, even if the field has its default value. (Inherited from SoField.)
	GetConnectedEngine	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.)
	GetConnectedField	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.)
	GetConnections	Returns a list of the connections to this field. (Inherited from SoField.)
	GetContainer	Returns the object that contains this field. (Inherited from SoField.)
	GetForwardConnections	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.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetNumConnections	Returns the number of connections to this field. (Inherited from SoField.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValueSize	Gets the size of the value. (Inherited from SoField.)
	IsConnected	Returns true if the field is connected to anything. (Inherited from SoField.)
	IsConnectedFromEngine	Returns true if the field is connected to an engine's output. (Inherited from SoField.)
	IsConnectedFromField	Returns true if the field is connected to another field. (Inherited from SoField.)
	IsConnectedFromVRMLInterp	Returns true if the field is connected to a VRML interpOutput. (Inherited from SoField.)
	IsConnectionEnabled	Returns false if connections to this field are disabled. (Inherited from SoField.)
	IsDefault	Gets the state of default flag of the field. (Inherited from SoField.)
	IsIgnored	Gets the ignore flag for this field. (Inherited from SoField.)
	Set	Sets the field to the given value, which is an ASCII string in the Open Inventor file format. (Inherited from SoField.)
	SetIgnored	Sets the ignore flag for this field. (Inherited from SoField.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	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. (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).

Reference

OIV.Inventor.Fields Namespace

OIV.Inventor.Fields.SoField

OIV.Inventor.Fields.SoMField

Inheritance Hierarchy