VS:HArea

From Vectorworks Developer
Jump to navigation Jump to search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

See ObjArea for a replacement function.

Function HArea returns the area of the referenced object.

FUNCTION HArea(
h :HANDLE) : REAL;
def vs.HArea(h):
    return REAL

Parameters

h HANDLE Handle to object.

Remarks

(_c_, 2011.01.27): HArea is affected by the application preference "2D Conversion Resolution" (PrefInt 55): will output faulty values on polylines with curved vertexes, if this preference is set to anything but "Very high" (512). It is advisable to set this preferences to 512 before using HArea and restore the user value at end of script. (tested VW 2010 and 2011).

(_c_, 2010.04.13): Replaced by ObjArea. HArea still works, but will always use the current settings for length primary units, while ObjArea will use the settings for Area units, which might be different. See preference flags 176-179 in the SDK.

Version

HArea is obsolete as of VectorWorks 12.5


Availability: from All Versions