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:: Edge

An edge is part of a domain boundary, consisting of oriented, node-connected pw::Connector objects.  Edges cannot persist without a domain.

Derives From

pw::Object

Summary
pw:: Edge
An edge is part of a domain boundary, consisting of oriented, node-connected pw::Connector objects.
Static Actions
create
This action creates a new edge object.
createFromConnectors
This action creates new edge objects from the given connectors.
getMinimumSpacing
This action gets the minimum spacing between grid points of the given edges.
getMaximumSpacing
This action gets the maximum spacing between grid points of the given edges.
Instance Actions
delete
This action deletes the edge.
getConnectorCount
This action gets the number of connectors in this edge.
getConnector
This action gets a connector from this edge.
getConnectors
This action gets the connector list.
getConnectorOrientation
This action gets the orientation of a connector in this edge.
getConnectorOrientations
This action gets the orientation of all connectors in this edge.
addConnector
This action adds a connector to the end of this edge.
removeLastConnector
This action removes the last connector from this edge.
reverse
This action reverses the order of connectors that define this edge.
joinConnectors
This action joins the connectors in this edge to form a single connector.
getDimension
This action gets the dimension of this edge.
isClosed
This action returns true if the edge’s ends are the same.
getPointCount
This action gets the number of points in this edge.
getPoint
This action gets the position of an edge grid point.
getPoints
This action gets all the edge grid points.
getPosition
This action gets the position in the defining space of the edge at the given index.
getXYZ
This action gets the position of the edge in model space at the given index.
duplicate
This action creates a copy of the edge.
getNode
This action gets a node from an edge.

Static Actions

create

pw::Edge create

This action creates a new edge object.

Parameters

none

Returns

This action returns a new pw::Edge object.

See Also

createFromConnectors, addConnector, duplicate

createFromConnectors

pw::Edge createFromConnectors ?-single? connectors

This action creates new edge objects from the given connectors.

Parameters

-singleIf this optional flag is present, this action tries to combine the connectors into a single edge.  If that is not possible, an edge is created for each connector.
connectorsThis required parameter is a list of pw::Connector 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 connectors.  The edges may be created in a different order or may be created with different orientations.  Use the explicit edge building routines (create> and addConnector commands) to build the edge in a controlled manner.

Returns

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

See Also

create, addConnector

getMinimumSpacing

pw::Edge getMinimumSpacing edges

This action gets the minimum spacing between grid points of the given edges.

Parameters

edgesThis required parameter is a list of pw::Edge objects for which the minimum spacing will be found.

Returns

This action returns the float minimum spacing in the range [0.0, infinity).

See Also

getMaximumSpacing

getMaximumSpacing

pw::Edge getMaximumSpacing edges

This action gets the maximum spacing between grid points of the given edges.

Parameters

edgesThis required parameter is a list of pw::Edge objects for which the maximum spacing will be found.

Returns

This action returns the float maximum spacing in the range [0.0, infinity).

See Also

getMinimumSpacing

Instance Actions

delete

$edge delete

This action deletes the edge.  This is only allowed if the edge has not been added to a pw::Domain.  Calling delete on an edge after it has been added will generate an error.

Parameters

none

Returns

This action returns nothing.

getConnectorCount

$edge getConnectorCount

This action gets the number of connectors in this edge.

Parameters

none

Returns

This action returns the number of connectors in the edge.

getConnector

$edge getConnector index

This action gets a connector from this edge.

Parameters

indexThis required parameter is the index of the connector to get in the range [1, number of connectors].

Returns

This action returns a pw::Connector object.

See Also

addConnector, getConnectorCount, getConnectors

getConnectors

$edge getConnectors

This action gets the connector list.

Parameters

This action has no parameters.

Returns

This action returns a pw::Connector object list.

See Also

getConnector, getConnectorOrientations

getConnectorOrientation

$edge getConnectorOrientation index

This action gets the orientation of a connector in this edge.

Parameters

indexThis required parameter is the index of the connector of which to get the orientation in the range [1, number of connectors].

Returns

This action returns a string with options < Same | Opposite >.

See Also

getConnectorCount, getConnector, getConnectorOrientations

getConnectorOrientations

This action gets the orientation of all connectors in this edge.

Parameters

This action has no parameters.

Returns

This action returns a string list with options < Same | Opposite > for each connector in the edge.  The order of the list is the same as the result of getConnectors.

See Also

getConnectorOrientation, getConnectors

addConnector

$edge addConnector connector

This action adds a connector to the end of this edge.

Parameters

connectorThis required parameter is a Connector object to add to the edge.

Returns

This action returns nothing.

See Also

create, getConnector

removeLastConnector

$edge removeLastConnector

This action removes the last connector from this edge.

Parameters

none

Returns

This action returns nothing.

See Also

addConnector

reverse

