An edge is part of a domain boundary, consisting of oriented, node-connected pw::Connector objects. Edges cannot persist without a domain.
pw:: | 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. |
pw::Edge create
This action creates a new edge object.
none
This action returns a new pw::Edge object.
pw::Edge createFromConnectors ?-single? connectors
This action creates new edge objects from the given connectors.
-single | If 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. |
connectors | This required parameter is a list of pw::Connector objects. |
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.
This action returns a list of new pw::Edge objects.
pw::Edge getMinimumSpacing edges
This action gets the minimum spacing between grid points of the given edges.
edges | This required parameter is a list of pw::Edge objects for which the minimum spacing will be found. |
This action returns the float minimum spacing in the range [0.0, infinity).
pw::Edge getMaximumSpacing edges
This action gets the maximum spacing between grid points of the given edges.
edges | This required parameter is a list of pw::Edge objects for which the maximum spacing will be found. |
This action returns the float maximum spacing in the range [0.0, infinity).
$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.
none
This action returns nothing.
$edge getConnector index
This action gets a connector from this edge.
index | This required parameter is the index of the connector to get in the range [1, number of connectors]. |
This action returns a pw::Connector object.
$edge getConnectors
This action gets the connector list.
This action has no parameters.
This action returns a pw::Connector object list.
$edge getConnectorOrientation index
This action gets the orientation of a connector in this edge.
index | This required parameter is the index of the connector of which to get the orientation in the range [1, number of connectors]. |
This action returns a string with options < Same | Opposite >.
This action gets the orientation of all connectors in this edge.
This action has no parameters.
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.
$edge addConnector connector
This action adds a connector to the end of this edge.
connector | This required parameter is a Connector object to add to the edge. |
This action returns nothing.
$edge joinConnectors
This action joins the connectors in this edge to form a single connector.
none
This action returns a new pw::Connector object.
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.
$edge getDimension
This action gets the dimension of this edge.
none
This action returns the integer number of grid points, or 0 for an edge with non-dimensioned connectors.
$edge isClosed
This action returns true if the edge’s ends are the same.
none
This action returns boolean true if the edge is closed, false otherwise.
$edge getPointCount
This action gets the number of points in this edge.
none
This action returns the integer number of points, or zero if the connectors are undimensioned.
$edge getPoints
This action gets all the edge grid points.
This action has no parameters.
This action returns a point list giving the grid point positions and each may be in the form “u v dbentity”.
$edge getPosition ?-index? value
This action gets the position in the defining space of the edge at the given index.
-index | This 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. |
value | This required parameter is the value at which to get the position. |
This action returns a point giving the position on the edge. It may be in the form “u v dbentity”.
$edge getXYZ ?-index? value
This action gets the position of the edge in model space at the given index.
-index | This 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. |
value | This required parameter is the value at which to get the position. |
This action returns an XYZ vector.
$edge duplicate
This action creates a copy of the edge.
none
This action returns a pw::Edge object.
$edge getNode < Begin | End | index >
This action gets a node from an edge.
index | This 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. |
This action returns a pw::Node object.
This action creates a new edge object.
pw::Edge create
This action creates new edge objects from the given connectors.
pw::Edge createFromConnectors ?-single? connectors
This action gets the minimum spacing between grid points of the given edges.
pw::Edge getMinimumSpacing edges
This action gets the maximum spacing between grid points of the given edges.
pw::Edge getMaximumSpacing edges
This action deletes the edge.
$edge delete
This action gets the number of connectors in this edge.
$edge getConnectorCount
This action gets a connector from this edge.
$edge getConnector index
This action gets the connector list.
$edge getConnectors
This action gets the orientation of a connector in this edge.
$edge getConnectorOrientation index
This action adds a connector to the end of this edge.
$edge addConnector connector
This action removes the last connector from this edge.
$edge removeLastConnector
This action reverses the order of connectors that define this edge.
$edge reverse
This action joins the connectors in this edge to form a single connector.
$edge joinConnectors
This action gets the dimension of this edge.
$edge getDimension
This action returns true if the edge’s ends are the same.
$edge isClosed
This action gets the number of points in this edge.
$edge getPointCount
This action gets the position of an edge grid point.
$edge getPoint index
This action gets all the edge grid points.
$edge getPoints
This action gets the position in the defining space of the edge at the given index.
$edge getPosition ?-index? value
This action gets the position of the edge in model space at the given index.
$edge getXYZ ?-index? value
This action creates a copy of the edge.
$edge duplicate
This action gets a node from an edge.
$edge getNode < Begin | End | index >