Skip to content

ObjArea.md

Latest commit

 

History

History
53 lines (42 loc) · 1.46 KB

ObjArea.md

File metadata and controls

53 lines (42 loc) · 1.46 KB
Raw

ObjArea

Description

Function ObjArea returns the area of the referenced object.

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

Parameters

Name Type Description
h HANDLE Handle to object.

Remarks

([[User:Orso.b.schmid|Orso]], 2011 Jan. 27): ObjArea is affected by the application preference "2D Conversion Resolution" (PrefInt 55): the function 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 ObjArea and restore the user value at end of script. (tested VW 2010 and 2011).

Examples

	EndXtrd;
gFlatRoof := TRUE;
RoofSuccess := FALSE;
pitchedFailed := FALSE;
gFlArea := ObjArea(gMyPoly);
IF (NOT(pCustom_Roof)) | EmptyProfileGroup THEN {VB-104310 Need to generate roof when use custom is checked in the pref}
	BEGIN
	IF pDrawPitchedRoof THEN {This conditional draws 2D/3D roof if pitched or 3D roof if flat}
		BEGIN

RectangleN (0, 0, 90, 0, gRampWidth, gRampLength);
cRampArea := ObjArea (LNewObj);
DelObject (LNewObj);
import vs

# Function ObjArea returns the area of the referenced object.
h = vs.FSActLayer()  # handle to the first selected object on the active layer

area = vs.ObjArea(h)
vs.Message('ObjArea returned: ' + str(area))

Version

Availability: from VectorWorks 12.5

Category