Class PolyShapeTool
Represents the PolyShape tool button on the ProBuilder toolbar in the Editor.
Inherited Members
Namespace: UnityEditor.ProBuilder
Assembly: Unity.ProBuilder.Editor.dll
Syntax
[Icon("Packages/com.unity.probuilder/Content/Icons/Toolbar/CreatePolyShape.png")]
[EditorTool("Edit PolyShape", typeof(PolyShape))]
public class PolyShapeTool : EditorTool
Properties
polygon
Gets or sets the custom polygon shape.
Declaration
public PolyShape polygon { get; set; }
Property Value
| Type | Description |
|---|---|
| PolyShape |
toolbarIcon
The icon and tooltip for this custom editor tool. If this function is not implemented, the toolbar displays the Inspector icon for the target type. If no target type is defined, the toolbar displays the Tool Mode icon.
Declaration
public override GUIContent toolbarIcon { get; }
Property Value
| Type | Description |
|---|---|
| GUIContent |
Overrides
Methods
LeaveTool()
Exits the tool and restores previous persistent tool.
Declaration
protected void LeaveTool()
OnActivated()
Invoked after this EditorTool becomes the active tool.
Declaration
public override void OnActivated()
Overrides
OnObjectSelectionChanged()
Called when object selection changes.
Declaration
protected virtual void OnObjectSelectionChanged()
OnToolGUI(EditorWindow)
Implements the PolyShapeTool in the Unity Editor. This method is called when the PolyShapeTool is activated.
Declaration
public override void OnToolGUI(EditorWindow window)
Parameters
| Type | Name | Description |
|---|---|---|
| EditorWindow | window | The window calling the tool (SceneView). |
Overrides
OnWillBeDeactivated()
Invoked before this EditorTool stops being the active tool.
Declaration
public override void OnWillBeDeactivated()
Overrides
RebuildPolyShapeMesh(bool)
Redraws the PolyShape mesh in the Unity Editor.
Declaration
public void RebuildPolyShapeMesh(bool vertexCountChanged = false)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | vertexCountChanged | This parameter is ignored. |