This page guides you through the various classes that make up the Spline system inside MegaShapes. A MegaShape is made up of MegaSplines and each spline is in turn made from MegaKnots. Each MegaShape can have any number of MegaSplines to define its overall shape, each of those MegaSplines can be an open or closed shape and can contain any number of MegaKnots. A MegaKnot is the class which actually holds the position of the knot in local space as well as the position of the handles that control the in and out tangents to the knot.<\/p>\n
If you wish to add more knots to a spline you only need to create a new MegaKnot class using new and then Add the knot to the list or insert it into the list. You can also use the methods shown below to add knots to a spline.<\/p>\n
[cc lang=”c#”]public class MegaKnot
\n{
\n public Vector3 p;
\n public Vector3 invec;
\n public Vector3 outvec;
\n public float seglength;
\n public float length;
\n public bool notlocked;
\n}[\/cc]<\/p>\n
The position in local space of the actual knot<\/p>\n
The position in local space of the in vector handle<\/p>\n
The position in local space of the out vector handle<\/p>\n
The length of this curve segment to the next knot<\/p>\n
The length from the start of the curve to this knot<\/p>\n
Used by the editor to say handles should be locked<\/p>\n
[cc lang=”c#”]public MegaKnot()[\/cc]
\nCreates a new empty knot.<\/p>\n
[cc lang=”c#”]public Vector3 Interpolate(float t, MegaKnot k)[\/cc]<\/p>\n
This will return the local position of a point on the curve segment between the knot and the one passed in, so if t = 0.0f it will return the current knot position, 1 will return the position of the passed in knot k.<\/p>\n
[cc lang=”c#”]public class MegaSpline The length of the spline<\/p>\n Is the spline closed or open<\/p>\n The List of knots that make up this spline<\/p>\n Animation data for the knots<\/p>\n Offset in local space for the spline<\/p>\n Local euler rotation of the spline<\/p>\n Local scale<\/p>\n [cc lang=”c#”]static public MegaSpline Copy(MegaSpline src)[\/cc]<\/p>\n This will return a new copy of the spline passed to it.<\/p>\n [cc lang=”c#”]public void AddKnot(Vector3 p, Vector3 invec, Vector3 outvec)[\/cc]<\/p>\n Will create a new knot from the values passed in and add it to the end of the knot list for this spline. Note a call should be made to MegaShape CalcLength after you have added or changed any knots.<\/p>\n [cc lang=”c#”]public void AddKnot(Vector3 p, Vector3 invec, Vector3 outvec, Matrix4x4 tm)[\/cc]<\/p>\n Will create a new knot from the values passed in transformed by the matrix and add it to the end of the knot list for this spline. Note a call should be made to MegaShape CalcLength after you have added or changed any knots.<\/p>\n [cc lang=”c#”]public bool Contains(Vector3 p)[\/cc]<\/p>\n Will return true if the passed in local space point is inside the spline. If the spline is not closed the method will always return false.<\/p>\n [cc lang=”c#”]public float Area()[\/cc] [cc lang=”c#”]public float CalcLength(int steps)[\/cc]<\/p>\n Calculates the length of the spline. The step value says how many interations to use in the calculation, a value of 1 would do a simple linear distance between each knot, a value of 10 will produce a very accurate length of the curve.<\/p>\n [cc lang=”c#”]public Vector3 Interpolate(float alpha, bool type, ref int k)[\/cc]<\/p>\n Returns a local space position on the spline based on the alpha value passed. An alpha value of 0 will return the start of the spline and 1 to end and 0.5 will return the point half way along the length. The type value says whether to use normalized interpolation which is a little slower but gives a smoother result less prone to speed ups that can be seen in some splines. The value returned in ‘k’ is the knot segment the point is in.<\/p>\n [cc lang=”c#”]public Vector3 InterpCurve3D(float alpha, bool type, ref int k)[\/cc]<\/p>\n This is a more general interpolation method that deals with out of range alpha values correctly, the params are all the same as the above method.<\/p>\n [cc lang=”c#”]public class MegaShape : MonoBehaviour \/\/ Meshing options \/\/ Material 1 The up axis for when a helper shape is generated, normally this is the Y Axis.<\/p>\n First color to use when the spline gizmos are drawn. Two colours are used so you can see how the interpolation will happen along the spline length, this is useful if you for example use the Path Follow helper script shorter sections will move slower than longer ones.<\/p>\n Second color to use when the spline gizmos are drawn. Two colours are used so you can see how the interpolation will happen along the spline length, this is useful if you for example use the Path Follow helper script shorter sections will move slower than longer ones.<\/p>\n Color to use when displaying the knot gizmos.<\/p>\n Color to use when displaying the handle gizmos.<\/p>\n Size of the knot gizmos.<\/p>\n This is the distance the gizmo will step along the spline for each drawn segment, this defines the smoothness of the spline for rendering of the gizmos. This value is also used if the spline is turned into a Mesh so will effect the number of vertices that are generated.<\/p>\n You can choose to have the spline interpolated using a simple linear approach or by using a normalized interpolation. The normalised approach will attempt to keep a more constant step along the spline but is slightly slower.<\/p>\n Whether or not the handle gizmos are drawn.<\/p>\n Whether or not the knots are drawn.<\/p>\n Whether or not the spline is displayed.<\/p>\n If lock handels is on dragging one handle will automatically drag the other handle so keeping the knots continuity. Turn this off if you want to control the sharpness of a corner or wish to have different in and out vectors to a knot.<\/p>\n This is the current position along the shape of the editor curor. The cursor is used when new knots are added to the shape in the editor.<\/p>\n The List of splines that make up this shape. A MegaShape can be made up of any number of splines.<\/p>\n If the shape is animated then the time is used to control the animation.<\/p>\n Turns the animation on or off.<\/p>\n How fast the animation plays back, a value of 1 is normal speed, 0 will stop the animation and a negative value will play the animation backwards.<\/p>\n In editor mode this value controls which spline is currently being edited in the scene.<\/p>\n Unused currently.<\/p>\n If this is on the mesh will be generated or updated, so if the shape is animated set this to true for the mesh to update as the spline changes.<\/p>\n Unused currently.<\/p>\n Will the generated mesh have a back side.<\/p>\n Calculate the tangents for the generated mesh, this is needed for bump mapping etc.<\/p>\n Will UV coordinates be generated for the mesh.<\/p>\n Use physical UV values, this will mean the UV mapping will be based on the vertex positions instead of calculated UV positions.<\/p>\n The height of the extruded mesh generated from the spline.<\/p>\n Not used currently<\/p>\n Not used currently<\/p>\n Not used currently<\/p>\n Not used currently<\/p>\n Not used currently<\/p>\n Not used currently<\/p>\n Not used currently<\/p>\n Value to add to the UV coordinates for the front face of the generated mesh.<\/p>\n Rotation amount of the UV coordinates for the front face of the generated mesh.<\/p>\n Scale amount for the UV coordinates for the front face of the generated mesh.<\/p>\n Offset amount for the UV coordinates for the extruded sides of the generated mesh.<\/p>\n Rotation amount for the UV coordinates for the extruded sides of the generated mesh.<\/p>\n Scale amount for the UV coordinates for the extruded sides of the generated mesh.<\/p>\n Value to add to the UV coordinates for the front face of the generated mesh.<\/p>\n Rotation amount of the UV coordinates for the front face of the generated mesh.<\/p>\n Scale amount for the UV coordinates for the front face of the generated mesh.<\/p>\n Controls whether the Height curve is used in the mesh generation.<\/p>\n The curve to control the Up offset of the mesh along its length.<\/p>\n The value to multiple the height curve by to get the final height adjustment.<\/p>\n [cc lang=”c#”]public MegaSpline NewSpline()[\/cc]<\/p>\n Creates a new empty spline and adds it to the spline list for this shape.<\/p>\n [cc lang=”c#”]public void Scale(float scale)[\/cc]<\/p>\n This will scale the intire shape, so all curves and knots.<\/p>\n [cc lang=”c#”]public float GetCurveLength(int curve)[\/cc]<\/p>\n Will return the length of the curve whose index is passed, if the index is out of range the length of the first curve will be returned.<\/p>\n [cc lang=”c#”]public float CalcLength(int curve, int step)[\/cc]<\/p>\n This will return the length of the curve whoes index is passed in.<\/p>\n [cc lang=”c#”]public float CalcLength(int step)[\/cc]<\/p>\n Use this to recalculate the length of the all the curves that make up the shape. It is important to call this of the method above if you have altered a shape in anyway, if not then the interpolation methods will not be quite right possibly with a alpha value of 1 not being the end of a curve or falling short.<\/p>\n [cc lang=”c#”]public Vector3 GetKnotPos(int curve, int knot)[\/cc]<\/p>\n This will return the local space position of the knot whose index is passed in on the curve whose index is passed in.<\/p>\n [cc lang=”c#”]public Vector3 GetKnotInVec(int curve, int knot)[\/cc]<\/p>\n This will return the local space position of the in vector handle whose index is passed in on the curve whose index is passed in.<\/p>\n [cc lang=”c#”]public Vector3 GetKnotOutVec(int curve, int knot)[\/cc]<\/p>\n This will return the local space position of the out vector handle whose index is passed in on the curve whose index is passed in.<\/p>\n [cc lang=”c#”]public void SetKnotPos(int curve, int knot, Vector3 p)[\/cc]<\/p>\n This will update the knots local space position and update the curves length.<\/p>\n [cc lang=”c#”]public void SetKnot(int curve, int knot, Vector3 p, Vector3 intan, Vector3 outtan)[\/cc]<\/p>\n Use this method to completely change a knots position, you pass in the curve and knot index you wish to change and then the new local space positions of the knot and the in and out vector handles. The method will then call CalcLength to update the lengths of the whole shape. If you are going to change a lot of values on a shape at one time then it is best to access the knot data through the arrays directly and update all the values and then call CalcLength() yourself at the end to make it faster.<\/p>\n [cc lang=”c#”]public void MoveKnot(int curve, int knot, Vector3 p)[\/cc]<\/p>\n This method will move a knot to a new position and move the tangents along with it. The CalcLength will then be called to update the lengths for the shape. If you are going to change a lot of values on a shape at one time then it is best to access the knot data through the arrays directly and update all the values and then call CalcLength() yourself at the end to make it faster.<\/p>\n [cc lang=”c#”]public Vector3 InterpCurve3D(int curve, float alpha, bool type)[\/cc]<\/p>\n Returns a local space position on the spline based on the alpha value passed. An alpha value of 0 will return the start of the spline and 1 to end and 0.5 will return the point half way along the length. The type value says whether to use normalized interpolation which is a little slower but gives a smoother result less prone to speed ups that can be seen in some splines. If you pass in values out side of the 0 to 1 range for alpha the function will either interpolate a position before the first knot if the value is < 0 and the spline is open, or interpolate a value past the end of the last knot if the value is > 1 and the spline is open. If the spline is closed then the value will be adjusted to be in the range and then used, so if -1.5 is passed in the value will become 0.5 so the midpoint will be returned.<\/p>\n [cc lang=”c#”]public Vector3 FindNearestPointWorld(Vector3 p, int iterations, ref int kn, ref Vector3 tangent, ref float alpha)[\/cc]<\/p>\n This method will find the nearest point in the shape to the world space point passed in and return the point in world space. It will also return the knot, the tangent and the alpha value for the point.<\/p>\n [cc lang=”c#”]public Vector3 FindNearestPoint(Vector3 p, int iterations, ref int kn, ref Vector3 tangent, ref float alpha)[\/cc]<\/p>\n This method will find the nearest point in the shape to the local space point passed in and return the point in world space. It will also return the knot, the tangent and the alpha value for the point.<\/p>\n [cc lang=”c#”]public void BuildSpline(int curve, Vector3[] points, bool closed)[\/cc]<\/p>\n This method will rebuild the spline using the Vector3 points array passed in and autocalc the handles for the knots to produce a smooth spline. You can also say whether the spline will be open or closed.<\/p>\n [cc lang=”c#”]public void BuildSpline(Vector3[] points, bool closed)[\/cc]<\/p>\n This is like the BuildSpline method above but will create a new spline from the points and add it to the end of the spline list for the shape.<\/p>\n [cc lang=”c#”]public void AddToSpline(int curve, Vector3[] points)[\/cc]<\/p>\n This will extend the spline chosen by the curve value with the points passed in and calculate the handles.<\/p>\n [cc lang=”c#”]public void AddToSpline(int curve, Vector3 point)[\/cc]<\/p>\n Will extend the spline chosen by the curve value by a single point.<\/p>\n [cc lang=”c#”]public void AutoCurve(MegaSpline spline)[\/cc]<\/p>\n This will recalc the handles for the spline passed in to make the smoothest shape it can.<\/p>\n [cc lang=”c#”]public void AutoCurve(MegaSpline spline, int start, int end)[\/cc]<\/p>\n This will calculate the handles for the spline starting with the start index knot and going to the end index knot. This allows you to autosmooth part of a spline.<\/p>\n [cc lang=”c#”]public void AutoCurve()[\/cc] [cc lang=”c#”]public void BuildMesh()[\/cc] The code below is taken from the MegaShapeCircle.cs and shows how to create a spline in code, this will make a closed circle spline from a radius value, the spline produced is made from 4 knots and the handles for each knot are calculated to form a perfect circle. The important thing to notice is once a spline has been created or altered in any way the CalcLength() method should be called so that the internal lengths of the spline can be calculated for quicker interpolation later, the value passed in will determine how accurate the lengths are, lower values can be used for quicker calculations, 10 gives a very accurate length without too much overhead.<\/p>\n [cc lang=”c#”]public class MegaShapeCircle : MegaShape \tconst float CIRCLE_VECTOR_LENGTH = 0.5517861843f;<\/p>\n \tpublic override void MakeShape() \t\tfloat vector = CIRCLE_VECTOR_LENGTH * Radius;<\/p>\n \t\tMegaSpline spline = NewSpline();<\/p>\n \t\tfor ( int ix = 0; ix < 4; ++ix )\n\t\t{\n\t\t\tfloat angle = (Mathf.PI * 2.0f) * (float)ix \/ (float)4;\n\t\t\tfloat sinfac = Mathf.Sin(angle);\n\t\t\tfloat cosfac = Mathf.Cos(angle);\n\t\t\tVector3 p = new Vector3(cosfac * Radius, sinfac * Radius, 0.0f);\n\t\t\tVector3 rotvec = new Vector3(sinfac * vector, -cosfac * vector, 0.0f);\n\t\t\tspline.AddKnot(p, p + rotvec, p - rotvec, tm);\n\t\t}\n\n\t\tspline.closed = true;\n\t\tCalcLength(10);\n\t}\n}[\/cc]\n\nThis is a very simple example that will build a spline from an array of world space points, note you can use local space if you use the BuildSpline method instead, you can also pick which spline in the shape you want to change and also whether or not the spline is open of closed by changing the last param of the BuildSpline method to true.\n\n[cc lang=\"c#\"]public class MakeSpline : MonoBehaviour\n{\n\tpublic MegaShape\tshape;\t\t\/\/ Shape object \n\tpublic Vector3[]\tpoints;\t\t\/\/ World space points to make into a spline\n\n\tvoid Start()\n\t{\n\t\tif ( shape && points.Length > 1 ) This page guides you through the various classes that make up the Spline system inside MegaShapes. A MegaShape is made up of MegaSplines and each spline is in turn made […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":390,"menu_order":0,"comment_status":"open","ping_status":"open","template":"","meta":[],"_links":{"self":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/2463"}],"collection":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2463"}],"version-history":[{"count":59,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/2463\/revisions"}],"predecessor-version":[{"id":6596,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/2463\/revisions\/6596"}],"up":[{"embeddable":true,"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=\/wp\/v2\/pages\/390"}],"wp:attachment":[{"href":"http:\/\/www.west-racing.com\/mf\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2463"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\n{
\n public float length;
\n public bool closed;
\n public List
\n public List
\n public Vector3 offset;
\n public Vector3 rotate;
\n public Vector3 scale;
\n}[\/cc]<\/p>\nParam Members<\/h3>\n
length<\/strong><\/h4>\n
closed<\/strong><\/h4>\n
knots<\/strong><\/h4>\n
animations<\/strong><\/h4>\n
offset<\/strong><\/h4>\n
rotate<\/strong><\/h4>\n
scale<\/strong><\/h4>\n
Methods<\/h3>\n
\ninvec<\/strong> – local space position of the in vector handle
\noutvec<\/strong> – local space position of the out vector handle\n<\/div>\n
\ninvec<\/strong> – local space position of the in vector handle
\noutvec<\/strong> – local space position of the out vector handle
\ntm<\/strong> – The matrix to transform the values by before creating the knot\n<\/div>\n
\nWill return the area covered by the spline, if the spline is not closed it will return 0<\/p>\n
\ntype<\/strong> – true to use normalized interpolation, false to use linear interpolation
\nk<\/strong> – On return will hold the knot index the point is in\n<\/div>\n
\ntype<\/strong> – true to use normalized interpolation, false to use linear interpolation
\nk<\/strong> – On return will hold the knot index the point is in\n<\/div>\nMegaShape<\/h3>\n
Class<\/h3>\n
\n{
\n public MegaAxis axis;
\n public Color col1;
\n public Color col2;
\n public Color KnotCol;
\n public Color HandleCol;
\n public Color VecCol;
\n public float KnotSize;
\n public float stepdist; \/\/ Distance along whole shape
\n public bool normalizedInterp;
\n public bool drawHandles;
\n public bool drawKnots;
\n public bool drawspline;
\n public bool lockhandles;
\n public float CursorPos;
\n public List
\n public float time;
\n public bool animate;
\n public float speed;
\n public int selcurve
\n public MegaHandleType handleType;<\/p>\n
\n public bool makeMesh;
\n public MeshShapeType meshType;
\n public bool DoubleSided;
\n public bool CalcTangents;
\n public bool GenUV;
\n public bool PhysUV;
\n public float Height;
\n public int HeightSegs;
\n public int Sides;
\n public float TubeStep;
\n public float Start;
\n public float End;
\n public float Rotate;
\n public Vector3 Pivot;<\/p>\n
\n public Vector2 UVOffset;
\n public Vector2 UVRotate;
\n public Vector2 UVScale;
\n public Vector2 UVOffset1;
\n public Vector2 UVRotate1;
\n public Vector2 UVScale1;
\n public Vector2 UVOffset2;
\n public Vector2 UVRotate3;
\n public Vector2 UVScale3;
\n public bool UseHeightCurve;
\n public AnimationCurve heightCrv;
\n public float heightOff;
\n}
\n[\/cc]<\/p>\nParam Members<\/h3>\n
axis<\/strong><\/h4>\n
col1<\/strong><\/h4>\n
col2<\/strong><\/h4>\n
KnotCol<\/strong><\/h4>\n
HandleCol<\/strong><\/h4>\n
KnotSize<\/strong><\/h4>\n
stepDist<\/strong><\/h4>\n
normalizedInterp<\/strong><\/h4>\n
drawHandles<\/strong><\/h4>\n
drawKnots<\/strong><\/h4>\n
drawSpline<\/strong><\/h4>\n
lockhandles<\/strong><\/h4>\n
CursorPos<\/strong><\/h4>\n
splines<\/strong><\/h4>\n
time<\/strong><\/h4>\n
animate<\/strong><\/h4>\n
speed<\/strong><\/h4>\n
selcurve<\/strong><\/h4>\n
handleType<\/strong><\/h4>\n
makeMesh<\/strong><\/h4>\n
meshType<\/strong><\/h4>\n
DoubleSided<\/strong><\/h4>\n
CalcTangents<\/strong><\/h4>\n
GenUV<\/strong><\/h4>\n
PhysUV<\/strong><\/h4>\n
Height<\/strong><\/h4>\n
HeightSegs<\/strong><\/h4>\n
Sides<\/strong><\/h4>\n
TubeStep<\/strong><\/h4>\n
Start<\/strong><\/h4>\n
End<\/strong><\/h4>\n
Rotate<\/strong><\/h4>\n
Pivot<\/strong><\/h4>\n
UVOffset<\/strong><\/h4>\n
UVRotate<\/strong><\/h4>\n
UVScale<\/strong><\/h4>\n
UVOffset1<\/strong><\/h4>\n
UVRotate1<\/strong><\/h4>\n
UVScale1<\/strong><\/h4>\n
UVOffset2<\/strong><\/h4>\n
UVRotate3<\/strong><\/h4>\n
UVScale3<\/strong><\/h4>\n
UseHeightCurve<\/strong><\/h4>\n
heightCrv<\/strong><\/h4>\n
heightOff<\/strong><\/h4>\n
Methods<\/h3>\n
\nstep<\/strong> – The number of interpolatin steps to use in the length calculation\n<\/div>\n
\nknot<\/strong> – the knot whose position you want\n<\/div>\n
\nknot<\/strong> – the knot whose position you want\n<\/div>\n
\nknot<\/strong> – the knot whose position you want\n<\/div>\n
\nknot<\/strong> – The knot we want to position
\np<\/strong> – the new local space position of the knot\n<\/div>\n
\nknot<\/strong> – the knot we want to position
\np<\/strong> – the new local space position of the knot
\nintan<\/strong> – the new local space position of the in vector handle
\nouttan<\/strong> – the new local space position of the out vector handle\n<\/div>\n
\nknot<\/strong> – the knot we want to position
\np<\/strong> – the new local space position of the knot\n<\/div>\n
\nalpha<\/strong> – the point to return
\ntype<\/strong> – true to use normalized interpolation, false to use linear interpolation\n<\/div>\n
\niterations<\/strong> – the number of steps taken to find the nearest point, the higher the value the more accurate the result will be
\nkn<\/strong> – on return this will hold the knot the point is in
\ntangent<\/strong> – on return this will hold the tangent at the nearest point
\nalpha<\/strong> – on return this will hold the alpha value along the shape\n<\/div>\n
\niterations<\/strong> – the number of steps taken to find the nearest point, the higher the value the more accurate the result will be
\nkn<\/strong> – on return this will hold the knot the point is in
\ntangent<\/strong> – on return this will hold the tangent at the nearest point
\nalpha<\/strong> – on return this will hold the alpha value along the shape\n<\/div>\n
\npoints<\/strong> – The local space points that define the knot positions for the new pline
\nclosed<\/strong> – Whether the new spline is open or closed\n<\/div>\n
\nclosed<\/strong> – Is the new spline open or closed.\n<\/div>\n
\npoints<\/strong> – The array of local space points to extend the spline with.\n<\/div>\n
\npoint<\/strong> – The local space point to add to the spline\n<\/div>\n
\nstart<\/strong> – The index of the starting knot to smooth
\nend<\/strong> – The index of the ending knot to smooth\n<\/div>\n
\nThis will recalc the handles for all the splines in a shape and recalc the handles to give the smoothest splines.<\/p>\n
\nCall this to build or rebuild a mesh from the shape.<\/p>\nCode examples<\/h3>\n
\n{
\n\tpublic float Radius = 1.0f;<\/p>\n
\n\t{
\n\t\tMatrix4x4 tm = GetMatrix();<\/p>\n
\n\t\t\tshape.BuildSplineWorld(0, points, false);
\n\t}
\n}[\/cc]<\/p>\n","protected":false},"excerpt":{"rendered":"