 | TetrapodCharacterizationTemplate Class |
A class for storing reusable Collider, Joint, and
Rigidbody settings for TetrapodRagdoll characters.
Inheritance HierarchySystemObject
Object
ScriptableObject
Candlelight.PhysicsTetrapodCharacterizationTemplate
Candlelight.PhysicsQuadrupedCharacterizationTemplate
Candlelight.PhysicsTheropodCharacterizationTemplate
Object
ScriptableObject
Candlelight.PhysicsTetrapodCharacterizationTemplate
Candlelight.PhysicsQuadrupedCharacterizationTemplate
Candlelight.PhysicsTheropodCharacterizationTemplate
Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0
SyntaxC#
public class TetrapodCharacterizationTemplate : ScriptableObject
The TetrapodCharacterizationTemplate type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ApplyAdvancedDefaultSettings |
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.
|
| ApplyBasicDefaultSettings |
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.
|
 | ApplyCenterOfMassParameter |
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.
|
| ApplyCenterOfMassParametersToBasicParts |
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.
|
| ApplyDefaultShapeSizesAndCenters |
Apply shape sizes and centers to all parts assuming they are long limbs.
|
| ApplyJointAxes |
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.
|
| ApplySettingsToArbitraryChains |
Applies arbitrary chain settings to the corresponding chain in the tetrapod, if it exists.
|
| ApplyShapeSizesAndCenters |
Applies the shape sizes and centers to the supplied tetrapod. Override this method if you are working with
non-humanoid characters.
|
| ApplyShapeSizesAndCentersAsHumanoid |
Applies the shape sizes and centers to the supplied tetrapod, assuming it is humanoid.
|
| ApplyShapeSizesAndCentersAsNonHumanoid |
Applies the shape sizes and centers to the supplied tetrapod, assuming it is non-humanoid.
|
| ApplyShapeTypeToChain |
Applies the shape type specified in the settings to the bodies in the chain.
|
| ApplyTo |
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).
|
 | ClearAngularZLimit |
