Initial commit

Library/PackageCache/com.unity.2d.spriteshape@3.0.14/Documentation~/SSCollision.md

@@ -0,0 +1,14 @@
+# Enabling Collision
+
+Attach a __Collider 2D__ component to your Sprite Shape to enable the Collider properties in the __Sprite Shape Controller.__ Only the __Edge__ and __Polygon Collider 2D__ components can be used with __Sprite Shapes__.
+
+![Attaching a Collider component](images/v1.1-Collider.png)
+
+The Collider mesh automatically updates itself to the shape of the Sprite Shape when attached. See the Collider section of the [Sprite Shape Controller](SSController.md) page for more details about the Sprite Shape Collider options.
+
+By default, the Collider mesh is automatically reshaped to match the Sprite Shape every time it is edited. To make manual edits to the Collider mesh directly, first disable both __Update Collider__ and __Optimize Collider__ in the __Sprite Shape Controller's__ Collider settings to prevent the Controller from updating the Collider mesh automatically and overriding your manual edits.
+
+![Disabling the Collider options](images/v1.1-ColliderOptionsDisable.png)
+
+You can now edit the Collider mesh independent of the shape of the __Sprite Shape.__
+

Library/PackageCache/com.unity.2d.spriteshape@3.0.14/Documentation~/SSController.md

