IC8 Python API:RLPy RIPhysicsComponent

From Reallusion Wiki!
Jump to: navigation, search

Contents

Main article: iC8 Modules.
Last modified: 10/21/2026

Description

Provides object physics controls and soft-physics data access, including gravity and activation settings, PhysX properties and collision settings, and soft-cloth weight-map operations.

Class Methods

RLPy.RIPhysicsComponent.GetSoftPhysicsMaterialNameList(self, strMeshName )

Get all material names which are available to modify weight map.

Experimental API

Returns

std::vector<std::wstring > material names 

1 # No example

RLPy.RIPhysicsComponent.GetSoftPhysicsMeshNameList(self)

Get all mesh names which are available to modify weight map.

Experimental API

Returns

std::vector<std::wstring > mesh names 

1 # No example

RLPy.RIPhysicsComponent.GetSoftPhysXCollisionEnable(self, strMeshName, strMaterialName, strCollisionName )

Get status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMaterialName[IN] The name for material of mesh - string
strPropertyName[IN] The name for material's PhysX collision.

Returns

enable(true) or disable (false) 

1 # No example

RLPy.RIPhysicsComponent.GetSoftPhysXCollisionValue(self, strMeshName, strMaterialName, strCollisionName )

Get status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMaterialName[IN] The name for material of mesh - string
strPropertyName[IN] The name for material's PhysX collision.

Returns

valueof PhysX collision 

1 # No example

RLPy.RIPhysicsComponent.GetSoftPhysXProperty(self, strMeshName, strMaterialName, strPropertyName )

Get status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMaterialName[IN] The name for material of mesh - string
strPropertyName[IN] The name for material's PhysX property - string

Returns

valueof PhysX property 

1 # No example

RLPy.RIPhysicsComponent.IsActivatePhysicsEnable(self)

Get status of PhysX checkboxs.

Experimental API

Returns

enable(true) or disable (false) 

1 # No example

RLPy.RIPhysicsComponent.IsObjectGravityEnable(self, strMeshName, strMaterialName )

Get status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMeshName[IN] The name for material - string

Returns

enable(true) or disable (false) 

1 # No example

RLPy.RIPhysicsComponent.SavePhysicsSoftColthWeightMap(self, strMeshName, strMaterialName, strFilePath )

Get matherial weight image.

Experimental API

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIPhysicsComponent.SetActivatePhysicsEnable(self, bActivate )

Set status of PhysX checkboxs.

Experimental API

Parameters

bCheck[IN] The status of checkbox.

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIPhysicsComponent.SetObjectGravityEnable(self, strMeshName, strMaterialName, bObjectGravity )

Set status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMeshName[IN] The name for material - string
bCheck[IN] The status of checkbox.

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIPhysicsComponent.SetPhysicsSoftColthWeightMap(self, strMeshName, strMaterialName, strFilePath )

Set matherial weight image.

Experimental API

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIPhysicsComponent.SetSoftPhysXCollisionEnable(self, strMeshName, strMaterialName, strCollisionName, bEnable )

Set status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMaterialName[IN] The name for material of mesh - string
strCheckboxName[IN] The name for material's PhysX collision.
fPropertyName[IN] The value of PhysX collision.

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIPhysicsComponent.SetSoftPhysXCollisionValue(self, strMeshName, strMaterialName, strCollisionName, fValue )

Set status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMaterialName[IN] The name for material of mesh - string
strCheckboxName[IN] The name for material's PhysX collision.
fPropertyName[IN] The value of PhysX collision.

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIPhysicsComponent.SetSoftPhysXProperty(self, strMeshName, strMaterialName, strPropertyName, fValue )

Set status of PhysX checkboxs.

Experimental API

Parameters

strMeshName[IN] The name for mesh - string
strMaterialName[IN] The name for material of mesh - string
strCheckboxName[IN] The name for material's PhysX property.
fPropertyName[IN] The value of PhysX property.

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

Description

Provides object physics controls and soft-physics data access, including gravity and activation settings, PhysX properties and collision settings, and soft-cloth weight-map operations.

Constructor & Destructor

__init__ (self, *args, **kwargs)

Initializes a new ri physics component instance.

Parameters

  • args
  • kwargs

Member Functions

GetPhysicsSoftColthWeightMap (self, strMeshName, strMaterialName)

Gets matherial weight image.

Parameters

  • strMeshName
  • strMaterialName

GetSoftPhysXCollisionEnable (self, strMeshName, strMaterialName, strCollisionName)

Gets status of PhysX checkboxs.

Parameters

  • strMeshName
  • strMaterialName
  • strCollisionName

GetSoftPhysXCollisionValue (self, strMeshName, strMaterialName, strCollisionName)

Returns the Soft PhysX collision value for the specified mesh, material, and collision name.

Parameters

  • strMeshName
  • strMaterialName
  • strCollisionName

GetSoftPhysXProperty (self, strMeshName, strMaterialName, strPropertyName)

Returns the Soft PhysX property value for the specified mesh, material, and property name.

Parameters

  • strMeshName
  • strMaterialName
  • strPropertyName

GetSoftPhysicsMaterialNameList (self, strMeshName)

Gets all material names which are available to modify weight map.

Parameters

  • strMeshName

GetSoftPhysicsMeshNameList (self)

Gets all mesh names which are available to modify weight map.

IsActivatePhysicsEnable (self)

Reports whether physics activation is enabled for this object.

IsObjectGravityEnable (self, strMeshName, strMaterialName)

Reports whether gravity is enabled for this object.

Parameters

  • strMeshName
  • strMaterialName

SavePhysicsSoftColthWeightMap (self, strMeshName, strMaterialName, strFilePath)

Saves the soft cloth weight map for the specified mesh and material to the given file path.

Parameters

  • strMeshName
  • strMaterialName
  • strFilePath

SetActivatePhysicsEnable (self, bActivate)

Sets the activate physics enable.

Parameters

  • bActivate

SetObjectGravityEnable (self, strMeshName, strMaterialName, bObjectGravity)

Sets the object gravity enable.

Parameters

  • strMeshName
  • strMaterialName
  • bObjectGravity

SetPhysicsSoftColthWeightMap (self, *args)

Sets matherial weight image.

Parameters

  • args

SetSoftPhysXCollisionEnable (self, strMeshName, strMaterialName, strCollisionName, bEnable)

Sets status of PhysX checkboxs.

Parameters

  • strMeshName
  • strMaterialName
  • strCollisionName
  • bEnable

SetSoftPhysXCollisionValue (self, strMeshName, strMaterialName, strCollisionName, fValue)

Sets the Soft PhysX collision value for the specified mesh, material, and collision name.

Parameters

  • strMeshName
  • strMaterialName
  • strCollisionName
  • fValue

SetSoftPhysXProperty (self, strMeshName, strMaterialName, strPropertyName, fValue)

Sets the Soft PhysX property value for the specified mesh, material, and property name.

Parameters

  • strMeshName
  • strMaterialName
  • strPropertyName
  • fValue

Properties

thisown

Indicates whether this SWIG proxy owns the underlying C++ object.

Retrieved from "http://wiki.reallusion.com/index.php?title=IC8_Python_API:RLPy_RIPhysicsComponent&oldid=6186"