Spline Mesher - Pro

Version: 1.0.10

4.Scripting #

Familiarity with C# and OOP programming is assumed. Support cannot be extended to coding help. Some specific functionality and use cases really need to be handled on a project-specific basis with some creative thinking.

If you are using an assembly definition, ensure you add a reference to the sc.splinemesher.pro.runtime assembly, otherwise you won’t be able to access the namespace and classes.

Whenever using the API, ensure you add using sc.splinemesher.pro.runtime; to include the namespace.

Accessing settings

Both the Spline Curve Mesher and Spline Fill Mesher components have a settings class instance, which in turn has various sub-class instances (eg. Distribution, Scale, Collider etc). They are laid out almost identically to how they’re presented in the inspector UI, so specific settings are straightforward to find.

You are encouraged to explore the settings instance in your IDE.

Press CTRL+Space after the . to explore the available fields and functions.

When changing settings in the inspector rebuilding happens automatically, but when changing them through script its required to call Rebuild() after you’ve finished making changes.

A few helper functions are in place:

Spline Curve Mesher

SetInputMesh(Mesh mesh)
AssignMaterials(Material[] materials)

Spline Fill Mesher

SetMaterial(Material material)

Manual rebuilding

Both the Spline Curve Mesher and Spline Fill Mesher components have a Rebuild() function, which will trigger a regeneration of the entire mesh. An optional splineIndex parameter can be passed on to rebuild for a specific spline.

This needs to be used when altering any component settings through script.

Be sure to call the Dispose() function where you are sure the Spline Mesher is no longer needed, this clears up memory.

Spline rebuild triggers

If you have the OnSplineAdded, OnSplineChanged or OnSplineRemoved rebuild triggers disabled, you’d also need to manage the spline cache manually through the respective AddCachedSpline, UpdateCachedSpline, RemoveCachedSpline functions.

A notification will be displayed in the inspector to also indicate this.

This is needed to update the internal spline cache, which is used for the mesh generation. Without doing so, the mesh gets rebuild based on outdated spline data.