A TetrapodCharacterizationTemplateBodyPartSettingsMutator to clear a backing field's angular
z-limit.
|
| DistributeArbitraryChainAngularLimits |
Distributes the arbitrary chain angular limits. Override this method if you want an uneven distribution.
|
| DistributeArbitraryChainMass |
Distributes the arbitrary chain mass. Override this method if you need to interpret the center of mass
differently.
|
| DistributeNeckAngularLimits |
Distributes the neck angular limits. Override this method if you want an uneven distribution.
|
| DistributeSpineAngularLimits |
Distributes the spine angular limits. Override this method if you want an uneven distribution.
|
| EvenlyDistributeAngularLimits |
Evenly distributes the supplied angular limits throughout the list of parts.
|
| GetAngularDampingProfile |
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.
|
| GetAngularPositionForceProfile |
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.
|
| GetAngularVelocityForceProfile |
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.
|
| GetArbitraryChains |
Gets the arbitrary chain settings.
|
| GetAxialDepthContour |
Gets the axial depth contour, which describes the dorsoventral depth from tail to snout.
|
| GetAxialDepthOffsetContour |
Gets the axial depth offset contour, which describes the dorsoventral offset of the center of torso cross
sections from tail to snout.
|
| GetAxialWidthContour |
Gets the axial width contour, which describes the lateral thickness from tail to snout.
|
| GetCorrespondingArbitraryChains |
Gets mapping of corresponding arbitrary chain identifiers.
|
| GetEstimatedSnoutPosition |
For a non-humanoid animal, gets an estimate of the snout position in tetrapod space.
|
| GetLinearDampingProfile |
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.
|
| GetLinearPositionForceProfile |
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.
|
| GetLinearVelocityForceProfile |
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.
|
| GetPinningForceProfile |
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.
|
| MapArbitraryChains |
Map two associated arbitrary chains (e.g., across the character's plane of symmetry).
|
| PerformChangeOnAllSettings |
Performs the specified change on all TetrapodCharacterizationTemplateBodyPartSettings fields.
|
| PostprocessArbitraryChainColliders |
Postprocesses the arbitrary chain colliders.
|
| PostprocessHeadColliderAsHumanoid |
Postprocesses the head collider for a humanoid tetrapod.
|
| PostprocessHeadColliderAsNonHumanoid |
Postprocesses the head collider for a non-humanoid tetrapod.
|
| PostprocessJointAxesAsNonHumanoid |
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.
|
| PostprocessManusCollider |
Postprocesses the manus collider.
|
| PostprocessNeckColliders |
Postprocesses the neck colliders.
|
| PostprocessPelvisColliderAsHumanoid |
Postprocesses the pelvis collider for a humanoid tetrapod.
|
| PostprocessPelvisColliderAsNonHumanoid |
Postprocesses the pelvis collider for a non-humanoid tetrapod.
|
| PostprocessPesCollider |
Postprocesses the pes collider.
|
| PostprocessShoulderCollider |
Postprocesses the shoulder collider.
|
| PostprocessSpineColliders |
Postprocesses the spine colliders.
|
| PostprocessTailColliders |
Postprocesses the colliders on the arbitrary chain identified with
TailIdentifier.
|
| ScaleLimb |
Scales the collider size on the specified limb if it is not ; otherwise, scale is
applied to the other limb.
|
| SetAngularDampingProfile |
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.
|
| SetAngularPositionForceProfile |
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.
|
| SetAngularVelocityForceProfile |
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.
|
| SetArbitraryChains |
Sets the arbitrary chain settings.
|
| SetAxialDepthContour |
Sets the axial depth contour, which describes the dorsoventral depth from tail to snout.
|
| SetAxialDepthOffsetContour |
Sets the axial depth offset contour, which describes the dorsoventral offset of the center of torso cross
sections from tail to snout.
|
| SetAxialWidthContour |
Sets the axial width contour, which describes the lateral thickness from tail to snout.
|
| SetJointAxesOnArbitraryChains |
Sets the joint axes on arbitrary chains. Override this method if you need more nuanced interpretations of
arbitrary chains.
|
| SetLinearDampingProfile |
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.
|
| SetLinearPositionForceProfile |
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.
|
| SetLinearVelocityForceProfile |
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.
|
| SetPinningForceProfile |
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.
|
| SmoothAxialChainColliders |
Smooths the orientation, position, and size of colliders along the axial skeleton, according to the
contour backing fields.
|
| TransformLocalUnitToWorldUnit |
Transforms the local-space unit to a world-space unit.
|
| TransformWorldUnitToLocalUnit |
Transforms the world-space unit to a local-space unit.
|
| TryAssignMass |
Tries to assign mass to the specified part. If not possible, redistribute mass to all non-null bodies in the
supplied list.
|
| TryDistributeMassAlongChain |
Tries to distribute the supplied mass to all bodies in the supplied list.
|
| TryDistributeNeckMass |
Tries to distribute the neck mass. Override this method if you need to interpret the center of mass
differently.
|
| TryDistributeSpineMass |
Tries to distribute the spine mass. Override this method if you need to interpret the center of mass
differently.
|
| TrySetJointAxesFromTetrapodLocalVectors |
Sets the joint axes for the supplied part using the supplied axis in the tetrapod's local space.
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetPrefabName |
Gets the name of the prefab associated with the supplied instance.
(Defined by ObjectX.) |
| OpenReferencePage |
Opens a reference web page generated for the specified object.
(Defined by ObjectX.) |
Properties| Name | Description | |
|---|---|---|
 | AxialSkeletonShape |
Gets or sets the more for configuring the axial skeleton shape.
|
| Head |
Gets or sets the settings for the head.
|
| LeftDistalForelimb |
Gets or sets the settings for the left distal forelimb.
|
| LeftDistalHindlimb |
Gets or sets the settings for the left distal hindlimb.
|
| LeftManualPhalanx |
Gets or sets the settings for the left manual phalanx.
|
| LeftManus |
Gets or sets the settings for the left manus.
|
| LeftPedalPhalanx |
Gets or sets the settings for the left pedal phalanx.
|
| LeftPes |
Gets or sets the settings for the left pes.
|
| LeftProximalForelimb |
Gets or sets the settings for the left proximal forelimb.
|
| LeftProximalHindlimb |
Gets or sets the settings for the left proximal hindlimb.
|
| LeftShoulder |
Gets or sets the settings for the left shoulder.
|
| Neck |
Gets or sets the settings for the neck.
|
| Pelvis |
Gets or sets the settings for the pelvis.
|
| RightDistalForelimb |
Gets or sets the settings for the right distal forelimb.
|
| RightDistalHindlimb |
Gets or sets the settings for the right distal hindlimb.
|
| RightManualPhalanx |
Gets or sets the settings for the right manual phalanx.
|
| RightManus |
Gets or sets the settings for the right manus.
|
| RightPedalPhalanx |
Gets or sets the settings for the right pedal phalanx.
|
| RightPes |
Gets or sets the settings for the right pes.
|
| RightProximalForelimb |
Gets or sets the settings for the right proximal forelimb.
|
| RightProximalHindlimb |
Gets or sets the settings for the right proximal hindlimb.
|
| RightShoulder |
Gets or sets the settings for the right shoulder.
|
| Spine |
Gets or sets the settings for the spine.
|
| TotalMassDistribution |
Gets the total mass distribution.
|
Remarks
By default, the ApplyTo(TetrapodRagdoll) method assumes that the
character is a humanoid in a T-Pose. If you need different behavior, or need to interpret any of the
TetrapodCharacterizationTemplateBodyPartSettings differently, then you can subclass this class
and override any methods as needed.
See Also