Add PlaneCollider

Schaken 2025-01-20 23:29:13 -05:00
parent e944a93f90
commit cb473a017d

38
PlaneCollider.md Normal file

@ -0,0 +1,38 @@
# PlaneCollider
Component: GameObject
| The component that creates a one directional Plane Collider. We use this as a simple way to retrieve information in one call and send the information to the GPU. | ![https://i.imgur.com/QvzUUjK.png](https://i.imgur.com/QvzUUjK.png) |
| -------- | -------- |
## Scale
Float: Unlimited, Default 10.
+ Controls the Width and Length of the Plane Collider.
## Thickness
Float: Min 0.001, Max 1, Default 0.001
+ Controls the thickness of the collider. At 0, the cloth will get stuck. Raise this for more stability.
## Friction
Float: Min 0, Max 1, Default 0.8.
+ Low Friction (e.g., 0.1): The cloth will slide more easily over the surface. It will maintain more of its velocity when colliding with the collider.
+ High Friction (e.g., 0.9): The cloth will "stick" more to the surface. It will lose more of its velocity when colliding with the collider.
+ High Friction (e.g., 1.0): The cloth will behave as if it's \"stuck\" to the surface, maintaining its position relative to the collider.
## Gizmo Color
Color: Default Green.
+ Changes the color of the outliner for the Plane Collider.
# API
## GetCollidablePlaneStruct()
Returns the following Struct:
```Csharp
public struct CollidablePlaneStruct {
public Vector3 position;
public Vector3 rotation;
public Vector3 scale;
public Vector3 normal;
public float friction;
public float thickness;
}
```