CalcVolume.md

CalcVolume

Description

Function CalcVolume calculates the volume of the referenced solid object. The function supports only valid solids objects.

FUNCTION CalcVolume(solidObject : HANDLE): REAL;

def vs.CalcVolume(solidObject):
    return REAL

Parameters

Name	Type	Description
solidObject	HANDLE	Handle to solids object.

Remarks

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

Examples

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()

	ELSE BEGIN
		{* Get the volume and surface area *}
		gVolume := CalcVolume (gObjH);
		gSurfArea := CalcSurfaceArea (gObjH);
{
message (' gVolume = ',gVolume ,'    gSurfArea = ',gSurfArea ,'    ObjVolume = ', ObjVolume (gObjH),'    ObjSurfaceArea = ',ObjSurfaceArea (gObjH));
}

import vs

# Function CalcVolume calculates the volume of the referenced solid object.
solidObject = vs.FSActLayer()  # handle to the first selected object on the active layer

vol = vs.CalcVolume(solidObject)
vs.Message('CalcVolume returned: ' + str(vol))

Version

CalcVolume is obsolete as of VectorWorks12.5

Availability: from VectorWorks8.0

Category

• Objects - Solids