# pb_CSG

**Repository Path**: dang050/pb_CSG

## Basic Information

- **Project Name**: pb_CSG
- **Description**: A C# port of CSG.js by Evan W (http://evanw.github.io/csg.js/).
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2021-07-22
- **Last Updated**: 2024-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pb_CSG

A C# port of [CSG.js](http://evanw.github.io/csg.js/) by Evan W for use in the Unity game engine.

## Install

To install, simply check out this repository in the `My Project/Packages` directory.

```
cd My\ Project/Packages
git clone https://github.com/karl-/pb_CSG.git co.parabox.csg
```

## Quick Start

pb_CSG provides an interface in the `CSG` class for creating new meshes from boolean operations.  Each function (`Union`, `Subtract`, `Intersect`) accepts 2 gameObjects: the left and right side.  A new mesh is returned.

Example use:

	// Include the library
	using Parabox.CSG;

	...

	// Initialize two new meshes in the scene
	GameObject cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
	GameObject sphere = GameObject.CreatePrimitive(PrimitiveType.Sphere);
	sphere.transform.localScale = Vector3.one * 1.3;

	// Perform boolean operation
	CSG_Model result = Boolean.Subtract(cube, sphere);

	// Create a gameObject to render the result
	composite = new GameObject();
	composite.AddComponent<MeshFilter>().sharedMesh = result.mesh;
	composite.AddComponent<MeshRenderer>().sharedMaterials = result.materials.ToArray();

Result:

![](bin~/images/subtract.PNG?raw=true)