@@ -0,0 +1,103 @@
+# Sprite Shape Controller
+
+The __Sprite Shape Controller__ component is automatically attached to the GameObject created when a __Sprite Shape Profile__ is dragged into the Scene. You edit the shape of the Sprite Shape's outline through the Controller's settings. The Controller displays different settings depending on different conditions.
+
+## Property Settings - Default
+
+The default component settings below are displayed when Edit Spline is not enabled.
+
+![Sprite Shape Controller property settings](images/2019_3_SSController_noedit.png)
+
+| __Property__                                                 | __Function__                                                 |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| __Profile__                                                  | Select the __Sprite Shape Profile__ used by this Sprite Shape. |
+| __Edit Spline__                                              | Enable ![](images/PropertyImage1.png) to make the Control Points of the Sprite Shape visible and editable. |
+| __Spline__                                                   | -                                                            |
+| __Detail__                                                   | Select the tessellation quality of the rendered Sprite Shape mesh. High/Medium/Low Quality options available. |
+| __Open Ended__                                               | Disable to connect both ends of the Sprite Shape together to form an enclosed Shape. Enable to leave both ends of the Sprite Shape unconnected. |
+| __Adaptive UV__                                              | Enabled by default. When enabled, Unity attempts to seamlessly tile the Sprites along the Sprite Shape path by deforming the Sprites to between Control Points. Disable this property to tile Sprites with no deformation and at  their exact width. Sprites may appear cutoff if the space between Control Points is shorter than the width of the Sprite. |
+| __Fill__                                                     | -                                                            |
+| __Stretch UV__                                               | Enable this setting to have Unity stretch the UV of the Fill texture across the Full Rect of the Sprite Shape. |
+| __Pixels Per Unit__ (only available when Stretch UV is disabled) | This values affect the appearance of the Fill texture of the Sprite Shape. This value affects the scale of the Fill texture, with higher values reducing the size of the texture. The default value is 100. |
+| __World Space UV__ (only available when __Stretch UV__ is disabled) | Enable to apply the Fill texture according to the World Space UV, instead of per GameObject UV. |
+
+### With Edit Spline enabled and a Control Point selected
+
+Enable __Edit Spline__ in the Controller settings to make Control Points on the Sprite Shape visible and editable. Selecting a Control Point enables the following additional Controller settings.
+
+![With a Control Point selected](images/enable_tangents.png)
+
+| __Point__                                               | -                                                            |
+| ------------------------------------------------------- | ------------------------------------------------------------ |
+| __Tangent Mode__                                        | Select one of three __Point Modes__ to change the way tangents on Control Points are edited. |
+| ![](images/2D_SpriteShape_7.png)__Linear__              | No curve is formed between the Control Point and its neighboring points. |
+| ![](images/2D_SpriteShape_8.png)__Continuous Mirrored__ | Two tangents appear on opposite sides of the Control Point, and the spline between the Control Point and its neighbors becomes curved. Adjust the tangents to change the shape of the curve. The angle between the two tangents is always 180 degrees in this mode. |
+| ![](images/2D_SpriteShape_9.png)__Broken Mirrored__     | Two tangents appear on opposite sides of the Control Point, and the spline between the Control Point and its neighbors becomes curved. Adjust the tangents to change the shape of the curve. The length and angle of the tangents can be adjusted independently in this mood. |
+| __Position__                                            | The local x and y coordinates of a selected Control Point.   |
+| __Height__                                              | Increase or decrease the height of Sprites at the Control Point by a factor of 0.1 to 4. |
+| __Corner__                                              | Sets whether Corner Sprites are rendered at Control Points. Set to __Automatic__ by default. |
+| __Disabled__                                            | The selected Control Point does not automatically render a Control Point. |
+| __Automatic__                                           | The Control Point displays the assigned Corner Sprite, if both it and its neighbors are in __Linear Point Mode__. |
+| __Sprite Variant__                                      | Select the __Sprite Variant__ from the visual Variant selector. Press __N__ to cycle through all available Variants for the Control Point. |
+| __Snapping__                                            | Enable to snap Control Points according the Project's Snap settings. |
+
+### Additional Collider settings
+
+Add either the __Polygon Collider 2D__ or __Edge Collider 2D__ component to the __Sprite Shape__ to enable additional __Collider__ settings in the __Sprite Shape Controller__. See the [Enabling Collision](SSCollision.md) page for more details about enabling Colliders with Sprite Shapes.
+
+![Collider settings](images/2019_3_SSController_collider.png)
+
+| Collider              | -                                                            |
+| --------------------- | ------------------------------------------------------------ |
+| __Update Collider__   | Enabled by Default. Enable this option to have the Collider mesh be updated to the Sprite Shape's current shape as the Sprite Shape is edited. Disable if you are editing the Collider mesh separately from the Sprite Shape and to use a custom Collider mesh. |
+| __Offset__            | Select the amount to extrude the Collider mesh towards the edge of the Sprite Shape. The range is from -0.5 to 0.5, starting at 0 by default. |
+| __Optimize Collider__ | Enabled by default. Enable to have Unity optimize the Collider mesh by cleaning up extra control points that are co-linear. Disable this option when editing the Collider mesh separately from the Sprite Shape to prevent Unity from affecting the custom Collider mesh. |
+| __Detail__            | Sets the tessellation quality of the rendered Collider. High/Medium/Low Quality options available. |
+
+
+
+## Editing the Spline
+
+To edit the mesh outline of the __Sprite Shape__, click the __Edit Spline__ button to make the Shape's spline and its __Control Points__ become visible and editable.
+
+![Edit Spline enabled](images/UpdatedEditSpline_2019-3.png)
+
+When __Edit Spline__ is enabled, move the Control Points of the Sprite Shape to adjust its overall shape and size. Add additional Control Points by clicking on the spline in between Control Points. Press the __Del/Delete__ key to remove the currently selected Control Point.
+
+![Control Point added to spline](images/2D_SpriteShape_032.png)
+
+With a Control Point selected, cycle through the __Point Modes __by pressing the __M__ key. To change the __Mode__ of multiple Control Points at once, ensure that all selected Control Points are the same __Mode__ first before cycling or selecting another __Mode__.
+
+To change the Sprite Variant currently displayed at a selected Control Point, press the __N__ key to cycle through all available Variants.
+
+All shortcut keys can be rebound under the Shortcut menu (menu: __Edit > Shortcuts... > SpriteShape Editing__).
+
+## Point Modes
+
+When a Control Point is selected, its __Point Mode__ can be one of three modes- __Linear__, __Mirrored__, and __Non-Mirrored__.
+
+The __Point Mode__ determines the behavior of the tangents that are used to adjust the spline between Control Points. Each Control Point can be set to a specific Point Mode and contain its own settings. 
+
+### Linear Point Mode
+
+In __Linear Point Mode__, there are no tangents to control the curve between the Control Point and its neighbors, curves are not formed between Control Points and Sprites may overlap if they intersect. 
+
+Adjust which Sprite is displayed when two or more intersect by adjusting their __Order__ value in the [Sprite Shape Profile's](SSProfile.md) __Angle Range__ settings.
+
+![Linear Point Mode](images/2D_SpriteShape_034.png)
+
+### Continuous Mirrored Point Mode
+
+In __Continuous Mirrored Point Mode__, tangents appear on both sides of the selected Control Point to create a curve between the Control Point and its neighbors. Adjust the shape of the curve with the tangents. In this mode, the angle between the tangents is always maintained at 180 degrees although their lengths from the can vary. 
+
+Press __B__ to mirror the length of the last edited tangent onto the opposite tangent.
+
+![Mirrored Point Mode](images/2D_SpriteShape_033.png)
+
+### Broken Mirrored Point Mode
+
+In __Broken Mirrored Point Mode__,  tangents appear on both sides of the selected Control Point to create a curve between the Control Point and its neighbors. Adjust the shape of the curve with the tangents. In this mode, the length and angle of each tangent can be adjusted independently. 
+
+Press __B__ to mirror the length of the last edited tangent onto the opposite tangent. In this mode, pressing __B__ also causes the angle of the opposite tangent to become exactly 180 degrees from the last edited tangent.
+
+![Non-Mirrored Mode](images/2D_SpriteShape_036.png)

Library/PackageCache/com.unity.2d.spriteshape@3.0.14/Documentation~/SSProfile.md

@@ -0,0 +1,95 @@
+# Sprite Shape Profile
+
+The __Sprite Shape Profile__ contains the settings that determine which Sprites that appear on a Sprite Shape at specific Angle Ranges, as well as other display settings. You can use the same Profile for multiple __Sprite Shapes__ in a Scene.
+
+Create a __Sprite Shape Profile__ from the Editor main menu (menu: __Assets > Create > Sprite Shape Profile__), and select from the two available options: __Open Shape__ and __Closed Shape__.
+
+![](images/v1.1-SSProfile.png)
+
+| **Property**                                                 | **Function**                                                 |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| **Control Points**                                           | -                                                            |
+| **Use Sprite Borders**                                       | Enable to draw the **Sprite Borders** of a Sprite at the Control Point. Define the **Sprite Borders** in the **Sprite Editor**. |
+| **Fill**                                                     | -                                                            |
+| **Texture**                                                  | Set the Texture to be used as a Fill to this field. Has no effect if the **Open Ended** property in the **Sprite Shape Controller** settings is enabled. |
+| **Offset**                                                   | Determines the border offset at the edges of the Fill texture. |
+| ![Angle Range tool](images/v1.1-AngleRange.png)**Angle Ranges (tool)** | Use this tool to create Angle Ranges and assign Sprites to those ranges. |
+| **Start (degrees)**                                          | Enter the starting angle for the selected Angle Range in degrees. |
+| **End (degrees)**                                            | Enter the ending angle for the selected Angle Range in degrees. |
+| **Order**                                                    | Determines the display priority when Sprites intersect. Sprites with higher values are rendered above lower ones. |
+| **Sprites**                                                  | List of Sprites assigned to the selected Angle Range. Displays a list of all Sprites assigned to the selected Angle Range. The order of Sprites in the list determines their **Sprite Variant** number, starting from zero at the top of the list. The first Sprite at the top of the list is the Sprite displayed by default at a Control Point. |
+| **Corners**                                                  | -                                                            |
+| *** All Corner options**                                     | Assign specific Sprites to be displayed on the Sprite Shape at the respective corners. Refer to the documentation on [Corner Sprites]() for more information. |
+
+## Open Shape
+
+![Open Shape Profile preset](C:\Users\Sam\Documents\GitHub\com.unity.2d.spriteshape\Documentation~\images\OpenShapeProfile.png)
+
+Use the __Open Shape__ preset Profile to create Shapes made from a single edge outline with tiled Sprites along its edge. This preset is ideal for creating level elements such as platforms. 
+
+![Example of an Open Shape](images/2D_SpriteShape_024.png)
+
+Drag the Open Shape Profile into the Scene view to automatically generate a Sprite Shape with __Open Ended__ enabled in its __Sprite Shape Controller__ settings.
+
+## Closed Shape
+
+![Closed Shape Profile preset](images/ClosedShapeProfile.png)
+
+Use the __Closed Shape__ preset Profile to create Shapes that encompass an enclosed area. The Closed Sprite Shape can display and tile a Fill texture in the enclosed area, if a Fill texture is set in its Profile settings. Use this preset to create large solid filled Shapes that are ideal for backgrounds or large platforms.
+
+![Closed Shape square](images/v1.1-ClosedShapeSquare.png)
+
+Drag the Closed Shape Profile into the Scene view to automatically generate a Sprite Shape with __Open Ended__ disabled in its __Sprite Shape Controller__ settings. The Closed Shape Profile's preset Angle Ranges create a square Sprite Shape by default.
+
+A key feature of the __Sprite Shape Profile__ is the Angle Ranges tool. Assigning an Angle Range determines what Sprite is displayed at specific angles, as the Sprite Shape is deformed in the Scene.
+
+## Creating Angle Ranges 
+
+### Method 1:
+
+To create an Angle Range, click the __Create Range__ button at the bottom of the Angle Ranges tool:
+
+![The 'Create Range'button](images/2D_SpriteShape_014.png)
+
+The __Create Range__ button is only visible if the __Preview Handle__ is over an area without an Angle Range (see the example image below).
+
+![Selecting the preview handle](images/2D_SpriteShape_015.png)
+
+### Method 2:
+
+Another way is to hover your cursor over an empty area of the Angle Range circle. An outline appears to show the possible default angle range. Click to create this Angle Range.
+
+![Angle Range outline](images/2D_SpriteShape_017.png)
+
+### Editing the Angle Range degrees
+
+The range covered by the currently selected Angle Range is displayed at the bottom of the tool.
+
+![Enter Angle Range values](images/2D_SpriteShape_018.png)
+
+You can edit a range by entering new values into __Start__ and __End__, or drag either endpoint of the tool to the desired angles. A range cannot be extended into an existing neighboring range. To delete an Angle Range, select the range and then press the __Del/Delete__ key.
+
+## Assigning Sprites
+
+After creating the Angle Ranges, the next step is to assign Sprites to those ranges. The __Sprites__ list is found beneath the __Angle Ranges__ tool. It lists all the Sprites assigned to the selected range.
+
+![Sprite List](images/2D_SpriteShape_019.png)
+
+To add Sprites to the list, click the __+__ icon to insert a new row to the list.  Click the circle icon next to the empty row to open the __Object Picker__ window, which displays all available Sprites in the project.
+
+![Adding a row to the list](images/2D_SpriteShape_020.png)
+
+You can also drag a Sprite directly onto a row to add it to the list. The Sprite at the top of the list is the default Sprite displayed on the Sprite Shape.  Refer to the other Sprites in the list by their [Sprite Variant](SSController.md) number. See the [Sprite Shape Controller](SSController.md) page for more details.
+
+![Drag and drop Sprites to the row to add to the list](images/2D_SpriteShape_021.png)
+
+Drag the leftmost ends of the rows up or down to reorder the list, which changes the __Sprite Variant__ numbers of the Sprites accordingly.
+
+## Previewing Sprites of multiple Angle Ranges
+
+After assigning Sprites to multiple __Angle Ranges__, rotate the Preview Handle around the Angle Range tool to preview the Sprites assigned those ranges.
+
+![Previewing one range](images/2D_SpriteShape_022.png)
+
+![Previewing the other range](images/2D_SpriteShape_023.png)
+

Library/PackageCache/com.unity.2d.spriteshape@3.0.14/Documentation~/TableOfContents.md

@@ -0,0 +1,5 @@
+* [Overview](index.md)
+* [Sprite Shape Profile](SSProfile.md)
+* [Sprite Shape Controller](SSController.md)
+* [Enabling Collision](SSCollision.md)
+

Library/PackageCache/com.unity.2d.spriteshape@3.0.14/Documentation~/index.md

@@ -0,0 +1,39 @@
+# 2D Sprite Shape
+
+## Overview
+
+The __Sprite Shape__ is a flexible and powerful world building Asset that features Sprite tiling along a shape's outline that automatically deforms and swaps Sprites based on the angle of the outline.  Additionally, you can assign a Fill texture to a Sprite Shape to create filled shapes with tiled textures as backgrounds or other large level-building props. 
+
+The following are examples of Sprite Shapes used to construct different parts of various levels.
+
+![](images/2D_SpriteShape_1.png)
+
+![](images/2D_SpriteShape_2.png)
+
+![](images/2D_SpriteShape_3.png)
+
+
+
+Sprite Shapes comprise of two parts - the [Sprite Shape Profile](SSProfile.md) Asset, and the [Sprite Shape Controller](SSController.md) component. The Sprite Shape Profile contains the angle settings and Sprites used by the Sprite Shape, and you edit the Sprite Shape's outline with the Sprite Shape Controller component.
+
+## Importing Sprites for Sprite Shapes
+
+We recommend using the following settings when importing Sprites for a Sprite Shape:
+
+1. [Texture Type](https://docs.unity3d.com/Manual/TextureTypes.html#Sprite) - Set this to __Sprite (2D and UI)__. Other texture types are not supported for Sprite Shapes.
+2. __Sprite Mode__ - Set this to __Single__ if the texture contains only a single Sprite.
+3. __Mesh Type__ - Set this to __Full Rect__. 
+
+## Sprite Shape Workflow
+
+Create __Sprite Shapes__ in following the steps:
+
+1. Create a __Sprite Shape Profile__ from the main menu (menu: __Assets > Create > Sprite Shape Profile__). Select from the two available options: 
+   - [Open Shape](SSProfile.html#open-shape)
+   - [Closed Shape](SSProfile.html#closed-shape)
+2. Create [Angle Ranges](SSProfile.html#creating-angle-ranges) and [assign Sprites](SSProfile.html#assigning-sprites) in the __Sprite Shape Profile__.
+3. Drag the __Sprite Shape Profile__ into the Scene to automatically generate a __Sprite Shape__ GameObject based on that Profile. 
+   - You can create a Sprite Shape GameObject without a Profile from the main menu (menu: __GameObject > 2D Object > Sprite Shape__). Then select a Sprite Shape Profile in the __Sprite Shape Controller__'s __Profile__ settings. The same Profile can be used by multiple Sprite Shapes.   
+4. Edit the outline of the Sprite Shape with the [Sprite Shape Controller](SSController.md) component settings.
+5. Enable [Physics2D](https://docs.unity3d.com/Manual/class-Physics2DManager.html) interactions for your Sprite Shapes by attaching a [Collider](SSCollision.md) component.
+