IC8 Python API:RLPy RICloth
Contents
- 1 Description
- 2 Class Methods
- 2.1 RLPy.RICloth.CalculateCollision(self)
- 2.2 RLPy.RICloth.ConvertToAccessory(self, bCurrentShape )
- 2.3 RLPy.RICloth.GetClothConformValue(self, strConform )
- 2.4 RLPy.RICloth.GetMaterialComponent(self)
- 2.5 RLPy.RICloth.IsClothConformingEnable(self)
- 2.6 RLPy.RICloth.SetClothConformingEnable(self, bEnable )
- 2.7 RLPy.RICloth.SetClothConformValue(self, strConform, fValue )
- 2.8 RLPy.RICloth.TransferSkinWeight(self, strTemplateType )
- 3 Description
- 4 Constructor & Destructor
- 5 Member Functions
- 5.1 CalculateCollision (self)
- 5.2 ConvertToAccessory (self, bCurrentShape)
- 5.3 GetClothConformValue (self, strConform)
- 5.4 GetClotheType (self)
- 5.5 GetMaterialComponent (self)
- 5.6 GetPhysicsComponent (self)
- 5.7 IsClothConformingEnable (self)
- 5.8 SetClothConformValue (self, strConform, fValue)
- 5.9 SetClothConformingEnable (self, bEnable)
- 5.10 SetClotheType (self, eClotheType)
- 5.11 TransferSkinWeight (self, strTemplateType)
- 6 Properties
- Main article: iC8 Modules.
- Last modified: 10/21/2026
Description
Represents a cloth item. It provides controls for cloth fitting, conform values, clothing type, and collision calculation, along with accessory conversion, skin-weight transfer, and access to material and physics components.
Class Methods
RLPy.RICloth.CalculateCollision(self)
- ⚠ This function will only be availabe after the release of CC 4.3!
Calculates soft-cloth collisions.
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RICloth.ConvertToAccessory(self, bCurrentShape )
Converts cloth to accessory.
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RICloth.GetClothConformValue(self, strConform )
Get conform property value.
Returns
cloth conform property value - float
1 # No example
RLPy.RICloth.GetMaterialComponent(self)
Get material component of the object.
Returns
Pointer of the RIMaterialComponent object - RLPy.RIMaterialComponent
1 # No example
RLPy.RICloth.IsClothConformingEnable(self)
Get cloth fitting enable status.
Returns
cloth fitting enable status - bool
1 # No example
RLPy.RICloth.SetClothConformingEnable(self, bEnable )
Set cloth fitting enable status.
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RICloth.SetClothConformValue(self, strConform, fValue )
Set conform property value.
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RICloth.TransferSkinWeight(self, strTemplateType )
Transfer skin weight.
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
Description
Represents a cloth item. It provides controls for cloth fitting, conform values, clothing type, and collision calculation, along with accessory conversion, skin-weight transfer, and access to material and physics components.
Constructor & Destructor
__init__ (self, *args, **kwargs)
Initializes a new ri cloth instance.
Parameters
- args
- kwargs
Member Functions
CalculateCollision (self)
Sets calculate collision.
ConvertToAccessory (self, bCurrentShape)
Converts cloth to accessory.
Parameters
- bCurrentShape
GetClothConformValue (self, strConform)
Gets conform property value.
Parameters
- strConform
GetClotheType (self)
Gets clothe type.
GetMaterialComponent (self)
Gets material component of the object.
GetPhysicsComponent (self)
Gets physics component of the object.
IsClothConformingEnable (self)
Gets cloth fitting enable status.
SetClothConformValue (self, strConform, fValue)
Sets conform property value.
Parameters
- strConform
- fValue
SetClothConformingEnable (self, bEnable)
Sets cloth fitting enable status.
Parameters
- bEnable
SetClotheType (self, eClotheType)
Change clothe type.
Parameters
- eClotheType
TransferSkinWeight (self, strTemplateType)
Transfer skin weight.
Parameters
- strTemplateType
Properties
thisown
Indicates whether this SWIG proxy owns the underlying C++ object.