Container for exposure vectors. The polyline mode of a newly created hatching block is bsPolylineIterator.nPolyHatch.

bsHatchBlock.setAttributeReal(sId, fValue)

Sets the floating point value attribute with unique identifier sId to the value fValue. The value is set for all hatching blocks which contain the floating point value attribute. The floating point value attribute must be declared using declareBuildAttributes.

Arguments:

• sId : Unique identifier of floating point value attribute

• fValue : Floating point value

Number bsHatchBlock.getAttributeReal(sId)

Returns the value of the floating point value attribute with the unique identifier sId. The floating point value attribute must be declared using declareBuildAttributes. If the attribute is not available then the return value is 0.0.

Arguments:

• sId : Unique identifier of floating point value attribute

Return

Value of the attribute. If the attribute is not available then the return value is 0.0.

Number bsHatchBlock.getAttributeRealExt(sId)

Returns the value of the floating point value attribute with the unique identifier sId. The floating point value attribute must be declared using declareBuildAttributes. If the attribute is not available then the undefined value is returned.

Arguments:

• sId : Unique identifier of floating point value attribute

Return

Value of the attribute. If the attribute is not available then the undefined value is returned.

bsHatchBlock.setAttributeInt(sId, nValue)

Sets the integer value attribute with unique identifier sId to the value nValue. The value is set for all hatching blocks which contain the integer value attribute. The integer value attribute must be declared using declareBuildAttributes.

Arguments:

• sId : Unique identifier of integer value attribute

• nValue : Integer value

Integer bsHatchBlock.getAttributeInt(sId)

Returns the value of the integer value attribute with the unique identifier sId. The integer value attribute must be declared using declareBuildAttributes. If the attribute is not available then the return value is 0.

Arguments:

• sId : Unique identifier of integer value attribute

Return

Value of the attribute. If the attribute is not available then the return value is 0.

Integer bsHatchBlock.getAttributeIntExt(sId)

Returns the value of the integer value attribute with the unique identifier sId. The integer value attribute must be declared using declareBuildAttributes. If the attribute is not available then the undefined value is returned.

Arguments:

• sId : Unique identifier of integer value attribute

Return

Value of the attribute. If the attribute is not available then the undefined value is returned.

Integer bsHatchBlock.getPointAttributeInt(nPointIndex, sId)

Returns the value of the integer value attribute with the unique identifier sId of the point at index nPointIndex. The integer value attribute must be declared using declareBuildAttributes. If the attribute is not available then the return value is 0.

Arguments:

• nPointIndex : Index of point (first point at index 0)

• sId : Unique identifier of integer value attribute

Return

Value of the attribute. If the attribute is not available then the return value is 0.

Integer bsHatchBlock.getPointAttributeIntExt(nPointIndex, sId)

Returns the value of the integer value attribute with the unique identifier sId of the point at index nPointIndex. The integer value attribute must be declared using declareBuildAttributes. If the attribute is not available then the undefined value is returned.

Arguments:

• nPointIndex : Index of point (first point at index 0)

• sId : Unique identifier of integer value attribute

Return

Value of the attribute. If the attribute is not available then the undefined value is returned.

Number bsHatchBlock.getPointAttributeReal(nPointIndex, sId)

Returns the value of the floating point value attribute with the unique identifier sId of the point at index nPointIndex. The floating point value attribute must be declared using declareBuildAttributes. If the attribute is not available then the return value is 0.0.

Arguments:

• nPointIndex : Index of point

• sId : Unique identifier of floating point value attribute

Return

Value of the attribute. If the attribute is not available then the return value is 0.0.

Number bsHatchBlock.getPointAttributeRealExt(nPointIndex, sId)

Returns the value of the floating point value attribute with the unique identifier sId of the point at index nPointIndex. The floating point value attribute must be declared using declareBuildAttributes. If the attribute is not available then the undefined value is returned.

Arguments:

• nPointIndex : Index of point

• sId : Unique identifier of floating point value attribute

Return

Value of the attribute. If the attribute is not available then the undefined value is returned.

bsHatchBlock.setPointAttributeInt(nPointIndex, sId, nValue, bEdge)

Sets the integer value attribute with unique identifier a_id of the point at index nPointIndex to the value nValue. The integer value attribute must be declared using declareBuildAttributes.

Arguments:

• nPointIndex : Index of point

• sId : Unique identifier of integer value attribute

• nValue : Integer value

• bEdge : If true then the attribute is handled as an edge attribute. If false then the attribute is handled as a point attribute.

