Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Math"

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...")
 
(No difference)

Latest revision as of 22:56, 24 August 2020

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type Function and Description
void Math_CatmullRom(cVector3f &out avResult, const cVector3f &in avP0, const cVector3f &in avP1, const cVector3f &in avP2, const cVector3f &in avP3, float afFract)
A function that gives you a point along a spline made up of four points

Function Detail

Math_CatmullRom

void Math_CatmullRom(cVector3f &out avResult,
                     const cVector3f &in avP0,
                     const cVector3f &in avP1,
                     const cVector3f &in avP2,
                     const cVector3f &in avP3,
                     float afFract)

A function that gives you a point along a spline made up of four points. The spline is guaranteed to hit the second and third points.

Parameters

  • avResult (cVector3f) — the resulting point on the spline.
  • avP0 (cVector3f) — the first point.
  • avP1 (cVector3f) — the second point.
  • avP2 (cVector3f) — the third point.
  • avP3 (cVector3f) — the fourth point.
  • afFract (float) — the normalized distance along the spline to check. 0 is at the second point, 1 is at the third point. Should not go out of the range 0-1.

Returns:

  • void