Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes

JointParticles Class

This class is used to pin BodyCloth or BodyRope to rigid bodies, ragdolls or dummy bodies. To attach a cloth or a rope, its particles simulated in mesh vertices are restricted.

JointParticles Class

Members


JointParticles ()

Constructor. Creates a particle joint with an anchor at the origin of the world coordinates.

JointParticles (const Ptr<Body> & body0, const Ptr<Body> & body1)

Constructor. Creates a particle joint connecting two given bodies. An anchor is placed in the center of the body to which the cloth or rope are pinned.

Arguments

  • const Ptr<Body> & body0 - The first body to be connected with the joint. It can be one of the following:
  • const Ptr<Body> & body1 - The second body to connect with the joint. It can be one of the following:

JointParticles (const Ptr<Body> & body0, const Ptr<Body> & body1, const Math::Vec3 & anchor, const Math::vec3 & size)

Arguments

  • const Ptr<Body> & body0
  • const Ptr<Body> & body1
  • const Math::Vec3 & anchor
  • const Math::vec3 & size

int getNumParticles ()

Returns the total number of pinned particles of the cloth or rope body.

Return value

The number of pinned particles.

void setSize (const Math::vec3 & size)

Updates a size of the area for pinning vertices of cloth or rope body to another body.

Arguments

  • const Math::vec3 & size - Size of the area to be pinned.

Math::vec3 getParticlePosition (int num)

Returns the position of the pinned particle of the cloth or rope body.

Arguments

  • int num - Particle number.

Return value

Particle position.

float getParticleMass (int num)

Returns the mass of the pinned particle of the cloth or rope body.

Arguments

  • int num - Particle number.

Return value

Particle mass.

float getThreshold ()

Returns the current threshold that determines the distance for pinning vertices of cloth or rope body to another body. If vertices are closer than the threshold, they are pinned together; otherwise, particles stay loose.

Return value

Threshold of pinning distance.

void setThreshold (float threshold)

Updates a threshold that determines the distance for pinning vertices of cloth or rope body to another body. If vertices are closer than the threshold, they are pinned together; otherwise, particles stay loose.

Arguments

  • float threshold - Threshold of pinning distance.

Math::vec3 getSize ()

Returns the current size of the area of pinned vertices of cloth or rope body to another body.

Return value

Size of the pinned area.

void clearParticles ()

Unpins the cloth or rope body completely.
Last update: 2017-07-03