VS:GetDashStyle: Difference between revisions
(Added note that it will also change the current document line style.) |
(expand) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 24: | Line 24: | ||
swt | swt | ||
BOOLEAN | BOOLEAN | ||
scales with thickness | |||
</line> | </line> | ||
| Line 29: | Line 30: | ||
numPairs | numPairs | ||
INTEGER | INTEGER | ||
count of used pairs | |||
</line> | </line> | ||
| Line 61: | Line 63: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<remark> | <remark> | ||
[[User:Orso.b.schmid|Orso]], 2016.03.01: The dash style index returned is relative to the dash style list, so it's not an index that can be used with [[VS:Index2Name]]. The values must be page inches. This routine seems to be the same as [[VS:GetDashStyleIndex]], but it also sets the found/created style to active. More comments on Vectorlab's [http://www.vectorlab.info/index.php?title=Index_pitfalls Index_pitfalls]. | |||
<code lang="vs"> | |||
GetDashStyle(scalesWithThickness: BOOLEAN; numPairs: INTEGER; dash1, gap1, dash2, gap2, dash3, gap3, dash4, gap4, dash5, gap5: REAL): INTEGER; | |||
indx := GetDashStyle(TRUE, 1, 0.12, 0.03); | |||
{ returns the dash style index of 'ISO-02 Dashed' or creates a style in the document with these values } | |||
</code> | |||
Parameter swt defines whether the linestyle will be scaled with thickness, and parameter numPairs specifies the number of length pairs (2-10) defining the linestyle. | Parameter swt defines whether the linestyle will be scaled with thickness, and parameter numPairs specifies the number of length pairs (2-10) defining the linestyle. | ||
The linestyle is defined by up to five black/white length pairs, which are specified in parameters | The linestyle is defined by up to five black/white length pairs, which are specified in parameters pair1 through pair5. The minimum length of any given black or white parameter is 1 point, or 1/72 of an inch, and the line specification must be in pairs. | ||
The Function will also set the document default line style. | The Function will also set the document default line style. | ||
</remark> | </remark> | ||
| Line 79: | Line 89: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<version> | <version> | ||
Availability: from | Availability: from MiniCAD 5.0 | ||
</version> | </version> | ||
Revision as of 06:57, 4 March 2016
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Function GetDashStyle searches for the pattern specified by the parameters. If it exists, then the linestyle index associated with the existing dash pattern is returned. If it does not exist, then it is added to the document and the linestyle index associated with the new dash pattern is returned. The current document default linestyle will be set to the index of the dash pattern.
FUNCTION GetDashStyle(
swt :BOOLEAN;
numPairs :INTEGER;
pair1 :REAL;
pair2 :REAL;
pair3 :REAL;
pair4 :REAL;
pair5 :REAL) : INTEGER;
def vs.GetDashStyle(swt, numPairs, pair1, pair2, pair3, pair4, pair5):
return INTEGER
Parameters
swt BOOLEAN scales with thickness numPairs INTEGER count of used pairs pair1 REAL pair2 REAL pair3 REAL pair4 REAL pair5 REAL
Remarks
Orso, 2016.03.01: The dash style index returned is relative to the dash style list, so it's not an index that can be used with VS:Index2Name. The values must be page inches. This routine seems to be the same as VS:GetDashStyleIndex, but it also sets the found/created style to active. More comments on Vectorlab's Index_pitfalls.
GetDashStyle(scalesWithThickness: BOOLEAN; numPairs: INTEGER; dash1, gap1, dash2, gap2, dash3, gap3, dash4, gap4, dash5, gap5: REAL): INTEGER;
indx := GetDashStyle(TRUE, 1, 0.12, 0.03);
{ returns the dash style index of 'ISO-02 Dashed' or creates a style in the document with these values }
Parameter swt defines whether the linestyle will be scaled with thickness, and parameter numPairs specifies the number of length pairs (2-10) defining the linestyle. The linestyle is defined by up to five black/white length pairs, which are specified in parameters pair1 through pair5. The minimum length of any given black or white parameter is 1 point, or 1/72 of an inch, and the line specification must be in pairs. The Function will also set the document default line style.
Example
VectorScript
currLS:=GetDashStyle;
Python
vs.GetDashStyle(True, 1, 1)
Version
Availability: from MiniCAD 5.0