VS:ObjSurfaceArea

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

Description

Function ObjSurfaceArea calculates the surface area of the referenced solid object. The function supports only valid solids objects.

FUNCTION ObjSurfaceArea(
             solidObject   :HANDLE) : REAL;

def vs.ObjSurfaceArea(solidObject):
    return REAL

Parameters

solidObject

HANDLE

Handle to solids object.

Remarks

Calculates the volume of the given object if a valid solid.

Apparently this command is replacing CalcSurfaceArea. It should be noted that ObjSurfaceArea returns the surface area in area units from the Units dialog. CalcSurfaceArea returns the volume in length units squared.

Example

VectorScript

PROCEDURE Example;
VAR
volume, area: REAL;
BEGIN
IF FSActLayer <> NIL THEN BEGIN
volume := CalcVolume(FSActLayer);
area := CalcSurfaceArea(FSActLayer);
Message('Volume ', volume, ', surface area ', area);
END;
END;
RUN(Example);

Python

Version

Availability: from VectorWorks12.5