ShoulderConstraint Class

A Constraint that replicates the behavior of the am_ShoulderConstraint node in Maya.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Candlelight.MayaDGNode
            Candlelight.MayaShoulderConstraint

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

Syntax

public sealed class ShoulderConstraint : DGNode

The ShoulderConstraint type exposes the following members.

Methods

	Name	Description
	Compute	Compute the result of the constraint. (Overrides DGNodeCompute.)
	GetTwistJoint	Gets the twist joint with the specified index.
	GetTwistJoints	Gets the twist joints.
	SetTwistJoints	Sets the twist joints.

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
	ConstrainedObject	Gets the constrained object.
	ElevationAngle	Gets the elevation angle of the shoulder.
	ElevationDot	Gets the elevation dot-product of the shoulder.
	NodeName	Gets the name of the node in the Maya Dependency Graph to which this instance corresponds. (Inherited from DGNode.)
	RaisedAngleOffset	Gets or sets a value indicating how far back ConstrainedObject's up-vector should rotate when the arm is at maximum elevation.
	ShoulderAimAxis	Gets or sets the axis on ShoulderObject that points toward the elbow joint.
	ShoulderFrontAxis	Gets or sets the axis on ShoulderObject that points to the front of the character in its neutral pose.
	ShoulderObject	Gets or sets the shoulder object in the control rig.
	SpineAimAxis	Gets or sets the axis on SpineObject that points to the top of the character in its neutral pose.
	SpineFrontAxis	Gets or sets the axis on SpineObject that points to the front of the character in its neutral pose.
	SpineObject	Gets or sets the spine object in the control rig in whose coordinate frame the shoulder's elevation angle is computed. This object is typically the ribcage.
	TwistJointCount	Gets the number of additional twist joints in the shoulder.

Remarks

Add this component to the most proximal helper joint in a shoulder rig in order to correct twist deformation.

ShoulderObject and ConstrainedObject should be coincident and should be siblings in the hierarchy. ShoulderObject should drive the animation and receive full twisting rotation. All OrientConstraints assigned using SetTwistJoints(IEnumerableOrientConstraint) should have both ConstrainedObject and ShoulderObject as targets.