Click or drag to resize
HipConstraint Class
A Constraint that replicates the behavior of the am_hipConstraint node in Maya.
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Candlelight.MayaDGNode
            Candlelight.MayaHipConstraint

Namespace: Candlelight.Maya
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0
Syntax
C#
public sealed class HipConstraint : DGNode

The HipConstraint type exposes the following members.

Methods
  NameDescription
Public methodCompute
Compute the result of the constraint.
(Overrides DGNodeCompute.)
Public methodGetTwistJoint
Gets the twist joint with the specified index.
Public methodGetTwistJoints
Gets the twist joints.
Public methodSetTwistJoints
Sets the twist joints.
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 propertyConstrainedObject
Gets the constrained object.
Public propertyElevationAngle
Gets the elevation angle of the hip.
Public propertyElevationDot
Gets the elevation dot-product of the hip.
Public propertyHipAimAxis
Gets or sets the axis on HipObject that points toward the knee joint.
Public propertyHipFrontAxis
Gets or sets the axis on HipObject that points to the front of the character in its neutral pose.
Public propertyHipObject
Gets or sets the hip object in the control rig.
Public propertyNodeName
Gets the name of the node in the Maya Dependency Graph to which this instance corresponds.
(Inherited from DGNode.)
Public propertyPelvisAimAxis
Gets or sets the axis on PelvisObject that points to the top of the character in its neutral pose.
Public propertyPelvisFrontAxis
Gets or sets the axis on PelvisObject that points to the front of the character in its neutral pose.
Public propertyPelvisObject
Gets or sets the pelvis object in the control rig in whose coordinate frame the hip's elevation angle is computed.
Public propertyTwistJointCount
Gets the number of additional twist joints in the hip.
Top
Remarks

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

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

See Also