Sculpting Pro
Official Documentation �v3.0.0
by Matej Vanco 2020-2023 ©
Change Log v3.0.0 �02.02.2023 [dd/mm/yyyy]�
New collection of primitives
Brand new APi documentation
Seams calculation optimized
Improved sculpting in Unity Editor
Major code refactor
Ready for Unity 2020, 2021 and 2022
Official roadmap
Curious what the future holds? Click the Trello icon!
Content
Sculpting Editor�Sculpting Editor�(Panel Description & shortcuts)
Introduction
Sculpting Pro is a complete multi platform solution of mesh sculpting in Unity Engine. Manipulate with any kind of meshes with user-friendly and well-known sculpting tools directly in Unity editor or at runtime.
Key Features:
Upgrade your level design experience and bring a new perspective to your workflow.
Package description in general
Essentials
Sculpting Pro contains 4 essential scripts
Multithreaded mesh-sculpting source.�Handles itself automatically, user doesn’t need to know about this.
Main sculpting editor at runtime only.�Runtime-only feature. Makes the sculpting possible in Application.
There are other scripts available for use that the plugin offers
Collection of basic procedural primitives.�Can be found in Hierarchy/Create/3D Object/SculptingPro.
Global utilities ready for 3rd party operations.�Complete API of 3D math library.
Global preferences for SculptingPro plugin (Window/SculptingPro/Preferences)�Contains an internal debug, package info & global plugin params.
Simple input handler for realtime sculpting.�Sample input script for PC, Mobile & VR. Helps you to control sculpting events.
Each component & script is described in the API slide.�Non-mentioned scripts are not important for the user.
Setup
Sculpting Pro allows you to sculpt almost any mesh. The mesh must contains SculptingPro_Model component which handles mesh data.
Sculpting in Editor can be initialized via Window/Sculpting Pro/Enable or Disable
Or select any object with mesh filter, add SculptingPro_Model component and press the orange button Sculpt This Mesh In Editor Scene in the inspector.
Sculpting at Runtime can be initialized by adding the SculptingPro_Realtime component onto any object in scene.�Field Target Sculpting Brush must be assigned. The field indicates to the visual sculpting brush (More in API).
There are two modes of sculpting: Global Sculpting & Locked Sculpting
Global Sculpting doesn’t focus on any specific mesh and it’s possible to sculpt all meshes with SculptingPro_Model component at once. In such case, you are not able to use Mesh Features which enables advanced operations such as subdivision or overall smooth. To access this sculpting mode, don’t select any object. The editor will appear gray (in the editor-scene view).
Locked Sculpting focuses on specific mesh with SculptingPro_Model component. In such case, you are able to use advanced Mesh Features. To access this sculpting mode, select one object with mesh filter in the Unity Editor and execute Sculpting Editor. The editor will appear orange (in the editor-scene view). To access this sculpting mode at runtime, select object with SculptingPro_Realtime and enable Locked Sculpting field. Assign the desired object into required field. (More in API about realtime sculpting).
My first Hello World with sculpting in Unity Engine
Setup VR
Sculpting Pro allows you to sculpt almost any mesh in VR mode at runtime. To properly setup the Sculpting Pro for VR, go to the SculptingPro/VR and import proper VR framework.�(If you use SteamVR, import SteamVR plugin & InputDependency_SteamVR).�If the VR framework doesn’t match with the imported input dependency, the compiler errors appear.�I recommend to use XR Input dependency as the XR is the Unity’s built-in VR framework (At least for testing purposes).
If the import was successful, explore the example VR content or create your VR sculpting component from scratch.
To create a sculpting component from scratch, drag & drop your VR-player rig prefab�(or create a new one - VR Head, Right & Left Controller).
Choose one of the VR controllers, add SculptingPro_Realtime component to the chosen VR controller.�Switch Target Platform to VR and assign Target Sculpting Brush field. The field indicates to visual sculpting brush.
At last but not least, add SculptingPro_InputVR_YOUR VR FRAMEWORK component and choose your desired button which will control the sculpting process. Done!
Supported VR frameworks in SculptingPro - SteamVR, Unity XR, Oculus Integration
My first Hello World with �VR sculpting in Unity Engine
For example, this is the VR Input script for Oculus Integration. Target Device refers to the target controller & Input Button to the actual input.
As mentioned in the previous slide, there are two modes of sculpting:�Global Sculpting and Locked Sculpting. In the following example we will use both modes and you will learn the basics of sculpting in the Unity Editor.
Basic use of mesh sculpting in the Unity Editor
Locked Sculpting (Editor appears orange - as shown on the left side)
Global Sculpting (Editor appears gray)
The sculpting editor will appear and you are ready to sculpt! Full editor-panel description can be found on the next slide.
�Please keep in mind that this panel is not available in Global Sculpting. You have to select a specific mesh to access Mesh Features!
Editor Sculpting pt.1
Sculpting editor panel description in the Unity Editor
Essentials
Sculpting tools
�
Mesh Features (available if the Locked Sculpting is active [if one object is focused])
Quick Sculpting Editor shortcuts�[Sculpting editor must be enabled]
Change radius size
Left Control + Mouse Scroll Wheel
Change intensity value
Left Alt + Mouse Scroll Wheel
Process any sculpting tool
Aim on mesh & press Left Mouse Button
When in Raise/Lower tool:
Process lower tool
Left Control + Left Mouse
Editor Sculpting pt.2
Heightmap Sculpting
Heightmap brush feature.
Stamp any texture onto any mesh
Heightmap stamp in SculptingPro does a pretty impressive work. You can literally stamp any black & white texture onto any mesh with amazing results.
In order to create a stamp texture, you need to create a SculptingPro_HeightmapBrush object in your assets. Go to the Assets and press Create/SculptingPro/Heightmap brush object.
Select the Heightmap brush object and assign your heightmap texture. Follow further instructions to complete the Heightmap brush object (such as check for correct dimensions, if the texture is readable etc… The script will do it for you, all you need to do is just to pay attention and do some clicking).
If everything is ready, your heightmap brush is ready.
In editor sculpting, select the Heightmap brush state and assign your chosen heightmap brush object. There are advanced options such as horizontal brush and brush rotation.
At runtime sculpting, select the Heightmap brush state in SculptingPro_Realtime component and assign your chosen heightmap brush object.
Please keep in mind: the more vertices your mesh has, the longer it takes to complete the ‘heightmap-stamp’ process (for 40k meshes it may take even for 30 seconds to complete). Also Heightmap stamping is not allowed for non-multithreaded sculpting.
=
Individual Components
Sculpting Pro contains well-organized APi that allows you to do more than just sculpting. Obtain full control and improve your project to another level. All public methods are accessible via Unity Events (for example in UI) as well.
Namespace: SculptingPro
Editor namespace: SculptingProEditor�Naming macro: SculptingPro�Components utility: Matej Vanco/Sculpting Pro
Choose one of the scripts below and explore their API & content.�Each field on every script contains tooltip information (hover the cursor over the field).
Description of individual components in the Sculpting Pro
Production-Essentials�Scripts that user will mostly use in practice - in Unity Editor & at runtime. These scripts can be seen in the Unity Inspector.
Advanced-Internal�Scripts that are required for sculpting in general, but user won’t need them, but it’s good to know them & have them!
SculptingPro Realtime
> If enabled, the sculpting will be ready for complex meshes
> If enabled, the auto-seam handler will process ‘broken’ vertices
> Required target platform (PC/Mobile/VR)
> Required target camera or VR controller
> Required sculpting brush for sculpting visualization�(Can be fully customized, use ExampleBrush in Prefabs folder)
> Allowed raycast layers & tag (leave the tag field empty if you would like to sculpt all possible meshes)
> If enabled, the raycast will continue if cursor will hover any UI
> If disabled, the raycast origin will be (if PC/Mobile) screen center - camera forward or (if VR) target controller forward
> Brush radius & brush intensity values
> Target brush state (each brush state contains its own parameters. See on the right)
> Distance limitations in which certain vertices will be limited from their initial position to the current
> Locked sculpting option
Full solution of sculpting at runtime only.�This script is applied once on any object in Unity scene to access sculpting at runtime.
Inspector description
List of Brush States : Enum (excerpted from the script)
(Brush state indicates to the selected sculpting tool)
List of Sculpting Types : Enum (excerpted from the script)�(Sculpting type indicates how the vertices will behave while raising/lowering)
List of Radius Types : Enum (excerpted from the script)
(Radius type indicates how the vertices will behave while processing)
Smoothing types and Noise directions on the next slide...
Production Essential script
}
List of Smoothing Types : Enum (excerpted from the script)
(Smoothing types indicates to the various smoothing-filter algorithms)
List of Noise Directions : Enum (excerpted from the script)�(Noise Directions indicates to the type of noise behaviour)
SculptingPro Model
> Essential mesh information
> Create a new mesh reference on copy/paste or any other action
> If disabled, the normals won’t be automatically calculated
> Use alternative normals recalculation (smoother results)
> Handle vertex-seams (More about seams here)
> Deep-seams handler - precise vertex-seam calculation
Essential component for sculpting-ready meshes. Object must contain MeshFilter in order to make the sculpting work properly.
Inspector description
Production Essential script
SculptingPro Procedural Primitives
> Procedural shape type (Plane, Cube, Sphere, Tube, Cone)
> If enabled, the parameters below will be updated every frame
> Parameters of the chosen shape type
Collection of basic procedural primitives. Create an object via �Hierarchy/3D Object/Sculpting Pro/Procedural Primitives
Inspector description
Production Essential script
SculptingPro Input Sample
[Script inspector overview, if target platform is set to PC. �Other platforms don’t have such options]
> Main key input in which sculpting will be proceeded
> Additional key events �(for example, if you press ‘1’ you can switch to sculpting tool ‘Noise’)
> If disabled, the script won’t send any input data
Simple input handler for realtime sculpting.�Available for PC & Mobile. Check Setup VR slide for VR input.�Requires SculptingPro_Realtime component.
Inspector description
Production Essential script
[Script inspector overview, when one of the additional key events is opened]
> Event name (just for your visual information in the editor)
> Event input (required key input for the additional event to process)�> List of input events
> If the specified Event Input is pressed (process once)
> If the specified Event Input is hold (process repeatedly)
> If the specified Event Input is released (process once)
For example, the example scenes contain structure of this content >
This basically means, that the main sculpting ‘process’ input is Left Mouse (Mouse0) and there are a few ‘hotkeys’ that allow you to switch between brush types and you can even do Undo. That’s why you can use Additional Key Events which helps you to expand sculpting features at runtime.
SculptingPro Preferences
Global preferences for SculptingPro plugin.
Access this class via script or open an editor window�Window/Sculpting Pro/Preferences
Advanced Internal script
Available Public API
SculptingPro_Preferences
public const string ORGANISATION - Organisation name
public const string PACKAGENAME - Current full package/plugin name
public const string VERSION - Current SculptingPro plugin version
public const string DATE - Last SculptingPro update date dd/mm/yyyy
public static readonly Color COLOR_LOCKED - Color for GUI if editor has a selection focus (editor only)
public static readonly Color COLOR_UNLOCKED - Color for GUI if editor doesn’t have a selection focus (editor only)
public static int pref_MaxHistoryRecords
public static bool pref_RecalculateNormalsAsDefault
public static bool pref_RecalculateNormalsOptimized
public static bool pref_CreateNewReferenceAsDefault
public static Color pref_LockedSculptingEditorColor
public static Color pref_UnlockedSculptingEditorColor
SculptingPro_Debug
public static void Debug(Mono, string, DebugType) - Output specific message via SculptingPro
The available fields in Preferences window indicate to the default values that some SculptingPro components use at the time of their initialization. You can customize these fields by your own needs. Please read the warning boxes properly!
Example Content
Explore extended content of the Sculpting Pro!
Sculpting Pro contains a complete example content, which is available online as well. Choose one of the demos below and test your performance with official examples. Just click the image.
PC�WIN
Web�GL
XR�VR
FAQ
Frequently Asked Questions
• What is the maximum vertex count for a mesh?�The maximum recommended vertex count is around ~100k. The Unity’s default index format is 16 bit (up to ~65k vertices). However it is possible to use the 32 bit index format (up to 4 billion vertices). It all depends on two factors: your CPU & multithreading performance.�
• Does the SculptingPro support WebGL?�Yes, SculptingPro does support WebGL. However, the WebGL is the only platform with specific exception - WebGL does not support multithreading in a build, so it would not be possible to sculpt meshes beyond the recommended vertex count (~6000).�
• Is it possible to export a mesh to the fbx or obj?�No, SculptingPro does not contain such feature. You can save your mesh to the assets folder as an ‘asset’ only. If you would like to export working mesh to the fbx or obj, use another 3rd party plugin.
• Does the SculptingPro work with Unity Terrains?�No, SculptingPro does not work with Unity Terrain system. Only if you convert the Unity Terrain to the single mesh (This feature is not included in the SculptingPro plugin).
• Does the SculptingPro support Linux or OSX?�Yes, SculptingPro supports all possible platforms.
• What are the major differences between SculptingPro and SculptingLite (MD Package)?�There is no further support and no future updates for SculptingLite in the MD Package.�- SculptingLite doesn’t contain a vertex-seam handler (which is the biggest advantage in the SculptingPro)�- SculptingLite supports just sculpting-per-object�(Each mesh its own sculpting solution)�- SculptingLite contains much fewer features than SculptingPro. However the SculptingLite is in stable and production-ready version.�
Summary: If you focus on more advanced, professional and verified sculpting solution inside the Unity Engine, SculptingPro is the way. If you focus on quick and simple sculpting, MD Package is for you (you will even obtain many other amazing mesh features including verified modifiers and various mesh editors).
• Is it possible to optimize a mesh in the SculptingPro? (opposite to subdivision)�No, SculptingPro doesn’t contain such feature yet.
• Is Oculus Quest supported?�Yes, all VR platforms are supported (including cardboard).
• Does the SculptingPro contain a symmetry feature?�No, SculptingPro does not contain such feature yet.
FAQ
Frequently Asked Questions
• Is the SculptingPro compatible with URP/HDRP?�Yes, SculptingPro is a logical plugin, which means it’s not dependent on a renderer pipeline. However, example content that the plugin contains work in Unity Built-In render pipeline only.�
• Sculpting in the Unity Editor is not sometimes responsive… Why?�It’s because the game-view window must be present. If the game-view window is not present, the scene-view window will be paused. Also try to maximize the scene-view by pressing Left Shift + Space (cursor must be over the scene view).
• Does the SculptingPro contain any example scene with completely custom sculpting process?�Yes, SculptingPro does contain an example scene with completely custom sculpting process. The scene is called ‘SPExample_CustomSculpting’.�
• Does the SculptingPro work with skinned meshes?�No, SculptingPro does not work DIRECTLY with skinned meshes. However, you can convert the skinned mesh to the mesh filter and manipulate with its mesh source.
• Does the SculptingPro work with voxels?�No, SculptingPro does not generate voxels. You can modify existing meshes only.
Thank you
by Matej Vanco 2020-2023 ©
Thank you for your attention. If you have any questions, suggestions or issues, do not hesitate and join my official discord server for quick & realtime support. (Just click the image)
If you don’t like Discord, you can still contact me here.