GithubHelp home page GithubHelp logo

sunning1218 / com.unity.probuilder Goto Github PK

View Code? Open in Web Editor NEW

This project forked from unity-technologies/com.unity.probuilder

0.0 0.0 0.0 368.04 MB

Home Page: https://unity3d.com/unity/features/worldbuilding/probuilder

License: Other

C# 97.18% Smalltalk 0.01% ShaderLab 2.62% JavaScript 0.06% GLSL 0.10% HLSL 0.04%

com.unity.probuilder's Introduction

Table of Contents

About

ProBuilder is a 3D modeling plugin for Unity.

This readme is intended as a brief introduction for developers interested in working with the API.

See the Manual for a user guide, or the Scripting Reference for API documentation.

Development

ProBuilder is a developed as a package and distributed with Package Manager.

The simplest way to get started working with source is to clone the repository into your Packages directory.

~/Desktop/MyProject$ cd Packages/
~/Desktop/MyProject/Packages$ git clone https://github.com/Unity-Technologies/com.unity.probuilder

See the Package Manager documentation for more information on installing packages.

API

There are 3 major namespaces.

Namespace Function
UnityEngine.ProBuilder Mesh types and functions to compile meshes to Unity compatible assets.
UnityEngine.ProBuilder.MeshOperations Mesh editing.
UnityEditor.ProBuilder Editor integration.

Mesh data is stored in a component (ProBuilderMesh) and compiled to a UnityEngine.Mesh (referred to as UMesh from here on) as necessary.

ProBuilderMesh retains the following mesh information:

  • Positions
  • UVs
  • Faces
    • Triangles
    • Material
    • Smoothing group
    • Auto/Manual UVs*
  • Tangent (if user set)
  • UV3/4 (if user set)
  • Colors
  • Shared vertices (also referred to as "common vertices")

Normals, tangents, collisions, and UVs are calculated as necessary.

*ProBuilder can automatically UV unwrap triangles on a per-face basis. Face has a toggle to enable or disable this feature (users are free to unwrap faces by manually as well).

Modifying a ProBuilder mesh is a bit different from a Unity mesh. Instead of working with the MeshFilter.sharedMesh you'll instead be operating on the ProBuilder representation of the mesh: ProBuilderMesh.

A typical workflow looks like this:

// Create a new cube primitive
var mesh = ShapeGenerator.CreateShape(ShapeType.Cube);

// Extrude the first available face along it's normal direction by 1 meter.
mesh.Extrude(new Face[] { mesh.faces.First() }, ExtrudeMethod.FaceNormal, 1f);

// Apply the changes back to the `MeshFilter.sharedMesh`.
// 1. ToMesh cleans the UnityEngine.Mesh and assigns vertices and sub-meshes.
// 2. Refresh rebuilds generated mesh data, ie UVs, Tangents, Normals, etc.
// 3. (Optional, Editor only) Optimize merges coincident vertices, and rebuilds lightmap UVs.
mesh.ToMesh();
mesh.Refresh();
mesh.Optimize();

License

Unity Companion License

Third Party Licenses

Third Party Licenses

Contributing

All contributions are subject to the Unity Contribution Agreement(UCA).

By making a pull request, you are confirming agreement to the terms and conditions of the UCA, including that your Contributions are your original creation and that you have complete right and authority to make your Contributions.

Pull Requests

Please include an entry to the changelog for any PR, along with a Fogbugz ticket number if applicable.

New logs should be placed under the ## [Unreleased] header at the top of the changelog. See Contributing for more details.

com.unity.probuilder's People

Contributors

antoine-unity avatar chikuba avatar gabrielw-us avatar karl- avatar martinbarrette avatar martinimgspc avatar neilunity avatar phobos2077 avatar roxannecor avatar roxanneunity avatar swahhillie avatar thomas-tu avatar tomaskucinskas avatar unitalg avatar vkovec avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.