VS:ObjSurfAreaInWorldC: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
No edit summary
 
(Several functions are available from Vectorworks 2023.3)
 
(One intermediate revision by one other user not shown)
Line 55: Line 55:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<version>
<version>
Availability: from Vectorworks 2023
Availability: from Vectorworks 2023.3


</version>
</version>

Latest revision as of 14:47, 5 September 2023

.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