Open Inventor.NET

SoCalculator Class |

A general-purpose calculator.

Inheritance Hierarchy

SystemObject

OIV.InventorSoNetBase

OIV.InventorSoDisposable

OIV.Inventor.MiscSoBase

OIV.Inventor.FieldsSoFieldContainer

OIV.Inventor.EnginesSoEngine

OIV.Inventor.EnginesSoCalculator

OIV.InventorSoNetBase

OIV.InventorSoDisposable

OIV.Inventor.MiscSoBase

OIV.Inventor.FieldsSoFieldContainer

OIV.Inventor.EnginesSoEngine

OIV.Inventor.EnginesSoCalculator

Syntax

The SoCalculator type exposes the following members.

Constructors

Name | Description | |
---|---|---|

SoCalculator | Constructor. |

Methods

Name | Description | |
---|---|---|

Copy | Creates and returns an exact copy of the engine. | |

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.) | |

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. | |

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.) | |

GetName | Returns the name of an instance. | |

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

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

GetOutputs | Returns a list of outputs in this engine. | |

GetStringName | (Inherited from SoBase.) | |

GetType | Gets the Type of the current instance. (Inherited from Object.) | |

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

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

IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |

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.) | |

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. |

Properties

Name | Description | |
---|---|---|

a | Floating point input. | |

A | Vector input. | |

b | Floating point input. | |

B | Vector input. | |

c | Floating point input. | |

C | Vector input. | |

d | Floating point input. | |

D | Vector input. | |

e | Floating point input. | |

E | Vector input. | |

expression | Expressions to be evaluated. | |

f | Floating point input. | |

F | Vector input. | |

g | Floating point input. | |

G | Vector input. | |

h | Floating point input. | |

H | Vector input. | |

IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |

oa | (OIV.Inventor.Fields.SoMFFloat) Outputs oa-od are the floating-point values. | |

oA | (OIV.Inventor.Fields.SoMFVec3f) Outputs oA-oD are the vectors. | |

ob | (OIV.Inventor.Fields.SoMFFloat) Outputs oa-od are the floating-point values. | |

oB | (OIV.Inventor.Fields.SoMFVec3f) Outputs oA-oD are the vectors. | |

oc | (OIV.Inventor.Fields.SoMFFloat) Outputs oa-od are the floating-point values. | |

oC | (OIV.Inventor.Fields.SoMFVec3f) Outputs oA-oD are the vectors. | |

od | (OIV.Inventor.Fields.SoMFFloat) Outputs oa-od are the floating-point values. | |

oD | (OIV.Inventor.Fields.SoMFVec3f) Outputs oA-oD are the vectors. | |

UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |

Remarks

This engine is a general-purpose calculator. The calculator operates on floating-point values and 3D floating-point vectors. The engine takes up to eight inputs of each type (OIV.Inventor.Fields.SoMFFloat and OIV.Inventor.Fields.SoMFVec3f), and produces up to four outputs of each type.

Each input field (OIV.Inventor.Engines.SoCalculator.a-OIV.Inventor.Engines.SoCalculator.h, OIV.Inventor.Engines.SoCalculator.A-OIV.Inventor.Engines.SoCalculator.H) can have multiple values, allowing the engine to evaluate the expression with different values in parallel. Some inputs may have more values than others. In such cases, the last value of the shorter inputs will be repeated as necessary.

The OIV.Inventor.Engines.SoCalculator.expression input string specifies the expression to be evaluated. An expression can consist of multiple subexpressions. Several subexpressions can be specified in one string, separated by semicolons (;). Alternatively, the subexpressions can be stored in separate strings in the multiple-valued input field.

Each subexpression is of the form:

\<lhs\> = \<rhs\>The <lhs> can be any one of the outputs or a temporary variable. The engine provides 8 temporary floating-point variables (ta, tb, tc, td, te, tf, tg, and th), and 8 temporary vector variables (tA, tB, tC, tD, tE, tF, tG, and tH). You can assign a value to one component of a vector output (OIV.Inventor.Engines.SoCalculator.A-OIV.Inventor.Engines.SoCalculator.H) or a vector variable (

The <rhs> supports arithmetic, logical and conditional operators. They are:

(unary) !, - (binary) +, -, *, /, \%, <, > <=, >=, ==, !=, &&, || (ternary) ? :The ternary operator is a conditional operator. For example, a ? b : c evaluates to b if a != 0, and to c if a==0.

Valid operands for the <rhs> include the inputs, outputs, temporary variables, and their components (e.g. oA[0]). Operands can also be numeric constants (e.g. 1.0), pre-defined named constants, or pre-defined functions.

The named constants are:

MAXFLOAT MINFLOAT M_E M_LOG2E M_LOG10E M_LN2 M_LN10 M_PI M_SQRT2 = sqrt(2) M_SQRT1_2 = sqrt(1/2)Most of the pre-defined functions come from the math library:

cos, sin, tan, acos, asin, atan, atan2, cosh, sinh, tanh, sqrt, pow, exp, log, log10, ceil, floor, fabs, fmod.Other functions are defined by OIV.Inventor.Engines.SoCalculator. They are:

rand(f) - Random number generator cross(v1, v2) - Vector cross product dot(v1, v2) - Vector dot product length(v) - Vector length normalize(v) - Normalize vector vec3f(f1, f2, f3) - Generate a vector from 3 floatsThe subexpressions are evaluated in order, so a variable set in the <lhs> of an earlier expression may be used in the <rhs> of a later expression.

Note, when the input has multiple values, all the subexpressions specified in the OIV.Inventor.Engines.SoCalculator.expression are applied to all the multiple input values. This is unlike the OIV.Inventor.Engines.SoBoolOperation engine, where each operation is applied only to the corresponding entries of the input data. Note also, that even though the inputs and outputs can have multiple values the [ ] operator is only for indexing into the values of a single vector. It does not index into the multiple values of a field. For example, if the floating-point input field OIV.Inventor.Engines.SoCalculator.a has two values: 1.0, and 2.0, then the expression

"oA[0]=a; oA[1]=a; oA[2]=0.0"will produce two output vectors in OIV.Inventor.Engines.SoCalculator.oA: (1.0, 1.0, 0.0) and (2.0, 2.0, 0.0).

Examples of expressions:

"ta = oA[0]*floor(a)" "tb = (a+b)*sin(M_PI)" "oA = vec3f(ta, tb, ta+tb)" "oB = normalize(oA)" "ta = a; tb = sin(ta); oA = vec3f(ta, tb, 0)"

Calculator {

a | 0 |

b | 0 |

c | 0 |

d | 0 |

e | 0 |

f | 0 |

g | 0 |

h | 0 |

A | 0 0 0 |

B | 0 0 0 |

C | 0 0 0 |

D | 0 0 0 |

E | 0 0 0 |

F | 0 0 0 |

G | 0 0 0 |

H | 0 0 0 |

expression | "" |

See Also