Click or drag to resize
SoSelectOne Class

Selects one value from a multiple-value field.

Inheritance Hierarchy

Namespace: OIV.Inventor.Engines
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)
Syntax
public sealed class SoSelectOne : SoEngine

The SoSelectOne type exposes the following members.

Constructors
  NameDescription
Public methodSoSelectOne

Constructor.

Top
Methods
  NameDescription
Public methodCopy

Creates and returns an exact copy of the engine.

(Inherited from SoEngine.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetOutput

Returns a reference to the engine output with the given name.

(Inherited from SoEngine.)
Public methodGetOutputName

Returns (in outputName) the name of the engine output (output).

(Inherited from SoEngine.)
Public methodGetOutputs

Returns a list of outputs in this engine.

(Inherited from SoEngine.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Top
Properties
  NameDescription
Public propertyindex

Index of the value to select from the multiple-value field.

Public propertyinput

The multiple-value field from which the value will be selected.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyoutput

( lt ) The single value selected.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This engine selects a single value from a multiple-value field, based on the input field OIV.Inventor.Engines.SoSelectOne.index. The type of the input field can be any subclass of OIV.Inventor.Fields.SoMField, and the type of the output is the corresponding subclass of OIV.Inventor.Fields.SoSField. For example, if the input type is OIV.Inventor.Fields.SoMFVec3f, the output type will be OIV.Inventor.Fields.SoSFVec3f. The type is specified when an instance of the class is created. For example, OIV.Inventor.Engines.SoSelectOne creates an engine that selects one floating-point value.

Note that by default OIV.Inventor.Engines.SoSelectOne.input does not contain any values, and no value is output from the engine.

FILE FORMAT/DEFAULT

SelectOne {
type <inputType>
input []
index 0
}

See Also