VS:CalcSurfaceArea

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

Description

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

FUNCTION CalcSurfaceArea(
             solidObject   :HANDLE) : REAL;

def vs.CalcSurfaceArea(solidObject):
    return REAL

Parameters

solidObject

HANDLE

Handle to solids object.

Remarks

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

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

def Example():
	if vs.FSActLayer() != None:
		volume = vs.CalcVolume(vs.FSActLayer())
		area = vs.CalcSurfaceArea(vs.FSActLayer())
		vs.Message('Volume ', volume, ', surface area ', area)
Example()

Version

CalcSurfaceArea is obsolete as of VectorWorks12.5

Availability: from VectorWorks8.0