Mesh Combine Studio 2

http://www.terraincomposer.com/mcs-documentation
Admin
Mesh Combine Studio 2 is a Unity tool that automatically combines meshes using a cell-based...
Tokens:1,819
Snippets:18
Trust Score:2.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Mesh Combine Studio (MCS) Core Functionality and Workflow

This section describes the fundamental operation of Mesh Combine Studio (MCS), including its drag-and-drop setup, interaction with Unity's static batching, and its automated cell-based combining technique. It also covers how MCS handles existing GameObject components and the process for reverting mesh combinations.

```APIDOC
**Setup and Basic Usage:**
  - Drag and drop the `MeshCombineStudio` prefab into your Scene.
  - Multiple MCS prefabs can be used for different settings within the same Scene.

**Important Considerations:**
  - **Runtime Usage:** Disable Unity’s static batching to prevent double combining and incorrect results.
  - **Automation:** MCS is fully automated, similar to Unity’s static batching, eliminating manual combining.

**Combining Technique:**
  - Employs a clever cell-based combining technique.
  - Optimized for culling, z-sorting, and LOD switching.
  - Supports LOD meshes, combining them per cell for better performance and reduced LOD popping.

**Geometry Optimization:**
  - Unique ability to remove geometry never visible to the camera (e.g., triangles under terrain/mesh, backface triangles).
  - **MCS Caves & Overhangs Extension:** Allows removal of triangles from overlapping meshes (requires meshes to be closed).

**GameObject Interaction:**
  - Original GameObjects' scripts, colliders, audio sources, etc., remain functional.
  - MCS only disables the `Mesh Renderers` on original GameObjects.
  - **Geometry Removal:** Option to generate new mesh colliders, deactivating original colliders.

**Reversion and Performance Testing:**
  - **Revert Combining:** Click ‘Delete Combined’ button or toggle between original and combined states.
  - **Performance Testing:** Unity Editor stats can be inaccurate; best to test and compare performance in a build.
```

--------------------------------

### Mesh Combine Studio (MCS) Inspector Sections

This outlines the main sections found within the Mesh Combine Studio Inspector, where users can configure various settings for mesh combining and optimization. The default settings are a good starting point.

```APIDOC
The MCS Inspector is divided into eight main parts:
  - **Unity Settings:** General Unity-related configurations.
  - **Search Conditions:** Define criteria for meshes to be considered for combining.
  - **Combine Conditions:** Specify rules and parameters for how meshes are combined.
  - **Output Settings:** Configure the output of the combined meshes.
  - **Job Settings:** Manage multi-threading and job processing for combining.
  - **Runtime Settings:** Adjust behavior when MCS is used at runtime.
  - **Execute Buttons:** Actions to initiate or revert combining.
  - **Gizmos & Combine Stats:** Visualization and performance statistics.
```

--------------------------------

### Job Settings: Overview

Settings for the multi-threaded combine job manager, designed for low memory and garbage allocation.

```APIDOC
Job Settings:
  Description: Global settings for the multi-threaded combine job manager. Manages all combine jobs from MeshCombineStudio prefabs. Optimized for low memory and garbage allocation, with mesh type caching and array pooling.
```

--------------------------------

### Lighting Integration: Copy Baked Lighting

Copies baked lighting from original meshes to combined meshes, potentially increasing draw calls but preserving scene file size with runtime combining.

```APIDOC
Copy Baked Lighting:
  Description: Copies lighting from original meshes to combined meshes. Can result in more combined meshes (and draw calls) due to lightmap index requirements. Advantage: Scene file size doesn't increase with 'Combine In Runtime'.
```

--------------------------------

### Lighting Integration: Rebake Lighting

Rebakes lighting on combined meshes, allowing for lightmap UV regeneration for space optimization.

```APIDOC
Rebake Lighting:
  Description: Rebakes lighting on the combined meshes. Lightmap UVs can be copied or regenerated, with regeneration recommended for geometry removal to save lightmap texture space.
```

--------------------------------

### Job Settings: Combine Job Mode

Defines how meshes are combined: all at once for speed or per frame for consistent FPS.

