schHiCreateWire

schHiCreateWire(
[ ?width n_width ]
[ ?drawMode g_drawMode ]
[ ?routeMethod t_routeMethod ]
[ ?lockAngle t_lockAngle ]
[ ?nonModal g_nonModal ]
[ ?color t_color ]
[ ?lineStyle t_lineStyle ]
)
=> t

Description

Creates different style wires that represent net connections in a schematic. Usable only when editing schematics.

You can manually draw a wire or let the schematic editor route the wire automatically, depending on g_drawMode. g_drawMode allows you to draw wires of different shapes. t_routeMethod prompts you to enter two end points for the wire that the schematic editor then routes.

The schematic editor draws a rubberband line until you click the next segment. The current setting for g_drawMode determines the rubberband line shape. You can change the value by displaying the options form.

To complete the line manually, click a schematic pin, a pin of a component, another wire, or double-click the wire end point. The schematic editor continually prompts you to click another wire until you want to select another function.

When you complete the wire, the schematic editor automatically generates pins if the edge of the wire connects to the edge of a block. You can specify the pin attributes by setting the blockDirRule field of the Editor Options form and by specifying the pinSeed property on the block.

Arguments

?width n_width	Wire width in user units.
?drawMode g_drawMode	Method of wire entry; must be enclosed in quotation marks. When g_drawMode is set to anyAngle, the line can be locked to 45 degrees with t_lockAngle. Valid Values: route, anyAngle, l90X, l90Y, l45Long, l45Angle
?routeMethod t_routeMethod
	Method to use when routing the wires; must be enclosed in quotation marks. Valid only when g_drawMode is route. A t_routeMethod of flight leaves flight lines in the schematic, of full executes an algorithm that creates orthogonal line segments, and of direct creates a straight solid line between the two points. In some cases, the full routing method is not able to complete the connection path. In these cases, a flight line is left in the schematic to indicate the intended connectivity. Valid Values: flight, full, direct
?lockAngle t_lockAngle	Specifies whether the drawing lines are locked to 45 degrees; must be enclosed in quotation marks. Valid only when g_drawMode is anyAngle. Valid Values: any, 45
?nonModal g_nonModal	Specifies whether the command should be modal. Valid Values: t, nil Default: nil
?color t_color	Specifies the color; must be enclosed in quotation marks. The color must be defined in the Display Resource File. If t_routeMethod is flight, t_color is ignored.
?lineStyle t_lineStyle	Specifies the line style; must be enclosed in quotation marks. The line style must be defined in the Display Resource File. If t_routeMethod is flight, t_lineStyle is ignored.

Value Returned

Always returns t.

Examples

Starts creating a 0.0625-unit wide line in the schematic. The rubberband line shape is set to L90 and starts in the X direction.

schHiCreateWire( 0.0625 "l90X" )

Prompts you to enter two points for the wire, which the schematic editor then routes using the most complete routing algorithm. Draws a rubberband line from your first selected point until you select a second point. The schematic editor routes the wire automatically using the full route method.

schHiCreateWire ( 0.0 "route" "full" )

Return to top