bsHatchBlock.setPointAttributeReal(nPointIndex, sId, fValue, bEdge)

Sets the real value attribute with unique identifier sId of the point at index nPointIndex to the value fValue. The real value attribute must be declared using declareBuildAttributes.

Arguments:

• nPointIndex : Index of point

• sId : Unique identifier of integer value attribute

• fValue : real value

• bEdge : If true then the attribute is handled as an edge attribute. If false then the attribute is handled as a point attribute.

bsHatchBlock.removeAttributes(sId)

Remove attributes with given ids.

Arguments

• sId : Attribute unique identifier(s). Can be a single string (e.g. “bsid”) or an array (e.g. [“bsid1”,”bsid2”])

Return

True if any attributes have been removed, else false.

bsHatchBlock.removePointAttributes(nPointIndex, sId)

Remove attributes with given ids.

Arguments

• nPointIndex : Index of point where to remove the attributes (-1 for all points)

• sId : Attribute unique identifier(s). Can be a single string (e.g. “bsid”) or an array (e.g. [“bsid1”,”bsid2”])

Return

True if any attributes have been removed.

Number bsHatchBlock.getExposureLength()

Calculates the whole length of all exposure vectors in mm.

Return

Whole length of all exposure vectors.

Number bsHatchBlock.getSkipLength()

Calculates the whole length of all skip vectors in mm.

Return

Whole length of all skip vectors.

Integer bsHatchBlock.getSkipCount()

Returns the total number of skip vectors. If the block is not in hatch mode then the result is always zero (see getPolylineMode()).

Return

Total number of skip vectors.

bsHatchBlock bsHatchBlock.clone()

Creates a copy of this container.

Return

Copy of this bsHatchBlock.

bsHatchBlock.clear()

Removes all data from the container.

bsHatchBlock.makeEmpty()

Removes all data from the container.

Boolean bsHatchBlock.isEmpty()

Check if the container is empty.

Return

true if container is empty. false if container is not empty.

Boolean bsHatchBlock.isContinuousPath()

Check if the hatch is a continuous path.

Return

true: open polyline from p0 to pn false: hatch segments p0–p1, p2–p3, etc..

Integer bsHatchBlock.getPointCount()

Returns the total number of points.

Return

Total number of points.

vec2 bsHatchBlock.getPoint(nIndex)

Returns the point on given index.

Arguments:

• nIndex : Index of point

Return

Point data (vec2).

bsHatchBlock.setPoint(nIndex, point)

Returns the point at given index.

Arguments:

• nIndex : Index of point

• point : Point data (vec2)

bsBounds2D bsHatchBlock.getBounds()

Returns boundaries.

Return

Point data (bsBounds2D).

bsHatchBlock.setPolylineMode(mode)

Sets the polyline mode.

Arguments:

• mode : The polyline mode (bsPolylineIterator.nPolyClosed , bsPolylineIterator.nPolyOpen , bsPolylineIterator.nPolyHatch)

Integer bsHatchBlock.getPolylineMode()

Returns the polyline mode.

Return

The polyline mode (bsPolylineIterator.nPolyClosed , bsPolylineIterator.nPolyOpen , bsPolylineIterator.nPolyHatch , bsPolylineIterator.nPolyModeInvalid)

bsHatchBlock.appendPoint(point)

Appends point(s) to this container.

Arguments:

• point : point (vec2) or array of points

bsHatchBlock.flip()

Flips the orientation of the exposure data in this bsHatchBlock.

Return

This bsHatchBlock.

Integer bsHatchBlock.deleteShortLines(fMinLength)

Delete all short lines/segments which are shorter than the given length.

Arguments:

• fMinLength : Min allowed length of a line/segment.

Return

Number of deleted lines/segments.

Integer bsHatchBlock.splitLongSegments(fMaxLength)

Split all long segments which are longer than the given length. For polygons/polylines the subsegments are processed.

Arguments:

• fMaxLength : Max allowed length (>=0.1) of a segment (including subsegments of polygons/polylines).

Return

Number of split segments (including subsegments of polygons/polylines).

Integer bsHatchBlock.getModelSubtype()

Queries the part sub-type of the hatch data.

Return

Sub-type of the polyline. E.g. nSubtypePart, nSubtypeSupport (see bsModel).

Links: bsModel

bsHatchBlock.setModelSubtype(subType)

Sets the part sub-type of the hatch data.

Arguments:

• subType : Sub-type of the polyline. E.g. nSubtypePart, nSubtypeSupport (see bsModel).

Links: bsModel