QuadrupedCharacterizationTemplate Class

A class for storing reusable Collider, Joint, and Rigidbody settings for TetrapodRagdoll characters.

Inheritance Hierarchy

SystemObject
  Object
    ScriptableObject
      Candlelight.PhysicsTetrapodCharacterizationTemplate
        Candlelight.PhysicsQuadrupedCharacterizationTemplate

Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0

Syntax

Copy

public class QuadrupedCharacterizationTemplate : TetrapodCharacterizationTemplate

The QuadrupedCharacterizationTemplate type exposes the following members.

Methods

	Name	Description
	ApplyAdvancedDefaultSettings	Configures all of the fields on this instance for a default equine quadruped 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. (Overrides TetrapodCharacterizationTemplateApplyAdvancedDefaultSettings.)
	ApplyBasicDefaultSettings	Configures all of the fields on this instance for a default equine quadruped 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. (Overrides TetrapodCharacterizationTemplateApplyBasicDefaultSettings.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	ApplyDefaultShapeSizesAndCenters	Apply shape sizes and centers to all parts assuming they are long limbs. (Inherited from TetrapodCharacterizationTemplate.)
	ApplyJointAxes	Applies the joint axes and axis reflection modes to the supplied quadruped. Override this method if your joint axes have different meanings from the defaults, or you do not assume the character is an equid. (Overrides TetrapodCharacterizationTemplateApplyJointAxes(TetrapodRagdoll).)
	ApplySettingsToArbitraryChains	Applies arbitrary chain settings to the corresponding chain in the tetrapod, if it exists. (Inherited from TetrapodCharacterizationTemplate.)
	ApplyShapeSizesAndCenters	Applies the shape sizes and centers to the supplied tetrapod. Override this method if you are working with non-equid quadrupeds. (Overrides TetrapodCharacterizationTemplateApplyShapeSizesAndCenters(TetrapodRagdoll).)
	ApplyShapeSizesAndCentersAsHumanoid	Applies the shape sizes and centers to the supplied tetrapod, assuming it is humanoid. (Inherited from TetrapodCharacterizationTemplate.)
	ApplyShapeSizesAndCentersAsNonHumanoid	Applies the shape sizes and centers to the supplied tetrapod, assuming it is non-humanoid. (Inherited from TetrapodCharacterizationTemplate.)
	ApplyShapeTypeToChain	Applies the shape type specified in the settings to the bodies in the chain. (Inherited from TetrapodCharacterizationTemplate.)
	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). (Inherited from TetrapodCharacterizationTemplate.)
	DistributeArbitraryChainAngularLimits	Distributes the arbitrary chain angular limits. Override this method if you want an uneven distribution. (Inherited from TetrapodCharacterizationTemplate.)
	DistributeArbitraryChainMass	Distributes the arbitrary chain mass. Override this method if you need to interpret the center of mass differently. (Inherited from TetrapodCharacterizationTemplate.)
	DistributeNeckAngularLimits	Distributes the neck angular limits. Override this method if you want an uneven distribution. (Inherited from TetrapodCharacterizationTemplate.)
	DistributeSpineAngularLimits	Distributes the spine angular limits. Override this method if you want an uneven distribution. (Inherited from TetrapodCharacterizationTemplate.)
	EvenlyDistributeAngularLimits	Evenly distributes the supplied angular limits throughout the list of parts. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	GetArbitraryChains	Gets the arbitrary chain settings. (Inherited from TetrapodCharacterizationTemplate.)
	GetAxialDepthContour	Gets the axial depth contour, which describes the dorsoventral depth from tail to snout. (Inherited from TetrapodCharacterizationTemplate.)
	GetAxialDepthOffsetContour	Gets the axial depth offset contour, which describes the dorsoventral offset of the center of torso cross sections from tail to snout. (Inherited from TetrapodCharacterizationTemplate.)
	GetAxialWidthContour	Gets the axial width contour, which describes the lateral thickness from tail to snout. (Inherited from TetrapodCharacterizationTemplate.)
	GetCorrespondingArbitraryChains	Gets mapping of corresponding arbitrary chain identifiers. (Inherited from TetrapodCharacterizationTemplate.)
	GetEstimatedSnoutPosition	For a non-humanoid animal, gets an estimate of the snout position in tetrapod space. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	MapArbitraryChains	Map two associated arbitrary chains (e.g., across the character's plane of symmetry). (Inherited from TetrapodCharacterizationTemplate.)
	PerformChangeOnAllSettings	Performs the specified change on all TetrapodCharacterizationTemplateBodyPartSettings fields. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessArbitraryChainColliders	Postprocesses the arbitrary chain colliders. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessHeadColliderAsHumanoid	Postprocesses the head collider for a humanoid tetrapod. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessHeadColliderAsNonHumanoid	Postprocesses the head collider for a non-humanoid tetrapod. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessManusCollider	Postprocesses the manus collider. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessNeckColliders	Postprocesses the neck colliders. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessPelvisColliderAsHumanoid	Postprocesses the pelvis collider for a humanoid tetrapod. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessPelvisColliderAsNonHumanoid	Postprocesses the pelvis collider for a non-humanoid tetrapod. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessPesCollider	Postprocesses the pes collider. (Overrides TetrapodCharacterizationTemplatePostprocessPesCollider(TetrapodRagdoll, RagdollPart, Bounds).)
	PostprocessShoulderCollider	Postprocesses the shoulder collider. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessSpineColliders	Postprocesses the spine colliders. (Inherited from TetrapodCharacterizationTemplate.)
	PostprocessTailColliders	Postprocesses the colliders on the arbitrary chain identified with TailIdentifier. (Inherited from TetrapodCharacterizationTemplate.)
	ScaleLimb	Scales the collider size on the specified limb if it is not ; otherwise, scale is applied to the other limb. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	SetArbitraryChains	Sets the arbitrary chain settings. (Inherited from TetrapodCharacterizationTemplate.)
	SetAxialDepthContour	Sets the axial depth contour, which describes the dorsoventral depth from tail to snout. (Inherited from TetrapodCharacterizationTemplate.)
	SetAxialDepthOffsetContour	Sets the axial depth offset contour, which describes the dorsoventral offset of the center of torso cross sections from tail to snout. (Inherited from TetrapodCharacterizationTemplate.)
	SetAxialWidthContour	Sets the axial width contour, which describes the lateral thickness from tail to snout. (Inherited from TetrapodCharacterizationTemplate.)
	SetJointAxesOnArbitraryChains	Sets the joint axes on arbitrary chains. Override this method if you need more nuanced interpretations of arbitrary chains. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	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. (Inherited from TetrapodCharacterizationTemplate.)
	SmoothAxialChainColliders	Smooths the orientation, position, and size of colliders along the axial skeleton, according to the contour backing fields. (Inherited from TetrapodCharacterizationTemplate.)
	TransformLocalUnitToWorldUnit	Transforms the local-space unit to a world-space unit. (Inherited from TetrapodCharacterizationTemplate.)
	TransformWorldUnitToLocalUnit	Transforms the world-space unit to a local-space unit. (Inherited from TetrapodCharacterizationTemplate.)
	TryAssignMass	Tries to assign mass to the specified part. If not possible, redistribute mass to all non-null bodies in the supplied list. (Inherited from TetrapodCharacterizationTemplate.)
	TryDistributeMassAlongChain	Tries to distribute the supplied mass to all bodies in the supplied list. (Inherited from TetrapodCharacterizationTemplate.)
	TryDistributeNeckMass	Tries to distribute the neck mass. Override this method if you need to interpret the center of mass differently. (Inherited from TetrapodCharacterizationTemplate.)
	TryDistributeSpineMass	Tries to distribute the spine mass. Override this method if you need to interpret the center of mass differently. (Inherited from TetrapodCharacterizationTemplate.)
	TrySetJointAxesFromTetrapodLocalVectors	Sets the joint axes for the supplied part using the supplied axis in the tetrapod's local space. (Inherited from TetrapodCharacterizationTemplate.)

Top

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.)