$edge reverse

This action reverses the order of connectors that define this edge.

Parameters

none

Returns

This action returns nothing.

joinConnectors

$edge joinConnectors

This action joins the connectors in this edge to form a single connector.

Parameters

none

Returns

This action returns a new pw::Connector object.

Information

The edge will still exist after this action, but will contain only one pw::Connector object oriented in the same direction as the edge.  The resultant pw::Connector is returned by this action.  The original connectors are left intact.

getDimension

$edge getDimension

This action gets the dimension of this edge.

Parameters

none

Returns

This action returns the integer number of grid points, or 0 for an edge with non-dimensioned connectors.

See Also

getPointCount

isClosed

$edge isClosed

This action returns true if the edge’s ends are the same.

Parameters

none

Returns

This action returns boolean true if the edge is closed, false otherwise.

getPointCount

$edge getPointCount

This action gets the number of points in this edge.

Parameters

none

Returns

This action returns the integer number of points, or zero if the connectors are undimensioned.

See Also

getDimension

getPoint

$edge getPoint index

This action gets the position of an edge grid point.

Parameters

indexThis required parameter is the integer index of the grid point to get in the range [1, dimension].

Returns

This action returns a point giving the grid point position.  It may be in the form “u v dbentity”.

getPoints

$edge getPoints

This action gets all the edge grid points.

Parameters

This action has no parameters.

Returns

This action returns a point list giving the grid point positions and each may be in the form “u v dbentity”.

getPosition

$edge getPosition ?-index? value

This action gets the position in the defining space of the edge at the given index.

Parameters

-indexThis optional parameter indicates to get the position at a grid point.  The value is an integer index [1, number of points].  This is the default option.
valueThis required parameter is the value at which to get the position.

Returns

This action returns a point giving the position on the edge.  It may be in the form “u v dbentity”.

getXYZ

$edge getXYZ ?-index? value

This action gets the position of the edge in model space at the given index.

Parameters

-indexThis optional parameter indicates to get the xyz at a grid point.  The value is an integer index [1, number of points].  This is the default option.
valueThis required parameter is the value at which to get the position.

Returns

This action returns an XYZ vector.

duplicate

$edge duplicate

This action creates a copy of the edge.

Parameters

none

Returns

This action returns a pw::Edge object.

See Also

create, createFromConnectors

getNode

$edge getNode < Begin | End | index >

This action gets a node from an edge.

Parameters

indexThis required parameter is the integer index of the node to get, or a string with options < Begin | End >.  Begin is the same as 1 or the beginning node of the edge, and End is the same as 2 or the ending node of the edge.

Returns

This action returns a pw::Node object.
© 2021 Cadence Design Systems, Inc. All rights reserved worldwide.  Generated by Natural Docs.
A connector is a computationally one-dimensional grid entity, defined in the parameter space of one or more end-connected curve segments.
pw::Edge create
This action creates a new edge object.
pw::Edge createFromConnectors ?-single? connectors
This action creates new edge objects from the given connectors.
pw::Edge getMinimumSpacing edges
This action gets the minimum spacing between grid points of the given edges.
pw::Edge getMaximumSpacing edges
This action gets the maximum spacing between grid points of the given edges.
$edge delete
This action deletes the edge.
$edge getConnectorCount
This action gets the number of connectors in this edge.
$edge getConnector index
This action gets a connector from this edge.
$edge getConnectors
This action gets the connector list.
$edge getConnectorOrientation index
This action gets the orientation of a connector in this edge.
$edge addConnector connector
This action adds a connector to the end of this edge.
$edge removeLastConnector
This action removes the last connector from this edge.
$edge reverse
This action reverses the order of connectors that define this edge.
$edge joinConnectors
This action joins the connectors in this edge to form a single connector.
$edge getDimension
This action gets the dimension of this edge.
$edge isClosed
This action returns true if the edge’s ends are the same.
$edge getPointCount
This action gets the number of points in this edge.
$edge getPoint index
This action gets the position of an edge grid point.
$edge getPoints
This action gets all the edge grid points.
$edge getPosition ?-index? value
This action gets the position in the defining space of the edge at the given index.
$edge getXYZ ?-index? value
This action gets the position of the edge in model space at the given index.
$edge duplicate
This action creates a copy of the edge.
$edge getNode < Begin | End | index >
This action gets a node from an edge.
Base type for all glyph types
An edge is part of a domain boundary, consisting of oriented, node-connected pw::Connector objects.
A float is a fractional number.
A domain is a computationally two-dimensional grid entity, bounded by one or more pw::Edges.
This action gets the orientation of all connectors in this edge.
A string is an array of characters.
An integer is a whole number.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
A point is a position either in model space or database parameter space.
A vector is a list of float values.
A node is the zero-dimensional boundary of a one-dimensional pw::Connector.