AreaCovered

 

Name

 

            AreaCovered

 

Type

 

            Read

 

When to use it

 

            You may use this method during the OnFinish event.

 

Prototype

 

    HRESULT AreaCovered(

            SheetIndex: long /*[in]*/,

            AreaCovered: double /*[out]*/,

            StockIndex: long /*[out]*/,

            StockUserDefinedData: long /*[out]*/

    );

 

Explanations

 

            The area covered (in percent) from the current layout.

            This value is between 0 and 1.

 

Parameters

 

            SheetIndex - the index of the layout whose information are extracted. This number is in range [0...TotalNumberOfUtilizedStock - 1].

            AreaCovered - the surface covered (in percent) in the current sheet.

            StockIndex - The index of the stock piece which is utilized in the SheetIndex layout. StockIndex is between 0 and NumberOfStockPieces - 1.

            StockUserDefinedData - an user defined value which was set by SetStock method.

 

 

Remark

           

            AreaCovered does not take into account the material wasted by the cutter diameter. Thus, if the CutterDiameter is greater than 0 the AreaCovered is always smaller than 1.

 

See Also:

 

            CutterDiameter, OnFinish.