adjust-to-gradient ("atg")

See this command in the command table.

To access this command:

  • Digitize ribbon > Condition > Condition > Adjust to Gradient.

  • Using the command line, enter "adjust-to-gradient" and press ENTER.

  • Use the quick key combination "atg".

  • Display the Find Command screen, locate adjust-to-gradient and click Run.

Command Overview

Adjusts a string to fit a gradient. This command modifies the elevations of points on a selected string.  Segments after the selected point based on string direction (that is, the increasing PTN values) will match a specified gradient.

Command Steps:

  1. Run the command. If there is no current string, you are prompted to select one.

  2. Select a reference point on the selected string.

  3. Select the type of gradient. By default, this is the one set using the set-gradient-convention ("grc") command.

  4. Enter the gradient value.

  5. Click OK.

    The string is vertically adjusted so the selected point is on the correct elevation, with all other elevations adjusted to the new gradient.

Command Automation

You can automate by passing this command and parameters into oDmApp.ParseCommand(), using any COM-aware scripting language.

Note: For more information on scripting in Studio NPVS+, please refer to your Scripting Tutorial (Help > Scripting Tutorial).

Example Parameter String (JS):

oDmApp.ParseCommand("adjust-to-gradient @point=-27.533174,10.168432,0.0,1 '-10.0'";

Where:

  • @point=-27.533174,10.168432,0.0,1 represents comma-delimited pick argument X, Y, Z coordinate values. The fourth parameter in this group (1) is an integer parsed as part of the point argument. (Parameter is not actually used so can be left as the example and ignored).

  • '-10.0' is the strGrad: string argument parsed to numeric gradient (degrees). Valid range is greater than -90 and less than 90.

Parameters Table

Parameter Description Reqd? Example Syntax
@point=x,y,z,button

Comma-delimited pick argument group.

  • x, y, z: numeric values (double).

  • button: integer parsed as part of the point argument. (Parameter is not actually used so can be left as the example and ignored).

Y @point=-27.533174,10.168432,0.0,1
strGrad String argument parsed to numeric gradient (degrees), valid range is greater than -90 and less than 90. Y '-10.0'

Related topics and activities