GetUtilizedPartHole

Name

 

            GetUtilizedPartHole

 

When to use it

 

            During the OnFinish event.

 

Prototype

 

GetUtilizedPartHole(

            SheetIndex: long /*[in]*/,

            PieceIndex: long /*[in]*/,

            HoleIndex: long /*[in]*/,

            Type: long /*[out]*/,

            NumberOfVertices: long /*[out]*/

            CenterX : double /*[out]*/,

            CenterY : double /*[out]*/,

            Radius : double /*[out]*/,

            StockIndex: long /*[out]*/,

            PartIndex: long /*[out]*/,

            StockUserDefinedData: long /*[out]*/,

            PartUserDefinedData: long /*[out]*/

            HoleUserDefinedData: long /*[out]*/

);

 

Explanations

 

            This method returns information about the holes of an utilized piece. For finding information about the position of polygon's vertices you have to call GetVertexOfUtilizedPartHole method.

 

Parameters

 

            SheetIndex - Is the index of the layout (sheet) whose information is needed. SheetIndex must be between 0 and TotalNumberOfUtilizedStock - 1.

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

            HoleIndex - the index of the hole whose information are extracted.

            Type - 0 for polygons and 1 for circles.

            NumberOfVertices - the number of vertices of the part. 0 if the part is a circle.

            CenterX, CenterY, Radius - the new coordinates of the circle if the current piece is a circle.

            StockIndex - The index of the Repository piece where the cut is performed. StockIndex is between 0 and NumberOfStockPieces - 1.

            PartIndex - is the index of the current utilized piece in the array of the pieces given as input. This number is in range [0...NumberOfParts - 1]. Using this field you may easily locate the current utilized piece in the input array.

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

            PartUserDefinedData  - an user defined value which was set by SetPart method.

            HoleUserDefinedData  - an user defined value which was set by SetPart method.

 

 

See also

 

            UtilizedPart, GetPartGetUtilizedPart, GetVertexOfUtilizedPartHole, GetUtilizedStock, OnFinish.