Class TCasScriptMatrix3d

Execute and calculate this expression.

Returned value is owned by this object. Which should be comfortable for you usually, as you do not have to worry about freeing it. Also, it allows us to make various optimizations to avoid creating/destroying lots of temporary TCasScriptExpression instances during calculation of complex expression.

The disadvantage of this is that returned object value is valid only until you executed this same expression again, or until you freed this expression. If you need to remember the execute result for longer, you have to copy it somewhere. For example you can do

{ This will always work, thanks to virtual TCasScriptValue.Create
  and AssignValue methods. }
Copy := TCasScriptValue(ReturnedValue.ClassType).Create;
Copy.AssignValue(ReturnedValue);

Exceptions raised

ECasScriptError

Execute is guaranteed to raise an ECasScriptError exception if some calculation fails because of invalid arguments.

This means that when you run CastleScript expression provided by the user, you only have to catch ECasScriptError to be safe from errors produced by user. No need to catch something more general like Exception class.

Also it's guaranteed that no hanging floating-point errors are left. Normally, there is no guarantee that floating-point errors are raised immediately, they may be raised at the next fp operation (this is needed for fp operations to proceed in parallel, and be much faster). For executing CastleScript, Execute calls Math.ClearExceptions(true) to make sure that all floating point errors are caught. This ensures that we can safely execute even invalid expressions (like 'ln(-3)') and get reliable exceptions.

Floating-point errors of course also result in ECasScriptError descendants. More specifically, EIntError and EMathError result in ECasScriptAnyMathError.

Source: castlescript/castlescript.pas (line 161).

Try to execute expression, or return Nil if a mathematical error occurred within expression. "Math error within expression" means that a ECasScriptAnyMathError exception occurred while calculating expression.

This is useful to secure you against math arguments errors ('ln(-3)', 'sqrt(-3)') but still raises normal exception on other ECasScriptError errors (like invalid argument type for function).

Source: castlescript/castlescript.pas (line 170).

Execute expression, return the result as a simple float value. It assumes that the expression is written to always return float. To easily create such expression, use ParseFloatExpression.

Source: castlescript/castlescript.pas (line 175).

Execute expression, return the result as a simple integer value. It assumes that the expression is written to always return integer. To easily create such expression, use ParseIntExpression.

Source: castlescript/castlescript.pas (line 180).

Execute expression, return the result as a simple string value. It assumes that the expression is written to always return string. To easily create such expression, use ParseStringExpression.

Source: castlescript/castlescript.pas (line 185).

Execute expression, return the result as a simple boolean value. It assumes that the expression is written to always return boolean. To easily create such expression, use ParseBoolExpression.

Source: castlescript/castlescript.pas (line 190).

Call Free, but only if this is not TCasScriptValue with OwnedByParentExpression = false. (This cannot be implemented cleanly, as virtual procedure, since it must work when Self is Nil, and then virtual method table is not available of course.)

Source: castlescript/castlescript.pas (line 196).

This item has no description.

Source: castlescript/castlescript.pas (line 224).

Assign value from Source to Self.

Exceptions raised

ECasScriptAssignError

if assignment is not possible because types don't match.

Source: castlescript/castlescript.pas (line 244).

This item has no description. Showing description inherited from TCasScriptValue.AssignValue.

Assign value from Source to Self.

Source: castlescript/castlescriptvectors.pas (line 159).

Environment (outside information) for this expression. May be Nil. This object is not owned by TCasScriptExpression, will not be freed by TCasScriptExpression and such.

Source: castlescript/castlescript.pas (line 201).

Is this value writeable. If not, this will not be allowed to change by CastleScript assignment and such functions. Note that Writeable = False will not prevent you from changing value internally, by AssignValue or changin Value property directly (that would be too uncomfortable).

Source: castlescript/castlescript.pas (line 231).

This item has no description.

Source: castlescript/castlescript.pas (line 233).

Name of this value, or '' if not named. Named value can be recognized in expressions by CastleScriptParser.

Source: castlescript/castlescript.pas (line 239).

Set to True on each assign to Value. You can reset it at any time to False.

This allows the caller to know which variables were assigned during script execution, which is useful if changes to CastleScript variables should be propagated to some other things after the script finished execution. This is essential for behavior in VRML/X3D Script node.

Descendants note: you have to set this to True in SetValue.

Source: castlescript/castlescript.pas (line 256).

This item has no description.

Source: castlescript/castlescriptvectors.pas (line 157).