Copyright © 2021 by K4.org
  (v.0.48.124)

Creates a button which when pressed will open a 2D sketching environment.

Index

Rules

addIntersectionVertices

addIntersectionVertices: Boolean

If true vertices will be inserted where edges cross each other.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

controlType

controlType: String

Internal Use Only

Flags : Cached (Note this is uncached)

Expression : "Sketcher"

displayFormat

displayFormat: String

One of 'engineering' (1.234) or 'architectural' (12'-9").

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "engineering"

displayPrecision

displayPrecision: Integer

An integer designating the number of decimal places (for engineering format) or nearest fraction (for architectural format) to display. For fractions, it is the power of 1/2, so 2 will display to the nearest 1/4. This does not affect the stored value, only its presentation.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : 2

displayScale

displayScale: Number

A scale factor to be applied to the value before it is displayed. For architectural formatting this should be a scale that converts the system unit to inches. Form example, if the system units are meters, the scale should be 39.37.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : 1

freeAnglesForFirstSegment

freeAnglesForFirstSegment: Boolean

If true, the first polyline segment (starting from an unconnected node) will not follow the snap angle restrictions.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

gridSize

gridSize: Number

A value in world units that defines a 'virtual grid' which all point selections are coerced to. This only affects picks which are otherwise not constrained (such as by a snap angle).

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : 1

guideLineColor

guideLineColor: String

The color of guide lines.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "0xff0000"

hideAngleInput

hideAngleInput: Boolean

If true the angle input control will be hidden in the UI.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

initialViewBox

initialViewBox: Any

Sets the bounding box min and max points to fit the camera view when the sketcher starts. If useGeometry is true, then the model geometry, if it exists, bounding box is used instead of the provided points. If useGeometry is not present or false, the geometry will be ignored and only the points will be used. Default is null, it means that the view will be fitted to the geometry if exists.

example:
{ min: p(-1, -1, -1), max: p(1, 1, 1), useGeometry: true }

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : null

lineColor

lineColor: String

The color of sketch lines.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "blue"

lineWidth

lineWidth: Number

The width of sketch lines in pixels.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : 5

newLineColor

newLineColor: String

The color of new lines.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "0x6666ff"

restrictToSnapAnglesOnly

restrictToSnapAnglesOnly: Boolean

If true then angles are restricted to snapAngles angles.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

selectedLineColor

selectedLineColor: String

The color of selected lines.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "0xaaaaff"

sketchDataOwner

sketchDataOwner: String

A refChain to the model which owns the rule named sketchDataRuleName.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : this.sketchDataParent

sketchDataParent

sketchDataParent: Any

This parameter is obsolete, use sketchDataOwner instead..

Flags : Cached, Parameter (Note this is uncached)

Expression : ""

sketchDataRuleName

sketchDataRuleName: String

The name of the rule on sketchDataOwner that contains the sketch definition.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : this.sketchDataTarget

sketchDataTarget

sketchDataTarget: String

This parameter is obsolete, use sketchDataRuleName instead.

Flags : Cached, Parameter (Note this is uncached)

Expression : ""

snapAngleIsRelative

snapAngleIsRelative: Boolean

If true then angles for magnet-like snap preference are counted relative to the previous polyline segment. Otherwise the angles are counted relative to sketch's X axis.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

snapAngles

snapAngles: Array

The angles in degrees which have some magnet-like snap preference. Applies to all quadrants.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : [0, 30, 45, 60]

snapAnglesRelative

snapAnglesRelative: Array

The angles in degrees which have some magnet-like snap preference for case when the angle is counted relative to the previous polyline segment. The angles must be in the 1st and 2nd quadrants and will be duplicated with negative values. Example: [30,90] means snapping to angles -90, -30, 30, 90.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : [0, 30, 45, 60, 90, 120, 135, 150, 180]

snapTolerance

snapTolerance: Number

The snapping tolerance is the distance in pixels within which the node snaps to the guideline.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : this.lineWidth * 2