Click or drag to resize
TetrapodCharacterizationTemplate Methods

The TetrapodCharacterizationTemplate type exposes the following members.

Methods
  NameDescription
Public methodApplyAdvancedDefaultSettings
Configures all of the fields on this instance for a default human with freedom of movement about all axes. These settings tend to produce TetrapodRagdolls that settle less readily, but that can approximate a more realistic range of motion.
Public methodApplyBasicDefaultSettings
Configures all of the fields on this instance for a default human with no freedom of movement about the twist axes. These settings tend to produce TetrapodRagdolls that settle more readily, but that have a less realistic range of motion.
Protected methodApplyCenterOfMassParameter
Applies the center of mass parameter value to the supplied body, interpreting parameter as the percentage of the distance to the average position of its children.
Protected methodApplyCenterOfMassParametersToBasicParts
Applies the center of mass parameters to all non-chain parts. Override this method if you need to interpret them differently from the default mode.
Protected methodApplyDefaultShapeSizesAndCenters
Apply shape sizes and centers to all parts assuming they are long limbs.
Protected methodApplyJointAxes
Applies the joint axes and axis reflection modes to the supplied tetrapod. Override this method if your joint axes have different meanings from the defaults, or you do not assume the character is a humanoid in a T-Pose.
Protected methodApplySettingsToArbitraryChains
Applies arbitrary chain settings to the corresponding chain in the tetrapod, if it exists.
Protected methodApplyShapeSizesAndCenters
Applies the shape sizes and centers to the supplied tetrapod. Override this method if you are working with non-humanoid characters.
Protected methodApplyShapeSizesAndCentersAsHumanoid
Applies the shape sizes and centers to the supplied tetrapod, assuming it is humanoid.
Protected methodApplyShapeSizesAndCentersAsNonHumanoid
Applies the shape sizes and centers to the supplied tetrapod, assuming it is non-humanoid.
Protected methodApplyShapeTypeToChain
Applies the shape type specified in the settings to the bodies in the chain.
Public methodApplyTo
Applies the settings specified on this TetrapodCharacterizationTemplate to the specified tetrapod. The character is assumed to be in a neutral pose (e.g., T-Pose).
Protected methodStatic memberClearAngularZLimit
Protected methodDistributeArbitraryChainAngularLimits
Distributes the arbitrary chain angular limits. Override this method if you want an uneven distribution.
Protected methodDistributeArbitraryChainMass
Distributes the arbitrary chain mass. Override this method if you need to interpret the center of mass differently.
Protected methodDistributeNeckAngularLimits
Distributes the neck angular limits. Override this method if you want an uneven distribution.
Protected methodDistributeSpineAngularLimits
Distributes the spine angular limits. Override this method if you want an uneven distribution.
Protected methodEvenlyDistributeAngularLimits
Evenly distributes the supplied angular limits throughout the list of parts.
Public methodGetAngularDampingProfile
Gets the profile of damping the Joints should use at different normalized strength values when achieving their target angular position on all axes, if applicable, scaled by the inverse of the character's mass.
Public methodGetAngularPositionForceProfile
Gets the profile of force the Joints should use at different normalized strength values when achieving their target angular position on all axes, if applicable, scaled by the inverse of the character's mass.
Public methodGetAngularVelocityForceProfile
Gets the profile of force the Joints should use at different normalized strength values when achieving their target angular velocity on all axes, if applicable, scaled by the inverse of the character's mass.
Public methodGetArbitraryChains
Gets the arbitrary chain settings.
Public methodGetAxialDepthContour
Gets the axial depth contour, which describes the dorsoventral depth from tail to snout.
Public methodGetAxialDepthOffsetContour
Gets the axial depth offset contour, which describes the dorsoventral offset of the center of torso cross sections from tail to snout.
Public methodGetAxialWidthContour
Gets the axial width contour, which describes the lateral thickness from tail to snout.
Public methodGetCorrespondingArbitraryChains
Gets mapping of corresponding arbitrary chain identifiers.
Protected methodGetEstimatedSnoutPosition
For a non-humanoid animal, gets an estimate of the snout position in tetrapod space.
Public methodGetLinearDampingProfile
Gets the profile of damping the Joints should use at different normalized strength values when achieving their target linear position on all axes, if applicable, scaled by the inverse of the character's mass.
Public methodGetLinearPositionForceProfile
Gets the profile of force the Joints should use at different normalized strength values when achieving their target linear position on all axes, if applicable, scaled by the inverse of the character's mass.
Public methodGetLinearVelocityForceProfile
Gets the profile of force the Joints should use at different normalized strength values when achieving their target linear velocity on all axes, if applicable, scaled by the inverse of the character's mass.
Public methodGetPinningForceProfile
Gets the profile of the ratio of pinning-force-to-joint-angular-limits to apply at different normalized strength values to try to maintain target position.
Public methodMapArbitraryChains
Map two associated arbitrary chains (e.g., across the character's plane of symmetry).
Public methodPerformChangeOnAllSettings
Protected methodPostprocessArbitraryChainColliders
Postprocesses the arbitrary chain colliders.
Protected methodPostprocessHeadColliderAsHumanoid
Postprocesses the head collider for a humanoid tetrapod.
Protected methodPostprocessHeadColliderAsNonHumanoid
Postprocesses the head collider for a non-humanoid tetrapod.
Protected methodPostprocessJointAxesAsNonHumanoid
Postprocesses joint axes and axis reflection modes for the supplied tetrapod assuming it is a non-humanoid animal of some kind in a neutral pose.
Protected methodPostprocessManusCollider
Postprocesses the manus collider.
Protected methodPostprocessNeckColliders
Postprocesses the neck colliders.
Protected methodPostprocessPelvisColliderAsHumanoid
Postprocesses the pelvis collider for a humanoid tetrapod.
Protected methodPostprocessPelvisColliderAsNonHumanoid
Postprocesses the pelvis collider for a non-humanoid tetrapod.
Protected methodPostprocessPesCollider
Postprocesses the pes collider.
Protected methodPostprocessShoulderCollider
Postprocesses the shoulder collider.
Protected methodPostprocessSpineColliders
Postprocesses the spine colliders.
Protected methodPostprocessTailColliders
Postprocesses the colliders on the arbitrary chain identified with TailIdentifier.
Protected methodScaleLimb
Scales the collider size on the specified limb if it is not ; otherwise, scale is applied to the other limb.
Public methodSetAngularDampingProfile
Sets the shape of the angular damping profile for all RagdollParts in the character. Their values will be the specified profile multiplied by the character's total mass.
Public methodSetAngularPositionForceProfile
Sets the shape of the angular position force profile for all RagdollParts in the character. Their values will be the specified profile multiplied by the character's total mass.
Public methodSetAngularVelocityForceProfile
Sets the shape of the angular velocity force profile for all RagdollParts in the character. Their values will be the specified profile multiplied by the character's total mass.
Public methodSetArbitraryChains
Sets the arbitrary chain settings.
Public methodSetAxialDepthContour
Sets the axial depth contour, which describes the dorsoventral depth from tail to snout.
Public methodSetAxialDepthOffsetContour
Sets the axial depth offset contour, which describes the dorsoventral offset of the center of torso cross sections from tail to snout.
Public methodSetAxialWidthContour
Sets the axial width contour, which describes the lateral thickness from tail to snout.
Protected methodSetJointAxesOnArbitraryChains
Sets the joint axes on arbitrary chains. Override this method if you need more nuanced interpretations of arbitrary chains.
Public methodSetLinearDampingProfile
Sets the shape of the linear damping profile for all RagdollParts in the character. Their values will be the specified profile multiplied by the character's total mass.
Public methodSetLinearPositionForceProfile
Sets the shape of the linear position force profile for all RagdollParts in the character. Their values will be the specified profile multiplied by the character's total mass.
Public methodSetLinearVelocityForceProfile
Sets the shape of the linear velocity force profile for all RagdollParts in the character. Their values will be the specified profile multiplied by the character's total mass.
Public methodSetPinningForceProfile
Sets the profile of the ratio of pinning-force-to-joint-angular-limits to apply at different normalized strength values to try to maintain target position.
Protected methodSmoothAxialChainColliders
Smooths the orientation, position, and size of colliders along the axial skeleton, according to the contour backing fields.
Protected methodTransformLocalUnitToWorldUnit
Transforms the local-space unit to a world-space unit.
Protected methodTransformWorldUnitToLocalUnit
Transforms the world-space unit to a local-space unit.
Protected methodTryAssignMass
Tries to assign mass to the specified part. If not possible, redistribute mass to all non-null bodies in the supplied list.
Protected methodTryDistributeMassAlongChain
Tries to distribute the supplied mass to all bodies in the supplied list.
Protected methodTryDistributeNeckMass
Tries to distribute the neck mass. Override this method if you need to interpret the center of mass differently.
Protected methodTryDistributeSpineMass
Tries to distribute the spine mass. Override this method if you need to interpret the center of mass differently.
Protected methodTrySetJointAxesFromTetrapodLocalVectors
Sets the joint axes for the supplied part using the supplied axis in the tetrapod's local space.
Top
Extension Methods
  NameDescription
Public Extension MethodGetPrefabName
Gets the name of the prefab associated with the supplied instance.
(Defined by ObjectX.)
Public Extension MethodOpenReferencePage
Opens a reference web page generated for the specified object.
(Defined by ObjectX.)
Top
See Also