VS:ObjSurfAreaInWorldC

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

Description

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

FUNCTION ObjSurfAreaInWorldC(
               solidObject   :HANDLE) : REAL;

def vs.ObjSurfAreaInWorldC(solidObject):
    return REAL

Parameters

solidObject

HANDLE

Handle to solids object.

Remarks

Calculates the surface area the given object if a valid solid.

Example

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

Version

Availability: from Vectorworks 2023.3