GetStockHole

Name

 

            GetStockHole

 

When to use it

 

            After setting the sizes using the SetStock and SetStockHole methods and before the OnFinish event ends.

 

Prototype

 

GetStockHole(

            IndexStock: long /*[in]*/,

            IndexHole: long /*[in]*/,

            Type: long/*[out]*/,

            NumberOfVertices: long/*[out]*/,

            CenterX: double/*[out]*/,

            CenterY: double/*[out]*/,

            Radius : double/*[out]*/,

            TrimMargin: double/*[out]*/,

            UserDefinedData: long/*[out]*/,

);

 

Explanations

 

            With this method you may get information about each hole of a sheet from Stock.

            The number of holes of the stock was set by the SetStock method.

            The information about each hole can be set using the SetStockHole method.

            The vertices of each piece must be set using SetStockHoleVertex method.

 

Parameters

 

            IndexStock - the index of the piece whose information are extracted. This number is in range [0...NumberOfStockPieces - 1].

            IndexHole - the index of the hole whose information are set.

            Type: 0 for polygons and 1 for circles.

            NumberOfVertices - number of vertices of the polygon. The vertices MUST be given in the counter-clock way using the SetStockHoleVertex method.

            CenterX, CenterY: center of the circle.

            Radius : radius of the circle.

            TrimMargin: margin of sheet that must be avoided due to faults - not implemented yet.

            UserDefinedData- an user defined value.

 

See also

 

            SetStockHole, SetStock, SetStockHoleVertex, GetStockHoleVertex, NumberOfStockPieces.