| SoShuttle Class |
Animated oscillating translation node.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoTransformation
OIV.Inventor.NodesSoTranslation
OIV.Inventor.NodesSoShuttle
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoShuttle type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoTranslation.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoTranslation.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoTranslation.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoTranslation.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoTranslation.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoTranslation.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoTransformation.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoTranslation.) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | 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. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| on | Allows applications to enable or disable the motion easily. |
| speed | Defines the speed of the shuttle, in cycles per second. |
| translation | Translation vector. |
| translation0 | |
| translation1 | These define the two fixed translations that are interpolated to create the shuttling motion. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThe OIV.Inventor.Nodes.SoShuttle class is derived from OIV.Inventor.Nodes.SoTranslation, so it applies a translation to the current transformation. Using engines connected to the realTime global field, the translation value is animated over time between two fixed translations, achieving a shuttling effect. The period of the motion can be adjusted by changing the OIV.Inventor.Nodes.SoShuttle.speed field. The current translation at any time is available in the translation field, inherited from OIV.Inventor.Nodes.SoTranslation
FILE FORMAT/DEFAULT
Shuttle {
| translation | 0 0 0 |
| translation0 | 0 0 0 |
| translation1 | 0 0 0 |
| speed | 1 |
| on | true |
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction, OIV.Inventor.Actions.SoGetBoundingBoxAction, OIV.Inventor.Actions.SoRayPickAction Concatenates interpolated translation value with the current transformation matrix.
OIV.Inventor.Actions.SoGetMatrixAction Returns transformation matrix specified by the interpolated translation.
See Also