This page has been translated automatically.
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::BodyCloth Class

Header: #include <UniginePhysics.h>
Inherits: 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


static BodyClothPtr create ( ) #

Constructor. Creates a cloth body with default properties.

static BodyClothPtr create ( const Ptr<Object> & object ) #

Constructor. Creates a cloth body with default properties for a given object.


  • const Ptr<Object> & object - Object represented with the new cloth body.

Ptr<BodyCloth> cast ( const Ptr<BodyParticles> & bodyparticles ) #


  • const Ptr<BodyParticles> & bodyparticles

Ptr<BodyCloth> cast ( const Ptr<Body> & body ) #


  • const Ptr<Body> & 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.


  • 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).


  • 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: 2019-08-16
Build: ()