SurfaceCovered


Name


            SurfaceCovered


Type


            Read


When to use it


            You may use this method during the OnFinish event.


Prototype


    HRESULT SurfaceCovered(

            SheetIndex: long /*[in]*/,

            SurfaceCovered: double /*[out]*/,

            RepositoryIndex: long /*[out]*/,

            RepositoryExternalID: long /*[out]*/

    );


Explanations


            The surface covered (in percent) by the current layout.

            This value is between 0 and 100.


            This property tells you how good is the current layout.


Parameters


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

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

            RepositoryIndex - The index of the Repository piece which is utilized in the SheetIndex layout. RepositoryIndex is between 0 and NumberOfRepositoryPieces - 1.

            RepositoryExternalID - an user defined value which was set by SetRepositoryPiece method.


Remark


           

            SurfaceCovered does not take into account the material wasted by the cutting blade. Thus, if the BladeWidth is greater than 0 the SurfaceCovered is always smaller than 100%.


See Also:


            BladeWidth, OnFinish.

 

Links

       back to index

       www.optimalprograms.com