Magica Cloth

https://magicasoft.jp/magica-cloth/
Admin
Magica Cloth is a high-performance cloth simulation asset for Unity that uses the Job System and...
Tokens:6,729
Snippets:119
Trust Score:6.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Bone Spring Properties

Source: https://magicasoft.jp/magica-cloth-bone-spring

Configuration options for the Bone Spring component.

```APIDOC
## Bone Spring Properties

### Description
Configuration options for the Bone Spring component.

### Parameters
#### Properties
- **Root List** (Transform List) - Required - Specifies the transforms to be shaken.
- **Update Mode** (Enum) - Optional - Specifies the update timing of the simulation.
  - **Normal**: Updates based on frame rate (default).
  - **Unity Physics**: Updates based on Unity's physics engine. Recommended for characters moving in FixedUpdate to suppress vibration.
- **Blend Weight** (Float) - Optional - Blend ratio with the original pose.
- **Culling** (Enum) - Optional - Culling system.
- **Algorithm** (Enum) - Optional - Calculation algorithm.
- **Radius** (Float) - Optional - Particle radius for collision detection.
- **Gravity** (Vector3) - Optional - Gravitational acceleration.
- **External Force** (Vector3) - Optional - Influence of external forces.
- **Drag** (Float) - Optional - Air resistance.
- **Max Velocity** (Float) - Optional - Maximum velocity.
- **World Influence** (Float) - Optional - Influence of world movement.
- **Distance Disable** (Float) - Optional - Disables based on distance.
- **Clamp Position** (Float) - Optional - Maximum movement distance.
- **Spring** (Float) - Optional - Spring constant.
- **Adjust Rotation** (Bool) - Optional - Controls rotation accompanying movement.
```

--------------------------------

### Capsule Collider Configuration

Source: https://magicasoft.jp/magica-cloth-capsule-collider

Configure properties for a capsule-shaped collider.

```APIDOC
## Capsule Collider Configuration

### Description
This section details the properties available for configuring a capsule collider.

### Properties

- **Is Global** (boolean) - Optional - Determines if the collider should be treated as a global collider, interacting with all cross-components.
- **Center** (Vector3) - Optional - Specifies an offset from the attached Transform.
- **Axis** (Vector3) - Optional - Defines the direction axis for the capsule. The orientation is specified by the XYZ axes of the attached Transform.
- **Length** (float) - Optional - The length of the capsule.
- **Start Radius** (float) - Optional - The radius of the capsule's start.
- **End Radius** (float) - Optional - The radius of the capsule's end.
```

--------------------------------

### Plane Collider API

Source: https://magicasoft.jp/magica-cloth-plane-collider

API documentation for the Plane Collider component.

```APIDOC
## Plane Collider

### Description
Performs plane collision detection. Note that the Plane Collider has no size and is treated as an infinite plane.

### Properties

#### Is Global
(Boolean) - Determines if the collider should be treated as a global collider. Global colliders are used for collision detection with all cloth components.

#### Center
(Vector3) - Specifies an offset from the connected Transform.
```

--------------------------------

### Mesh Cloth Properties

Source: https://magicasoft.jp/magica-cloth-mesh-cloth

This section details the properties and parameters available for the Mesh Cloth component, which control various aspects of the cloth simulation.

```APIDOC
## Mesh Cloth Properties

### Description
This section details the properties and parameters available for the Mesh Cloth component, which control various aspects of the cloth simulation.

### Properties

- **Virtual Deformer** (Virtual Deformer) - Sets the linked virtual deformer.
- **Update Mode** (Enum) - Specifies the update timing for the simulation.
  - **Normal**: Updates based on the frame rate (default).
  - **Unity Physics**: Updates based on Unity's physics engine. Recommended for characters moving within FixedUpdate to reduce vibration.
- **Blend Weight** (Float) - Blend ratio with the original pose.
- **Culling** (Culling System) - The culling system.
- **Collider List** (List<Collider>) - Sets colliders for collision detection.
- **Skinning Mode** (Enum) - Specifies how the bones and mesh for simulation deform due to external processing.
  - **None**: Declares that particles will not deform due to external factors. In this mode, the restoration of distance and angles in the simulation is calculated from the initial values. It has a lower load compared to other modes.
  - **User Animation**: Declares that particles will deform due to processes like animation. In this mode, the restoration of distance and angles in the simulation will be calculated from the deformed pose after animation, rather than from the initial values. This resolves the issue where cloth shrinks unintentionally when it deforms significantly due to animation.
- **Merge Avatar Collider** (Boolean) - If this component is an AvatarParts, it merges the Avatar's colliders upon attachment.

### Parameters

- **Algorithm** (Enum) - Calculation algorithm.
- **Radius** (Float) - Radius for collision detection.
- **Mass** (Float) - Weight.
- **Gravity** (Vector3) - Gravitational acceleration.
- **External Force** (Vector3) - Influence of external forces.
- **Drag** (Float) - Air resistance.
- **Max Velocity** (Float) - Maximum velocity.
- **World Influence** (Float) - Movement influence.
- **Distance Disable** (Float) - Disabling by distance.
- **Clamp Distance** (Float) - Maximum movement distance.
- **Clamp Position** (Float) - Movement restriction.
- **Clamp Rotation** (Float) - Maximum rotation angle.
- **Restore Distance** (Float) - Distance restoration.
- **Restore Rotation** (Float) - Rotation restoration.
- **Triangle Bend** (Float) - Triangle angle restoration.
- **Collision** (Boolean) - Collision detection.
- **Penetration** (Float) - Penetration restriction.
- **Adjust Line** (Float) - Line rotation adjustment.
```
Tokens:
Raw