BodyCloth Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits from: | BodyParticles |
This class is used to simulate a flat deformable cloth bodies. They use a mass-spring simulation model: the cloth is formed from particles (of sphere shape) that are located in the cloth mesh vertices and connected by inner joints.
See Also#
- The Creating and Attaching a Cloth usage example demonstrating how to create an object, assign a cloth body to it, and set its parameters
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/physics/ folder:
- cloth_00
- cloth_01
- cloth_02
- cloth_03
- cloth_04
- cloth_05
- cloth_06
- cloth_07
- cloth_08
BodyCloth Class
Members
static BodyCloth ( ) #
Constructor. Creates a cloth body with default properties.static BodyCloth ( Object object ) #
Constructor. Creates a cloth body with default properties for a given object.Arguments
- Object object - Object represented with the new cloth body.
int getNumIndices ( ) #
Returns the number of particle indices.Return value
Number of particle indices.int getParticleIndex ( int num ) #
Returns the particle index by its number.Arguments
- int num - The particle index number.
Return value
The particle index.void setTwoSided ( int sided ) #
Set a value indicating if the cloth is one- or two-sided. (If two-sided, its material should not be two-sided at the same time).Arguments
- int sided - Positive value, if the cloth should be two-sided; 0 if one-sided.
int getTwoSided ( ) #
Returns a value indicating if the cloth is one- or two-sided. (If two-sided, its material should not be two-sided at the same time).Return value
1 if the cloth is rendered one-sided; 0 if one-sided.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)