oaEllipse Class Reference

Inheritance diagram for oaEllipse:

oaShape oaPinFig oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

void getBoundary (oaPointArray &points, oaUInt4 numSides) const
void setBBox (const oaBox &bBoxIn)
oaPolygon * convertToPolygon (oaUInt4 numSides=32)

Static Public Methods

oaEllipse * create (oaBlock *block, oaLayerNum layerNum, oaPurposeNum purposeNum, const oaBox &bBox)
void genBoundary (const oaBox &ellipseBBox, oaUInt4 numSides, oaPointArray &boundary)

Detailed Description

The oaEllipse class implements an ellipse shape. Ellipses are defined by their bounding boxes. A circle is a special case of an ellipse where the bounding box is square.

Member Function Documentation

oaPolygon * oaEllipse::convertToPolygon (  oaUInt4    numSides = 32 ) 
 

This function converts this ellipse to a polygon using the specified number of sides. The polygon is returned, although it is the same pointer as the ellipse.

Parameters:
numSides The number of segments to represent the ellipse as a polygon
Exceptions:
oacEllipseNumSidesInvalid 

oaEllipse * oaEllipse::create (  oaBlock *    block,
oaLayerNum    layerNum,
oaPurposeNum    purposeNum,
const oaBox &    bBox
)  [static]
 

This function creates an ellipse with the specified attributes. The specified bBox is checked to verify it does not have a zero area and it is not inverted.

Parameters:
block The block in which the ellipse is created
layerNum The number of the layer on which the ellipse is created
purposeNum The number of the purpose on which the ellipse is created
bBox The bounding box for the ellipse
Exceptions:
oacEllipseBBoxInvalid 

void oaEllipse::genBoundary (  const oaBox &    ellipseBBox,
oaUInt4    numSides,
oaPointArray &    boundary
)  [static]
 

This function fills out boundary with the boundary polygon of the ellipse specified by ellipseBBoxIn. The polygon is generated with the number of sides specified by numSidesIn.

Parameters:
ellipseBBox The bounding box for the ellipse
numSides The number of sides returned
boundary The location of the returned point array
Exceptions:
oacEllipseNumSidesInvalid 

void oaEllipse::getBoundary (  oaPointArray &    points,
oaUInt4    numSides
)  const
 

This function fills out points with the bounding polygon of this ellipse. The polygon is generated with the number of sides specified by numSides.

Parameters:
points The location for the returned array of points for the ellipse
numSides The number of sides that define the bounding polygon
Exceptions:
oacEllipseNumSidesInvalid 

void oaEllipse::setBBox (  const oaBox &    bBoxIn ) 
 

This function sets the bBox of this ellipse to the specified value.

Parameters:
bBoxIn The specified bounding box for the ellipse
Exceptions:
oacEllipseBBoxInvalid 

The documentation for this class was generated from the following files:

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.