Click or drag to resize
ArbitraryRagdollAnimator Class
A component for driving a ArbitraryRagdoll with an animated hierarchy.
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Candlelight.PhysicsRagdollAnimator
            Candlelight.PhysicsArbitraryRagdollAnimator
              Candlelight.PhysicsTetrapodRagdollAnimator

Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0
Syntax
C#
public class ArbitraryRagdollAnimator : RagdollAnimator, 
	IArbitraryChains<Transform, TransformChain>, IRagdollBinder<ArbitraryRagdoll>

The ArbitraryRagdollAnimator type exposes the following members.

Methods
  NameDescription
Protected methodBindRagdoll
Binds the ragdoll to this RagdollAnimator. Its hierarchy will be flattened when it is bound.
(Inherited from RagdollAnimator.)
Public methodDefinesArbitraryChain
Gets a value indicating whether or not this instance defines an arbitrary TransformChain with the specified identifier.
Protected methodFixedUpdate
Synchronize the ragdoll and animated hierarchies as needed.
(Inherited from RagdollAnimator.)
Public methodGetAllNodes
Gets all nodes.
(Overrides RagdollAnimatorGetAllNodes(ListTransform).)
Public methodGetAnimatedBody
For the specified RagdollPart, get the corresponding Transform in the rendered hierarchy.
(Inherited from RagdollAnimator.)
Protected methodGetArbitraryChains
Gets the arbitrary chains.
Public methodGetArbitraryChains(DictionaryString, TransformChain)
Gets the arbitrary TransformChains.
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.
(Inherited from RagdollAnimator.)
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.
(Inherited from RagdollAnimator.)
Public methodGetOrientationParameters
Gets the orientation parameters.
(Inherited from RagdollAnimator.)
Public methodGetRagdollPart
For the specified Transform, get the corresponding RagdollPart in the physical hierarchy.
(Inherited from RagdollAnimator.)
Protected methodIgnoreColliderForGrounding
Ignores the specified collider when performing the grounding raycast or when testing if grounding bodies are grounded.
(Inherited from RagdollAnimator.)
Public methodIgnoreCollisionsBetweenAnimatorAndRagdoll
Ignores the collisions between the animated and ragdoll hierarchies based on the specified value.
(Inherited from RagdollAnimator.)
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.
(Inherited from RagdollAnimator.)
Protected methodLateUpdate
Perform final actions for the frame.
(Inherited from RagdollAnimator.)
Protected methodMapHierarchies
Map the animator and ragdoll hierarchies to each other.
(Overrides RagdollAnimatorMapHierarchies(DictionaryTransform, RagdollPart, DictionaryRagdollPart, Transform).)
Protected methodOnDestroy
Raises the destroy event.
(Inherited from RagdollAnimator.)
Protected methodOnDisable
Raises the disable event.
(Inherited from RagdollAnimator.)
Protected methodOnEnable
Raises the enable event.
(Inherited from RagdollAnimator.)
Protected methodPrepareHierarchies
Prepares the hierarchy mappings and regenerates the list of colliders to ignore.
(Inherited from RagdollAnimator.)
Protected methodSetArbitraryChains
Sets the arbitrary chains.
Public methodSetBodyShouldAnimateWhenDisconnected
Indicate that the specified animated body should continue to animate when one of its ancestors disconnects.
(Inherited from RagdollAnimator.)
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.
(Inherited from RagdollAnimator.)
Public methodSetOrientationParameters
Sets the orientation parameters.
(Inherited from RagdollAnimator.)
Protected methodStart
Start this instance.
(Inherited from RagdollAnimator.)
Public methodUnbindRagdoll
Unbinds the ragdoll currently bound to this instance, returning its hierarchy to the state it was in when bound.
(Inherited from RagdollAnimator.)
Protected methodUnignoreColliderForGrounding
Unignores the specified collider when performing the grounding raycast or when testing if grounding bodies are grounded.
(Inherited from RagdollAnimator.)
Protected methodUpdate
Emit error messages if avatar or controller change at run-time and preprocess animator if necessary.
(Inherited from RagdollAnimator.)
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.
(Inherited from RagdollAnimator.)
Public propertyFullHierarchyBlendProgress
Gets the normalized progress of this instance blending out of full-hierarchy ragdoll.
(Inherited from RagdollAnimator.)
Public propertyFullHierarchyBlendTime
Gets or sets the number of seconds to take when blending from full-hierarchy ragdoll back to animation data.
(Inherited from RagdollAnimator.)
Public propertyFullHierarchyRagdollParameter
Gets or sets a AnimatorControllerParameterType.Bool parameter specifying that the full hierarchy is ragdoll.
(Inherited from RagdollAnimator.)
Public propertyGroundSurfaces
Gets or sets the ground surfaces. This value is used to reposition the animated hierarchy when the it exits full-hierarchy ragdoll.
(Inherited from RagdollAnimator.)
Public propertyOnEnterFullHierarchyRagdoll
Gets the event when full hierarchy ragdoll was entered (i.e. all parts just now have a strength of 0).
(Inherited from RagdollAnimator.)
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).
(Inherited from RagdollAnimator.)
Public propertyOnPostprocessAnimatedHierarchy
Gets the event right before the animated hierarchy is finalized for rendering.
(Inherited from RagdollAnimator.)
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).
(Inherited from RagdollAnimator.)
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.
(Inherited from RagdollAnimator.)
Public propertyOrientationParameterUpdateMode
Gets or sets the orientation parameter update mode.
(Inherited from RagdollAnimator.)
Public propertyRagdoll
Gets the ragdoll being animated by this instance.
(Inherited from RagdollAnimator.)
Public propertyRoot
Gets the root.
(Inherited from RagdollAnimator.)
Public propertyStrengthUpdateMode
Gets or sets the strength update mode to use when applying Strength values to the ragdoll.
(Inherited from RagdollAnimator.)
Top
Events
  NameDescription
Public eventOnEnterRagdollState
Occurs when a RagdollPart enters a ragdoll state (i.e. its strength just now became 0).
(Inherited from RagdollAnimator.)
Public eventOnExitRagdollState
Occurs when a RagdollPart exits a ragdoll state (i.e. its strength was 0 and is now greater than 0).
(Inherited from RagdollAnimator.)
Top
Remarks
See RagdollAnimator for more notes and limitations.
See Also