Top

Properties

	Name	Description
	AxialSkeletonShape	Gets or sets the more for configuring the axial skeleton shape. (Inherited from TetrapodCharacterizationTemplate.)
	Head	Gets or sets the settings for the head. (Inherited from TetrapodCharacterizationTemplate.)
	LeftDistalForelimb	Gets or sets the settings for the left distal forelimb. (Inherited from TetrapodCharacterizationTemplate.)
	LeftDistalHindlimb	Gets or sets the settings for the left distal hindlimb. (Inherited from TetrapodCharacterizationTemplate.)
	LeftManualPhalanx	Gets or sets the settings for the left manual phalanx. (Inherited from TetrapodCharacterizationTemplate.)
	LeftManus	Gets or sets the settings for the left manus. (Inherited from TetrapodCharacterizationTemplate.)
	LeftPedalPhalanx	Gets or sets the settings for the left pedal phalanx. (Inherited from TetrapodCharacterizationTemplate.)
	LeftPes	Gets or sets the settings for the left pes. (Inherited from TetrapodCharacterizationTemplate.)
	LeftProximalForelimb	Gets or sets the settings for the left proximal forelimb. (Inherited from TetrapodCharacterizationTemplate.)
	LeftProximalHindlimb	Gets or sets the settings for the left proximal hindlimb. (Inherited from TetrapodCharacterizationTemplate.)
	LeftShoulder	Gets or sets the settings for the left shoulder. (Inherited from TetrapodCharacterizationTemplate.)
	Neck	Gets or sets the settings for the neck. (Inherited from TetrapodCharacterizationTemplate.)
	Pelvis	Gets or sets the settings for the pelvis. (Inherited from TetrapodCharacterizationTemplate.)
	RightDistalForelimb	Gets or sets the settings for the right distal forelimb. (Inherited from TetrapodCharacterizationTemplate.)
	RightDistalHindlimb	Gets or sets the settings for the right distal hindlimb. (Inherited from TetrapodCharacterizationTemplate.)
	RightManualPhalanx	Gets or sets the settings for the right manual phalanx. (Inherited from TetrapodCharacterizationTemplate.)
	RightManus	Gets or sets the settings for the right manus. (Inherited from TetrapodCharacterizationTemplate.)
	RightPedalPhalanx	Gets or sets the settings for the right pedal phalanx. (Inherited from TetrapodCharacterizationTemplate.)
	RightPes	Gets or sets the settings for the right pes. (Inherited from TetrapodCharacterizationTemplate.)
	RightProximalForelimb	Gets or sets the settings for the right proximal forelimb. (Inherited from TetrapodCharacterizationTemplate.)
	RightProximalHindlimb	Gets or sets the settings for the right proximal hindlimb. (Inherited from TetrapodCharacterizationTemplate.)
	RightShoulder	Gets or sets the settings for the right shoulder. (Inherited from TetrapodCharacterizationTemplate.)
	Spine	Gets or sets the settings for the spine. (Inherited from TetrapodCharacterizationTemplate.)
	TotalMassDistribution	Gets the total mass distribution. (Inherited from TetrapodCharacterizationTemplate.)

Top

Remarks

By default, the ApplyTo(TetrapodRagdoll) method assumes that the character is an equid in a neutral 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.

Reference

Candlelight.Physics Namespace