Difference between revisions of "VS:GetDashStyle"

From Vectorworks Developer
Jump to: navigation, search
(fix integer)
(expand)
 
Line 36: Line 36:
 
pair1
 
pair1
 
REAL
 
REAL
values in pt (1/72 inches)
 
  
 
</line>
 
</line>
Line 42: Line 41:
 
pair2
 
pair2
 
REAL
 
REAL
values in pt (1/72 inches) or empty
 
  
 
</line>
 
</line>
Line 48: Line 46:
 
pair3
 
pair3
 
REAL
 
REAL
values in pt (1/72 inches) or empty
 
  
 
</line>
 
</line>
Line 54: Line 51:
 
pair4
 
pair4
 
REAL
 
REAL
values in pt (1/72 inches) or empty
 
  
 
</line>
 
</line>
Line 60: Line 56:
 
pair5
 
pair5
 
REAL
 
REAL
values in pt (1/72 inches) or empty
 
  
 
</line>
 
</line>
Line 68: 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]]. This routine seems to be the same as [[VS:GetDashStyleIndex]], but it also sets the found/created style to active.
+
[[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">
 
<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);  
 
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 }
 
{ returns the dash style index of 'ISO-02 Dashed' or creates a style in the document with these values }

Latest revision as of 02: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
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox