VS:OffsetHandle: Difference between revisions
Jump to navigation
Jump to search
m (fix) |
(clearer var names) |
||
Line 49: | Line 49: | ||
Warning: | Warning: | ||
* The parameter ''offsetDistance'' takes mm, unregarded unit's settings. | * The parameter ''offsetDistance'' takes mm, unregarded unit's settings. | ||
* If you pass a polygon/polyline it outputs a group containing | * If you pass a polygon/polyline it outputs a group containing one or more polygon/polylines, not a group of lines. | ||
* Polyline holes are ignored | * Polyline holes are ignored | ||
* Undo fails on this action: you should consider carefully if using this routine | * Undo fails on this action: you should consider carefully if using this routine | ||
Line 59: | Line 59: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<sample> | <sample> | ||
==== VectorScript ==== | |||
<code lang="pas">PROCEDURE try; | <code lang="pas">PROCEDURE try; | ||
VAR | VAR | ||
prevLObj, sourceObj, | prevLObj, sourceObj, groupObj : HANDLE; | ||
BEGIN | BEGIN | ||
sourceObj := FSActLayer; | sourceObj := FSActLayer; | ||
Line 69: | Line 70: | ||
prevLObj := LObject; { only before VW 2014: store for later comparison } | prevLObj := LObject; { only before VW 2014: store for later comparison } | ||
groupObj := OffsetHandle(sourceObj, -10, TRUE, TRUE); { negative offset -10mm } | |||
groupObj := LObject; { only before VW 2014: this should be now the product of OffsetHandle } | |||
IF (prevLObj <> | IF (prevLObj <> groupObj) THEN BEGIN | ||
Message('Type: ', GetType( | Message('Type: ', GetType(groupObj)); | ||
ResetObject( | ResetObject(groupObj); | ||
HUngroup( | HUngroup(groupObj); | ||
SetDSelect(sourceObj); | SetDSelect(sourceObj); | ||
END; | END; | ||
Line 81: | Line 82: | ||
END; | END; | ||
Run(try);</code> | Run(try);</code> | ||
==== Python ==== | |||
<code lang="py"> | |||
</code> | |||
</sample> | </sample> | ||
Revision as of 05:55, 26 March 2014
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Creates a group of lines which represent the weighted medial axis of given polygon.
FUNCTION OffsetHandle(
h :HANDLE;
offsetDistance :REAL;
EdgeRestoration :BOOLEAN;
FilletSharpEdges :BOOLEAN) : HANDLE;
def vs.OffsetHandle(h, offsetDistance, EdgeRestoration, FilletSharpEdges): return HANDLE
Parameters
h HANDLE offsetDistance REAL EdgeRestoration BOOLEAN FilletSharpEdges BOOLEAN
Remarks
(Orso, 2014.03.25): The routine was introduced undocumented by VW11 (2006).
Warning:
- The parameter offsetDistance takes mm, unregarded unit's settings.
- If you pass a polygon/polyline it outputs a group containing one or more polygon/polylines, not a group of lines.
- Polyline holes are ignored
- Undo fails on this action: you should consider carefully if using this routine
- VW 2011, 2012, 2013
- the handle h doesn't set. Use LObject to fetch the handle. This is dangerous, if the routine fails, LObject will be something else: store LObject before running the script and afterwards, then compare. If they are different the routine succeeded.
- VW 2014
- the handle will set as expected, undo still fails
Example
VectorScript
PROCEDURE try; VAR prevLObj, sourceObj, groupObj : HANDLE; BEGIN sourceObj := FSActLayer; IF (sourceObj <> NIL) THEN BEGIN { h won't set with OffsetHandle until VW 2014 } prevLObj := LObject; { only before VW 2014: store for later comparison } groupObj := OffsetHandle(sourceObj, -10, TRUE, TRUE); { negative offset -10mm } groupObj := LObject; { only before VW 2014: this should be now the product of OffsetHandle } IF (prevLObj <> groupObj) THEN BEGIN Message('Type: ', GetType(groupObj)); ResetObject(groupObj); HUngroup(groupObj); SetDSelect(sourceObj); END; END; END; Run(try);
Python
Version
Availability: from Vectorworks 2014
See Also
Similar calls:
Similar calls:
- [[VS:OffsetPoly]]
- [[VS:OffsetPolyN]]