Click or drag to resize
RagdollAnimator Class
A base class for driving some type of non-rendered Ragdoll hierarchy with data from a rendered, animated hierarchy.
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Candlelight.PhysicsRagdollAnimator
            Candlelight.PhysicsArbitraryRagdollAnimator

Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0
Syntax
C#
public abstract class RagdollAnimator : MonoBehaviour, 
	IHierarchy<Transform>

The RagdollAnimator type exposes the following members.

Methods
  NameDescription
Protected methodBindRagdoll
Binds the ragdoll to this RagdollAnimator. Its hierarchy will be flattened when it is bound.
Protected methodFixedUpdate
Synchronize the ragdoll and animated hierarchies as needed.
Public methodGetAllNodes
Gets all nodes.
Public methodGetAnimatedBody
For the specified RagdollPart, get the corresponding Transform in the rendered hierarchy.
Public methodGetEstimatedLocalBounds
Gets the estimated Bounds of this RagdollAnimator in its current configuration, in the space of its Transform component. It will encapsulate all of the Transforms of the hierarchy's nodes, as well as all of the currently active SkinnedMeshRenderers and MeshRenderers.
Public methodGetGroundingBodies
Gets a set of animated bodies and associated minimum strength values. By default, if any one of these parts falls below its minimum strength while contacting a ground layer then the full hierarchy will enter a ragdoll state.
Public methodGetOrientationParameters
Gets the orientation parameters.
Public methodGetRagdollPart
For the specified Transform, get the corresponding RagdollPart in the physical hierarchy.
Protected methodIgnoreColliderForGrounding
Ignores the specified collider when performing the grounding raycast or when testing if grounding bodies are grounded.
Public methodIgnoreCollisionsBetweenAnimatorAndRagdoll
Ignores the collisions between the animated and ragdoll hierarchies based on the specified value.
Public methodIsPartDisconnected
Determines whether the specified animated body has been disconnected, either because its joint broken or because a joint on one of its parents broke off.
Protected methodLateUpdate
Perform final actions for the frame.
Protected methodMapHierarchies
Map the animator and ragdoll hierarchies to each other.
Protected methodOnDestroy
Raises the destroy event.
Protected methodOnDisable
Raises the disable event.
Protected methodOnEnable
Raises the enable event.
Protected methodPrepareHierarchies
Prepares the hierarchy mappings and regenerates the list of colliders to ignore.
Public methodSetBodyShouldAnimateWhenDisconnected
Indicate that the specified animated body should continue to animate when one of its ancestors disconnects.
Public methodSetGroundingBodies
Sets a table of animated bodies and associated minimum strength values. By default, if any one of these parts falls below its minimum strength while contacting a ground layer then the full hierarchy will enter a ragdoll state.
Public methodSetOrientationParameters
Sets the orientation parameters.
Protected methodStart
Start this instance.
Public methodUnbindRagdoll
Unbinds the ragdoll currently bound to this instance, returning its hierarchy to the state it was in when bound.
Protected methodUnignoreColliderForGrounding
Unignores the specified collider when performing the grounding raycast or when testing if grounding bodies are grounded.
Protected methodUpdate
Emit error messages if avatar or controller change at run-time and preprocess animator if necessary.
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
Properties
  NameDescription
Public propertyAnimator
Gets the animator.
Public propertyFullHierarchyBlendProgress
Gets the normalized progress of this instance blending out of full-hierarchy ragdoll.
Public propertyFullHierarchyBlendTime
Gets or sets the number of seconds to take when blending from full-hierarchy ragdoll back to animation data.
Public propertyFullHierarchyRagdollParameter
Gets or sets a AnimatorControllerParameterType.Bool parameter specifying that the full hierarchy is ragdoll.
Public propertyGroundSurfaces
Gets or sets the ground surfaces. This value is used to reposition the animated hierarchy when the it exits full-hierarchy ragdoll.
Public propertyStatic memberIsSilent
Gets or sets a value indicating whether instances of this class should emit debug messages. This value should only be set to when performing automated tests.
Public propertyOnEnterFullHierarchyRagdoll
Gets the event when full hierarchy ragdoll was entered (i.e. all parts just now have a strength of 0).
Public propertyOnExitFullHierarchyRagdoll
Gets the event when full hierarchy ragdoll was exited (i.e. all parts had a strength of 0 and at least one is now greater than 0).
Public propertyOnPostprocessAnimatedHierarchy
Gets the event right before the animated hierarchy is finalized for rendering.
Public propertyOnPostprocessInputPose
Gets the event when the input pose has been set up, before it has been applied to the ragdoll. Subscribe to this event for applying procedural animation normally applied in LateUpdate() (e.g., custom IK solvers).
Public propertyOnPreprocessAnimatedHierarchy
Gets the event before the Animator has been updated. Subscribe to this event if you need to revert changes to non-animated transforms made in the previous frame. For example, if you are using Final IK, you would insert a call to FixTransforms() here if necessary.
Public propertyOrientationParameterUpdateMode
Gets or sets the orientation parameter update mode.
Public propertyRagdoll
Gets the ragdoll being animated by this instance.
Public propertyRoot
Gets the root.
Public propertyStrengthUpdateMode
Gets or sets the strength update mode to use when applying Strength values to the ragdoll.
Public propertyStatic memberZeroVelocityThreshold
Gets the Vector3.sqrMagnitude value below which a part's velocity is considered to be 0.
Top
Events
  NameDescription
Public eventOnEnterRagdollState
Occurs when a RagdollPart enters a ragdoll state (i.e. its strength just now became 0).
Public eventOnExitRagdollState
Occurs when a RagdollPart exits a ragdoll state (i.e. its strength was 0 and is now greater than 0).
Top
Remarks
This component cannot be added at run-time, as it needs to cache AvatarMask data only available via editor APIs.
See Also