Skip to content

Commit e441b05

Browse files
authored
Merge pull request #449 from unitALG/DOC-466-Doc_updates_for_NestedPrefabs
Doc 466 doc updates for nested prefabs
2 parents 255a5d6 + 3b0c2f6 commit e441b05

12 files changed

+139
-42
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ ExportedObj/
5555

5656
# Unity3D generated meta files
5757
*.pidb.meta
58+
*.DS_Store
5859

5960
# Unity3D Generated File On Crash Reports
6061
sysinfo.txt
Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
* [FBX Exporter](index)
2-
* [Exporting FBX files from Unity](exporting)
3-
* [Converting to Linked Prefabs](prefabs)
4-
* [Converting to Nested Prefabs](nested-prefabs)
5-
* [Integrating Unity with 3D modeling software](integration)
6-
* [Setting FBX Export options](options)
7-
* [Developer's guide](devguide)
2+
* [Exporting FBX files from Unity](exporting)
3+
* [Using Prefabs to connect Unity and your 3D modeling software](prefabs-overview)
4+
* [Unity 2018.2: Linked Prefabs](prefabs)
5+
* [Unity 2018.3: Variant Prefabs](nested-prefabs)
6+
* [Integrating Unity with 3D modeling software](integration)
7+
* [Setting FBX Export options](options)
8+
* [Developer's guide](devguide)
25.4 KB
Loading
28.2 KB
Loading
166 KB
Loading
381 KB
Loading
1.48 KB
Loading
1.41 KB
Loading

proto.com.unity.formats.fbx/Documentation~/index.md.in

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,19 @@ The FBX Exporter package provides round-trip workflows between Unity and 3D mode
66

77
The FBX Exporter package includes the following features:
88

9-
* [FBX Exporter](exporting.html): Export geometry, animation, Lights, and Cameras as FBX files so you can transfer game data to any 3D modeling software. Record gameplay and export it to make cinematics. Start grey-boxing with [ProBuilder](https://docs.unity3d.com/Packages/com.unity.probuilder@latest/), then export to FBX to replace with final assets.
9+
* [FBX Exporter](exporting.md): Export geometry, animation, Lights, and Cameras as FBX files so you can transfer game data to any 3D modeling software. Record gameplay and export it to make cinematics. Start grey-boxing with [ProBuilder](https://docs.unity3d.com/Packages/com.unity.probuilder@latest/), then export to FBX to replace with final assets.
1010

11-
* [Linked Prefab](prefabs.html): (Unity 2018.2) Link a Prefab to a new or existing FBX file. When you later change the FBX file, Unity automatically updates the Prefab to integrate changes to the transforms and hierarchy (in addition to Meshes and Materials). This helps you avoid rebuilding your Prefabs from scratch.
11+
* Connections via Prefabs. Which one you can use depends on the version of Unity you are using it with:
1212

13-
* [Unity Integration for 3D modeling software](integration.html): Effortlessly import and export Assets between Unity and Autodesk® Maya®, Autodesk® Maya LT™, or Autodesk® 3ds Max®. The 3D modeling software remembers where the files go, and what objects to export back to Unity.
13+
* [Linked Prefab](prefabs.md) (Unity 2018.2 only):
14+
15+
Link a Prefab to a new or existing FBX file. When you later change the FBX file, Unity automatically updates the Prefab to integrate changes to the transforms and hierarchy (in addition to Meshes and Materials). This helps you avoid rebuilding your Prefabs from scratch.
16+
17+
* [Model Prefab Variants](nested-prefabs.md) (Unity 2018.3 only):
18+
19+
Unity 2018.3 introduced [Nested Prefabs](https://docs.unity3d.com/2018.3/Documentation/Manual/NestedPrefabs.html) and [Prefab Variants](https://docs.unity3d.com/2018.3/Documentation/Manual/PrefabVariants.html) as new Prefab features. The FBX Exporter package allows you to import an FBX file as a *Model Prefab* and create Prefab Variants from them. Since Prefab Variants can override properties and children without affecting the original Prefab, you can use them in Unity without breaking the link to the file, and bring in updates.
20+
21+
* [Unity Integration for 3D modeling software](integration.md): Effortlessly import and export Assets between Unity and Autodesk® Maya®, Autodesk® Maya LT™, or Autodesk® 3ds Max®. The 3D modeling software remembers where the files go, and what objects to export back to Unity.
1422

1523
## Requirements
1624

@@ -32,7 +40,7 @@ The Unity Integration for Autodesk® 3ds Max® feature supports the following ve
3240

3341
* When installing a new version of the FBX Exporter package after using version 1.3.0f1 or earlier, the link between Assets and FbxPrefab components may be lost. See [Updating from 1.3.0f1 or earlier](#Repairs_1_3_0f_1) for repairing instructions.
3442

35-
* The FBX Exporter package does not support exporting .asset files.
43+
* The FBX Exporter package does not support exporting `.asset` files.
3644

3745
<a name="Repairs_1_3_0f_1"></a>
3846
## Installing the FBX Exporter
@@ -63,7 +71,7 @@ Some Assets in your Project may lose their FbxPrefab components. To repair this
6371

6472
3. Before continuing, back up your Project.
6573

66-
4. Select __Edit__ > __Project Settings__ > __FBX Export__ to view the [FBX Export Settings](options.html).
74+
4. Select __Edit__ > __Project Settings__ > __FBX Export__ to view the [FBX Export Settings](options.md).
6775

6876
![Run Component Updated button](images/FBXExporter_RunComponentUpdater.png)
6977

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,51 @@
1-
<a name="NestedPrefab"></a>
2-
# Converting to Nested Prefabs
3-
## Applies To: Unity 2018.3
1+
# Working with Model Prefab Variants
42

5-
As of 2018.3 Linked Prefabs will be replaced with the new [Nested Prefab workflow](https://unity3d.com/prefabs).
6-
More specifically, [Prefab Variants](https://docs.unity3d.com/2018.3/Documentation/Manual/PrefabVariants.html) can be used to achieve almost the same functionality as Linked Prefabs.
7-
Variant Prefabs cover the same updates as Linked Prefabs, as well as increased control over model updates.
8-
For example, consider an FBX with a Point Light of size 10. If the size of the Point Light is set to 1 in the Prefab Variant,
9-
and the Point Light color is modified in the FBX, the prefab variant will update the color of the Point Light but not the size.
10-
If it were a Linked Prefab, both the size and color would be overwritten to what is in the FBX.
3+
> ***Note:*** Prefab Variants are only available in Unity version 2018.3. If you are using Unity version 2018.2, use [Linked Prefabs](prefabs.md) instead.
114
12-
Additionally, Prefab Variants provide a more natural, built-in way to create a prefab which receives updates from the FBX model.
13-
They can be created and look like any other prefab without requiring an additional FbxPrefab component.
14-
They also extend the flexibility of the prefab in allowing you to create variants of variants that will still update with the model prefab.
5+
When a user imports a Model from a 3D modeling application such as Autodesk® Maya®, it is represented in Unity as a *Model Prefab*. You can't edit Model Prefabs in Unity, apart from [changing the import settings](https://docs.unity3d.com/2018.3/Documentation/Manual/class-FBXImporter.html). If someone saves changes to that Model file in an external application, the FBX Exporter automatically updates the imported Model Prefab.
156

16-
In order to convert existing Linked Prefabs or new FBX files to Nested Prefabs, follow these steps:
7+
![A Model Prefab in the Scene and Hierarchy views](images/FBXExporter_ModelPrefab.png)
178

18-
1. Right click the fbx file and select “Prefab Variant” to create a variant prefab that links to the FBX
9+
You can add components to a Model Prefab in the Scene, such as a collider. However, you cannot apply any change back to the Asset without breaking the link. In this way, a Model Prefab is a *read-only* Prefab, because it is non-editable except for overrides in the Scene.
1910

20-
![](images/FBXExporter_CreatePrefabVariant.png)
11+
Using Model Prefab Variants is the best way to ensure that your Models continue to reflect any changes you make to your FBX files in external applications while still taking full advantage of the Prefab system. For example, while Linked Prefabs required the extra **FbxPrefab** component, Model Prefab Variants use only the Unity Prefab features. And you can create Variants of your Variants which all receive updates from the Model Prefab but provide a lot of flexibility.
2112

22-
**Notes:**
13+
In addition, Variants give you some additional control over receiving updates from external applications. For example, if you have a Model with a Spot Light of size 10 and you override the size to 1 in your Variant, when the size and color change in the FBX file, the color will change but the size will remain 1.
2314

24-
* If converting an existing Linked Prefab, then the components from the Linked Prefab will need to be manually copied to the variant.
25-
* With Variant Prefabs, the name remapping functionality will be lost, so make sure to fix any name discrepancies before converting.
15+
> ***Important:*** Because the Prefab Variant inherits data from the base Model Prefab, you cannot make structural changes to the Prefab Variant. This means that you cannot delete inherited child objects or re-arrange the order of inherited child objects on the Prefab Variant.
16+
17+
## Creating a Model Prefab Variant
18+
19+
by and choosing “Prefab Variant”.
20+
21+
You can create a unidirectional link between your external 3D modeling application and your Unity Scene by setting up a Model Prefab Variant to inherit all changes from the Model Prefab. This means that updates to the FBX Model file will flow through to the Prefab.
22+
23+
To create Prefab Variant from a Model Prefab:
24+
25+
1. If you haven't already created a Prefab Model from the FBX Model file, drag the FBX file from the Project view into the Scene Hierarchy.
26+
27+
A Model Prefab ![Prefab icon](images/FBXExporter_PrefabIcon.png) appears in the Hierarchy view.
28+
29+
2. Drag the Prefab Model from the Scene Hierarchy to the Project view.
30+
31+
A dialog box prompts you to choose how you want to create the Prefab.
32+
33+
![Import as a Model Prefab Variant](images/FBXExporter_ModelPrefabVariant.png)
34+
35+
3. Click the **Prefab Variant** button.
36+
37+
The Model Prefab now appears as a Prefab Variant ![Prefab Variant icon](images/FBXExporter_PrefabVariantIcon.png) in both the Scene and Hierarchy views.
38+
39+
<a name="conversion"></a>
40+
41+
## Converting from Linked Prefabs to Prefab Variants
42+
43+
To convert existing Linked Prefabs to Prefab Variants, follow these steps:
44+
45+
1. Fix any name discrepancies that were previously handled by the [name remapping functionality for Linked Prefabs](prefabs.md#Remapping) before converting.
46+
47+
2. Right-click the FBX file and select **Prefab Variant** from the context menu.
48+
49+
![Create a Prefab variant from the file's context menu](images/FBXExporter_CreatePrefabVariant.png)
50+
51+
3. Copy any components from the old Linked Prefab onto the new Prefab Variant.

0 commit comments

Comments
 (0)