Sketch Line <IvSketchLine>

Synopsis

IvSketchLine creates a Line in a drawing sketch.

Mixins

IvSketchLineModifier

LineMixin

BasePart

Most of the rules for IvSketchLine are provided by LineMixin. It provides many different options for specifying the position of the line. Typically, a line would be defined by 2 points: thruPoint1, and thruPoint2.

Parameters

Name Type Description
sketch any Identifies the sketch onto which the sketch line should be placed.
layer string Specifies the layer style to use for the sketch line. Defaults to empty string, and uses the "By Standard" style.
thruPoint1 any First point the line should go through. This is the start point , only if the curve parameter 'start' has not been provided.
thruPoint2 any Second point the line should go through. This is the end point , only if the curve parameter 'end' has not been provided.
alignment integer Alignment with one of the base axis. 1 stands for alignment with the X-Axis, 2 stands for the Y-Axis.
angle number Angle relative to the positive X-Axis. This input is used, to orient the line in the plane.
baseAxis part Object used as reference for angle:
dirVector vector Direction of the line from start to end point.
distance number Distance from the origin of the line defined with parameter 'offsetFrom'.
end number Parameter at the end of the line.
length number Length of the line.
offsetFrom part Line that defines the basis for an offset line with offset 'distance'.
onRight1 boolean This parameter defines the orientation of the line, in case it needs to be tangential to two arcs. An imaginary line between the centers of 'tanArc1' and 'tanArc2' is the basis. If 'onRight1' is TRUE , the center of the new arc is on the right side of the line; if 'onRight1' is FALSE the center of the new arc is on the left side of the line.
onRight2 boolean This parameter defines the orientation of the line, in case it needs to be tangential to two arcs. An imaginary line between the centers of 'tanArc1' and 'tanArc2' is the basis. If 'onRight2' is TRUE , the center of the new arc is on the right side of the line; if 'onRight2' is FALSE the center of the new arc is on the left side of the line.
parallelTo part Input line that the new line should be parallel to.
perpendicularTo part Input line that the new line should be perpendicular to.
start number Curve parameter at the start point of the line. Changing the default of ?0? changes the start point of the line.
tanArc1 part Input arc that the line should be tangent to. The parameter 'onRight1' must also be defined to specify an unambiguous orientation of the line.
tanArc2 part Input arc that the line should be tangent to. The parameter 'onRight2' must also be defined to specify an unambiguous orientation of the line.

Rules

Name Type Description
p0 point Start point of Line.
v0 vector Direction vector of Line.
u0 number Curve parameter at start point of Line. Default value is 0.0.
u1 number Curve parameter at end point of Line. Default value is the length of the line.
defaultEnd number Default Curve parameter at the end of the Line. Normally, this is the end of the line.
endPoint point Point at end of Line. This is calculated as: p0 + (u1 * v0).
polygonPoints list List with two points , the start and end point , calculated as:{startPoint, endPoint}.
startPoint point Point at start of Line. This is calculated as: p0 + (u0 * v0).
midPoint point Center point of Line.