oaBoundary Class Reference

Inheritance diagram for oaBoundary:

oaFig oaBlockObject oaDesignObject oaObject oaAreaBoundary oaClusterBoundary oaPRBoundary oaSnapBoundary


Public Methods

void getPoints (oaPointArray &points) const
void getEdgeNames (oaString *edgeNamesIn) const
oaUInt4 getNumEdges () const
oaBoolean hasDefaultConstraintGroup () const
oaConstraintGroup * getDefaultConstraintGroup () const
void setEdges (const oaPointArray &points, const oaString *edgeNames=NULL)
void transform (oaDouble scale, oaDouble angle)
void getEdgeNames (oaStringArray &edgeNamesIn) const
void setEdges (const oaPointArray &points, const oaStringArray &edgeNames)

Public Types

enum  { dtIndex = oacBoundaryDataType }

Detailed Description

The oaBoundary class is an abstract base for all types of boundary classes. In general, all types of boundaries are used to define an enclosed area. Boundaries include a polygonal outline. Each segment of the boundary can have a name associated with it.

Two coincident and three collinear points are illegal, and if detected, cause an exception to be thrown. You can use oaPointArray::compress() to remove these combinations.

The oaBoundary class can be observed by deriving from oaObserver<oaBoundary>.

Member Function Documentation

oaConstraintGroup * oaBoundary::getDefaultConstraintGroup (    )  const
 

This function returns the default constraint group for this boundary. If no constraints have been set on the default constraint group, a new constraint group is created and returned.

void oaBoundary::getEdgeNames (  oaStringArray &    edgeNamesIn )  const
 

This function fills in edgeNamesIn with the names of each edge of this boundary.

Parameters:
edgeNamesIn The array of names to fill in.

void oaBoundary::getEdgeNames (  oaString *    edgeNamesIn )  const
 

This function is deprecated. Refer to the getEdgeNames function that takes a reference to an oaStringArray for edgeNamesIn.

This function fills out the edgeNamesIn array with the names of each edge of this boundary.

Parameters:
edgeNamesIn The array of names to fill in.

oaUInt4 oaBoundary::getNumEdges (    )  const
 

This function returns the number of edges in this boundary.

void oaBoundary::getPoints (  oaPointArray &    points )  const
 

This function fills out the given oaPointArray with the points of this boundary.

Parameters:
points An oaPointArray to fill in.

oaBoolean oaBoundary::hasDefaultConstraintGroup (    )  const
 

This function returns a boolean indicating whether there is a default constraint group for this boundary.

void oaBoundary::setEdges (  const oaPointArray &    points,
const oaStringArray &    edgeNames
) 
 

This function sets the point array and edge names array of this boundary to the specified points and edgeNames, respectively. Note that the number of edge names must be equal to the number of points or an oacBoundaryInvalidEdgeNames exception is thrown.

Parameters:
points The array of points.
edgeNames The array of edge names.
Exceptions:
oacBoundaryInvalidEdgeNames 

void oaBoundary::setEdges (  const oaPointArray &    points,
const oaString *    edgeNames = NULL
) 
 

This function is deprecated. Refer to the setEdges function that takes a reference to an oaStringArray for the edgeNames.

This function sets the point array and edge names of this boundary to the specified points and edgeNames respectively. If boundary edgeNames are not supplied, the edges are automatically named using the form EDGE_n, where n starts at zero and increments by one.

Note that the number of edge names is assumed to be equal to the number of points.

Note: The order of the points actually set on the oaBoundary is not guaranteed to be the same as the order of points passed to the setEdges() function. Consequently, the order of points returned by a subsequent oaBoundary::getPoints() may be different from the order of points specified in points.

Exceptions:
oacBoundaryHasExtraPoints 
oacBoundaryTooFewPoints 

void oaBoundary::transform (  oaDouble    scale,
oaDouble    angle
) 
 

This function transforms this boundary by the specified scale factor and rotation angle.

Parameters:
scale Scaling factor to apply to the boundary.
angle Rotation to apply to the boundary.
Exceptions:
oacPRBoundaryInvalidRotation 

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dtIndex 

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.