TYPE: SOP
TITLE: Capture Region SOP

Capture Region works in conjunction with the Capture operation and the
Deform operation by creating a volume to be used by Capture to weight points
which are moved in the Deform operation.

Typically one or more Capture Regions are placed in an object (usually
a bone) and named "capture_region".  The object is then read into a
Capture operation through the object's hierarchy.  The object is moved
to deform the Capture operation's geometry with a Deform operation.

The Capture Region volume is a tube with hemispheres at each end.  By
adjusting the shape of the capture region, you can effect how points
are weighted by the Capture operation.  The closer a point is 
to the edge of a region, the lighter the weight.  Thus you can 
increase point weighting by increasing the size of the region.

The parameters in the Region tab define the values used for deforming
the skin points while the values in the capture tab define the values 
used for capturing them. The shape of the capture region used
for capturing can be viewed with the kinematic override set to "capture".
Just select "Settings > Objects > Kinematic Override: capture" from the menu.

Rig Adjustment parameters define a transform that nullifies deformations
that may be caused by bone position tweaking during rigging process. This
happens after the geometry has been captured and bone joints need
to be adjusted to improve animation. After capturing, moving a bone is
going to deform the captured geometry. To reset this deformation
the capture region used for deforming (animating) needs to be aligned back 
with the capture region used for capturing. Rig Adjustment transformation
aligns the deform and the capture incarnations of the capture region. This
transformation is automatically calculated by Reset Bone Deformations
tool or when an hscript command "boneadjustrig" is invoked on bones.
The transform order of the rig adjustment is RTS and rotation order is ZYX.

Parameters:

Region
    Animate
	Orientation       - Defines the direction axis of the region.  Use
                        Z axis when the region is inside a bone object
	Center            - Position of the center of the region      /t[xyz]
	Rotate	      - Orientation of the region expressed
			as rotational angles in degrees around
			x, y, and z axis. The order of rotation
			follows that of a bone and is ZYX. Rotation
			is performed around the center of the region.	/t[xyz]
        Squash and Stretch - Scaling parameters in the x, y, z axis direction
			of a local reference frame. Effectively, the
			parameters Center, Rotate, and Squash and Stretch
			for a transformation matrix with the RTS transform
			order and ZYX rotation order.		    /squash[xyz]
	Top Height        - Height of the region from the center to   /theight
                        the top cap
        Top Cap           - X,Y,Z radii of the top hemisphere         /tcap[xyz]
	Bottom Height     - Height of the region from the center to   /bheight
                        the bottom cap
        Bottom Cap        - X,Y,Z radii of the bottom hemisphere    /bcap[xyz]
	Height Scale      - Scaling factor for both Top and Bottom Height
			parameters				    /hscale
    Rig Adjustment
	Rig Adjust Translate - translation			/rigadjustt[xyz]
	Rig Adjust Rotate   - rotation				/rigadjustr[xyz]
	Rig Adjust Scale    - scale				/rigadjusts[xyz]
	Rig Adjust Z Factor - coefficient that scales the animation z-factor
			      to equal the capture z-factor /rigadjustzfactor

Capture
    Orientation       - A capture counterpart of the Orientation parameter
			in Region tab				    /corient
    Center            - A capture counterpart of the Center parameter
			in Region tab				    /ct[xyz]
    Rotate	      - A capture counterpart of the Rotate parameter
			in Region tab				    /cr[xyz]
    Squash and Stretch - A capture counterpart of the Squash and stretch
			parameter in Region tab			/csquash[xyz]
    Top Height        - A capture counterpart of the Top Height parameter
			in Region tab				    /ctheight
    Top Cap           - A capture counterpart of the Top Cap parameter
			in Region tab				    /ctcap[xyz]
    Bottom Height     - A capture counterpart of the Bottom Height parameter
			in Region tab				    /cbheight
    Bottom Cap        - A capture counterpart of the Bottom Cap parameter 
			in Region tab				    /cbcap[xyz]
    Height Scale      - A capture counterpart of the Height Scale parameter
			in Region tab				    /chscale
    Inner/Outer Weight - Defines the weight of a point exactly on 
                        the center line and edge of the region
                        respectively.  Point weights in between will 
                        be blended.

Display
    Display Color     - The Capture operation uses region colors for /color[rgb]
                        helpful feedback.  By default the region
                        inherits the color of its containing object
                        (via an expression )

See also: Capture, Deform
