VS:GetDashDataValPrAtN: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (1 revision) |
(No difference)
|
Latest revision as of 22:36, 12 September 2018
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Function GetDashDataValPrAtN gets the dash data for the specified dash style. The dash data is a dash/gap value pair. GetDashDataValPrAtN returns false if the dash style or dash data doesn't exist. Dash styles support up to 5 dash/gap value pairs.
FUNCTION GetDashDataValPrAtN(
dashStyleIndex :LONGINT;
dataIndex :INTEGER;
VAR dash :REAL;
VAR gap :REAL) : BOOLEAN;
def vs.GetDashDataValPrAtN(dashStyleIndex, dataIndex): return (BOOLEAN, dash, gap)
Parameters
dashStyleIndex LONGINT The negative value of the dash pattern's internal index. dataIndex INTEGER Index of the data value pair. dash REAL The dash segement value. gap REAL The gap segment value.
Example
PROCEDURE Example; VAR n, numPairs : INTEGER; dashIndex : LONGINT; scaleWThick :BOOLEAN; arrayDashDat : ARRAY[1..5] OF POINT; x,y : REAL; BEGIN dashIndex := GetDashStyleIndexN(TRUE, 2, 0.12, 0.18, 0.03, 0.07); numPairs := GetNumDashDataPairsN(dashIndex,scaleWThick); FOR n := 1 TO numPairs DO BEGIN IF (GetDashDataValPrAtN(dashIndex, n , x, y)) THEN BEGIN arrayDashDat[n].x := x ; arrayDashDat[n].y := y ; END; END; END; RUN(Example);
Version
Availability: from Vectorworks 2019
See Also
VS Functions:
VS:GetNumDashDataPairsN | VS:GetDashStyleIndexN
VS Functions:
[[VS:GetNumDashDataPairsN]]
| [[VS:GetDashStyleIndexN]]