Glyph
Version 7.22.2
About
Base Type
Global Types
General Types
Mode Types
Base Entity Type
Database Entity Types
Grid Entity Types
Source Entity Types
Segment Types
Connector Support Types
Domain Support Types
Block Support Types
Utilities
Cadence Design Systems, Inc.

pw:: FaceUnstructured

An unstructured face is a collection of edge-connected pw::Domain objects that are used to build watertight boundaries of unstructured blocks.  Unstructured faces cannot persist without a block.

Derives From

pw::Object pw::Face

Summary
pw:: FaceUnstructured
An unstructured face is a collection of edge-connected pw::Domain objects that are used to build watertight boundaries of unstructured blocks.
Static Actions
create
This action creates a new unstructured face object.
createFromDomains
This command creates new unstructured face objects from the given domains.
Static Attributes
MaximumBendAngle
This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.
replaceDomain
This action replaces an existing domain in all unstructured faces with another domain.
Instance Actions
getNormalOrientation
This action gets the orientation of the face normals.
setNormalOrientation
This action sets the orientation of the face normals.
getAdjacentDomains
This action gets domains adjacent to a face.
setBaffle
This action designates the face as a baffle or non-baffle face.
isBaffle
This action returns true if the face is a baffle face.
swapDomain
This action replaces an existing domain in the face with another domain that is not in the face.

Static Actions

create

pw::FaceUnstructured create

This action creates a new unstructured face object.

Parameters

none

Returns

This action returns a new pw::FaceUnstructured object.

See Also

pw::Block.addFace, createFromDomains

createFromDomains

pw::FaceUnstructured createFromDomains ?-single? domains

This command creates new unstructured face objects from the given domains.

Parameters

-singleIf this optional flag is present, this action tries to combine the domains into a single complete face.  If that is not possible, a block is created for each domain.
domainsThis required parameter is a list of pw::Domain objects.

Notes

While this command will produce identical results when run with the exact same input, it may produce different results for slight variations in the input domains.  The faces may be created in a different order or may be created with different orientations or topologies.  Use the explicit face building routines (pw::FaceUnstructured.create and pw::Face.addDomain commands) to build the face in a controlled manner.

Returns

This action returns a list of new pw::FaceUnstructured objects.

See Also

pw::Block.addFace, create

Static Attributes

MaximumBendAngle

pw::FaceUnstructured get/setMaximumBendAngle angle

This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.

Type

A float in the range [0.0, 180.0).

Default

0.0

replaceDomain

pw::FaceUnstructured replaceDomain $olddom $newdom

This action replaces an existing domain in all unstructured faces with another domain.  The domains can be of different types.

Parameters

olddomThis required parameter is expected to be a pw::Domain object that is contained in the face.
newdomThis required parameter is expected to be a pw::Domain object that is currently not in the face and will replace all occurrences of the old domain in the face.

Returns

This action returns a list of pw::FaceUnstructured objects that were modified.

Instance Actions

getNormalOrientation

$face getNormalOrientation

This action gets the orientation of the face normals.

Parameters

none

Returns

This action returns a string with options < In | Out | Unknown >.

setNormalOrientation

$face setNormalOrientation direction

This action sets the orientation of the face normals.

Parameters

directionThis required parameter is the string direction of the normals with options < In | Out >.

Returns

This action returns the resulting direction.

getAdjacentDomains

$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-nopoles? ?-type option? ?-visibleOnly?

This action gets domains adjacent to a face.

Parameters

-includeSelfThis optional flag, if present, means to also include domains in the face that are along the edge.
-manifoldThis optional flag indicates to restrict results to manifold domains (only 2 domains sharing a common connector).
-maximumAngle angleThis optional paramter specifies the maximum angle allowed between a domain and the face for the domain to be included.
-nopolesThis optional flag will exclude any domains that contain pole connectors.
-type optionThis optional parameter indicates to restrict the domain types returned.  Valid options are Structured, Unstructured, or Both (default).
-visibleOnlyThis optional flag, if present, restricts the results to only visible domains.

Returns

This action returns a list of pw::Domain adjacent to the face.

setBaffle

$face setBaffle value

This action designates the face as a baffle or non-baffle face.

Parameters

valueThis required boolean parameter sets whether or not the face is a baffle face.

Returns

This action returns nothing.

isBaffle

$face isBaffle

This action returns true if the face is a baffle face.

Parameters

none

Returns

This action returns a boolean value of true if the face is a baffle face or false if the face is a non-baffle face.

swapDomain

$face swapDomain $olddom $newdom

This action replaces an existing domain in the face with another domain that is not in the face.  The domains can be of different types.

Parameters

olddomThis required parameter is expected to be a pw::Domain object that is contained in the face.
newdomThis requried parameter is expected to be a pw::Domain object that is currently not in the face and will replace all occurrences of the old domain.

Returns

This action returns a boolean set to true if the domain was swapped.
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
A domain is a computationally two-dimensional grid entity, bounded by one or more pw::Edges.
pw::FaceUnstructured create
This action creates a new unstructured face object.
pw::FaceUnstructured createFromDomains ?-single? domains
This command creates new unstructured face objects from the given domains.
pw::FaceUnstructured get/setMaximumBendAngle angle
This attribute is the maximum bending angle allowed when adding domains to this face, with 0 meaning no maximum.
pw::FaceUnstructured replaceDomain $olddom $newdom
This action replaces an existing domain in all unstructured faces with another domain.
$face getNormalOrientation
This action gets the orientation of the face normals.
$face setNormalOrientation direction
This action sets the orientation of the face normals.
$face getAdjacentDomains ?-includeSelf? ?-manifold? ?-maximumAngle angle? ?-nopoles? ?-type option? ?-visibleOnly?
This action gets domains adjacent to a face.
$face setBaffle value
This action designates the face as a baffle or non-baffle face.
$face isBaffle
This action returns true if the face is a baffle face.
$face swapDomain $olddom $newdom
This action replaces an existing domain in the face with another domain that is not in the face.
Base type for all glyph types
A face is part of a block boundary, consisting of oriented, edge-connected pw::Domain objects.
An unstructured face is a collection of edge-connected pw::Domain objects that are used to build watertight boundaries of unstructured blocks.
$block addFace face
This action adds a face to the block.
$face addDomain ?-linkage linkage? domain
This action adds a domain to this face.
A float is a fractional number.
A string is an array of characters.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.