```APIDOC
Combine Job Mode:
  Combine At Once: Combines all meshes as quickly as possible (e.g., Unity Editor, runtime level loading).
  Combine Per Frame: Combines a chosen amount of meshes per frame to maintain FPS (e.g., runtime editing, removing overlapping geometry).
```

--------------------------------

### Job Settings: Use Multi Threading

Enables multi-threading for the combine process to improve performance linearly with available cores.

```APIDOC
Use Multi Threading (Optional):
  Description: Allows the mesh combining process to run on multiple threads, linearly speeding up combining based on available CPU cores/threads.
```

--------------------------------

### Job Settings: Show Stats

Displays statistics for the Job Manager, such as cached meshes and pending jobs.

```APIDOC
Show Stats:
  Description: Displays statistics for the Job Manager, including the amount of meshes cached and pending jobs.
```

--------------------------------

### Collider Management: Center/Size

Defines the position and dimensions of the bounding box used by 'Use Range'.

```APIDOC
Center/Size:
  Description: Specifies the center point and dimensions of the bounding box used by the 'Use Range' option for collider generation.
```

--------------------------------

### Mesh Processing: Snap Vertices

Defines settings for snapping vertices together based on proximity, with adjustable snap size.

```APIDOC
Snap Vertices:
  Description: Removes a vertex if it's close to another vertex.
  Parameter: Snap Size (float) - The maximum distance for snapping. A large value can significantly alter shadows.
```

--------------------------------

### Job Settings: Use Main Thread

Option to disable main thread usage for combining when multi-threading is active, improving main thread FPS.

```APIDOC
Use Main Thread:
  Description: Can be disabled when multi-threading is active to keep FPS higher on the main thread. Mesh assignment still requires the main thread (Unity Mesh API), but compute-intensive combining can be offloaded.
```

--------------------------------

### Mesh Processing: Include Normals

Determines whether mesh normals are included for more accurate shadows and shadow bias reactions.

```APIDOC
Include Normals:
  Description: Includes normals with the mesh for more accurate shadows and reactivity to shadow bias settings. Can be omitted if not required.
```

--------------------------------

### Collider Management: Use Range

Limits mesh collider generation to objects within a specified bounding box.

```APIDOC
Use Range:
  Description: Only adds mesh colliders to objects within a defined box range. Useful for localized collider needs (e.g., objects reacting to bullets in a limited area).
```

--------------------------------

### Mesh Processing: Weld Vertices

Configures the welding of vertices to remove duplicates, primarily for shadow optimization.

```APIDOC
Weld Vertices:
  Description: Removes vertices that share the same position. Recommended for separate shadow mesh combining. May slightly alter shadows, but typically unnoticeable.
```

--------------------------------

### Lighting Integration: Scale in Lightmap

Adjusts the scale of combined meshes within the lightmap, affecting lightmap file size.

```APIDOC
Scale in Lightmap:
  Description: Defines the scale of combined meshes within the Lightmap. Default is 1. Smaller values reduce Lightmap file size.
```

--------------------------------

### Performance Optimization: Use Vertex Output Limit

Limits the maximum vertices per combined mesh to maintain frame-rate, potentially increasing draw calls.

```APIDOC
Use Vertex Output Limit:
  Description: Limits the maximum number of vertices for combined meshes. Useful at runtime to maintain high frame-rates, but can lead to more draw calls. Otherwise, keep disabled.
```

--------------------------------

### Collider Management: Add Mesh Colliders

Adds mesh colliders to combined meshes, disabling original object colliders. Use only if original GameObjects lack colliders or geometry is removed.

```APIDOC
Add Mesh Colliders:
  Description: Adds mesh colliders to combined meshes and disables colliders on original objects. Use when original GameObjects lack colliders or geometry is removed. Primitive colliders on original GameObjects are generally faster.
```

--------------------------------

### Memory Optimization: Make Meshes Unreadable

Frees CPU memory by removing mesh array copies, unless CPU read access is required.

```APIDOC
Make Meshes Unreadable:
  Description: Removes the copy of mesh arrays from CPU memory, saving CPU memory. Disable only if direct CPU read access to meshes is necessary.
```
Tokens:
Raw