Configuration

Introduction

PuppetConfiguration represents the physics configuration that will be applied to slave representations of bones driven by a Puppet module. The physics configuration includes variables that will be applied to Pheasy (and its related Rigidbody) and TargetConstraint (and its related ConfigurabeJoint) for each of these slave representations.

Physics configuration variables are common for all slave bones but not their values. These values can differ depending on the class of slave bone. These classes are:

  • Root: Applied to PuppetModel.part.root.reprs[PuppetModel.key].

  • Special: Applied to bones under PuppetModel.part where (BoneModel.reprs[PuppetModel.key] as PuppetReprModel).isSpecial is true.

  • Standard: Applied to the rest of bones under PuppetModel.part.

Each of these groups of variables are objects of class PuppetBoneConfiguration.

PuppetBoneConfiguration

Drives

  • Rotation Drive: Joint drive values that will be applied to ConfigurableJoint.angularXDrive, ConfigurableJoint.angularYZDrive and ConfigurableJoint.slerpDrive.

  • Position Drive: Joint drive values that will be applied to ConfigurableJoint.xDrive, ConfigurableJoint.yDrive and ConfigurableJoint.zDrive.

Rigidbody

  • Use Gravity: This value will applied to Rigidbody.useGravity.

  • Rigidbody Mass: This value will applied to Rigidbody.mass.

  • Rigidbody Drag: This value will applied to Rigidbody.drag.

  • Rigidbody Angular Drag: This value will applied to Rigidbody.angularDrag.

Stability

  • Safe Mode: This value will applied to Pheasy.safeMode.

  • Max Linear Velocity: This value will applied to Pheasy.maxVelocity.

  • Max Angular Velocity: This value will applied to Pheasy.maxAngularVelocity.

  • Max Depenetration Velocity: This value will applied to Pheasy.maxDepenetrationVelocity.

  • Max Error Allowed: This value will applied to Pheasy.maxErrorAllowed.

Joint

  • Joint Mass Scale: This value will applied to ConfigurableJoint.massScale.

  • Joint Connected Mass Scale: This value will applied to ConfigurableJoint.connectedMassScale.

Debug

  • Force: This value will applied to TargetConstraint.force.

Last updated