Click or drag to resize
SoEngine Class

Base class for all engines.

Inheritance Hierarchy

Namespace: OIV.Inventor.Engines
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.12.0 (9.9.12.0)
Syntax
public abstract class SoEngine : SoFieldContainer

The SoEngine type exposes the following members.

Methods
  NameDescription
Public methodCopy

Creates and returns an exact copy of the engine.

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 methodStatic memberGetByName(String)

Looks up engine(s) by name.

Public methodStatic memberGetByName(String, SoEngineList)

Looks up engine(s) by name.

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 methodStatic memberGetInstanceManagedType
Gets a managed engine for the given native engine handle.
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetOutput

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

Public methodGetOutputName

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

Public methodGetOutputs

Returns a list of outputs in this engine.

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 propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

SoEngine is the abstract base class for all engines. Engines are objects used for animation and behavior. They are lightweight objects that are connected between nodes, the clock, and other engines to form interesting behaviorial objects (e.g., a spinning windmill).

Engines are used to animate parts of a scene and/or to constrain one part of a scene in relation to some other part of the scene. An engine receives a number of input values, performs some operation on them, and then copies the results into one or more output fields. Both the inputs and the outputs can be connected to other fields or engines in the scene graph. When an engine's output values change, those new values are sent to any fields or engines connected to them.

FILE FORMAT/DEFAULT

This is an abstract class. See the reference page of a derived class for the format and default values.

See Also

Reference

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.EnginesSoEngine
            OIV.ImageViz.EnginesSoImageVizEngine
            OIV.Inventor.EnginesSoBoolOperation
            OIV.Inventor.EnginesSoCalculator
            OIV.Inventor.EnginesSoComposeMatrix
            OIV.Inventor.EnginesSoComposeRotation
            OIV.Inventor.EnginesSoComposeRotationFromTo
            OIV.Inventor.EnginesSoComposeVec2f
            OIV.Inventor.EnginesSoComposeVec2i32
            OIV.Inventor.EnginesSoComposeVec2s
            OIV.Inventor.EnginesSoComposeVec3f
            OIV.Inventor.EnginesSoComposeVec4f
            OIV.Inventor.EnginesSoComputeBoundingBox
            OIV.Inventor.EnginesSoConcatenate
            OIV.Inventor.EnginesSoCounter
            OIV.Inventor.EnginesSoDecomposeMatrix
            OIV.Inventor.EnginesSoDecomposeRotation
            OIV.Inventor.EnginesSoDecomposeVec2f
            OIV.Inventor.EnginesSoDecomposeVec2i32
            OIV.Inventor.EnginesSoDecomposeVec2s
            OIV.Inventor.EnginesSoDecomposeVec3f
            OIV.Inventor.EnginesSoDecomposeVec4f
            OIV.Inventor.EnginesSoElapsedTime
            OIV.Inventor.EnginesSoGate
            OIV.Inventor.EnginesSoInterpolate
            OIV.Inventor.EnginesSoOneShot
            OIV.Inventor.EnginesSoOnOff
            OIV.Inventor.EnginesSoSelectOne
            OIV.Inventor.EnginesSoTimeCounter
            OIV.Inventor.EnginesSoTrackFollower
            OIV.Inventor.EnginesSoTransformVec3f
            OIV.Inventor.EnginesSoTriggerAny