## GetProportionalGuide

### Introduced

v4.0

### Description

Creates a biped proportioning guide from which you can create a rig. This is part of the Character Development Kit.

### Scripting Syntax

    oReturn = GetProportionalGuide( ModelName, [GuideStyle], [GuideSymmetry] );

### Return Value

Nothing

### Parameters

Parameter | Type | Description
--- | --- | ---
ModelName | String | Type of proportioning guide to create based on one of the valid Model Presets listed below. Default Value: BipedPropGuide
Possible Values: | Description:
BipedPropGuide | Basic biped proportioning guide
Biped_Guide | Biped proportioning guide with ears and stomach
Biped_DogLeg_Guide | Biped proportioning guide with dogleg
Quadruped_Guide | Quadruped proportioning guide
GuideStyle | Long | Specify whether to hide volume controls (when visible, these appear as yellow splines with small manipulator cubes) which can be used to help define and visualize the body's volume.
Possible Values: | Description:
0 | Skeleton Structure and Volume
1 | Volume Controls Hidden
GuideSymmetry | Long | Specify if and how to manipulate the corresponding control cube on the opposite side of the body in the same way that the selected cube is manipulated. This makes it quick and easy to set up matching proportions for both sides of the body at once.
Possible Values: | Description:
0 | Full Symmetry
1 | Asymmetrical Upper Body
2 | Asymmetrical Lower Body
3 | No Symmetry

### Examples

#### JScript Example

    /*
            This example demonstrates how to get a Biped guide with
            asymmetrical lower body.
    */
    NewScene( null, false );
    GetProportionalGuide("Biped_Guide", 0, 2);

### See Also

GetPresetModel