Constructs a plane with specified center, normal direction, and bounds.
Input Arguments
0 |
Collection Object Name |
Plane Name |
The name of the resulting plane. |
1 |
Vector |
Plane Center (in working coordinates) |
The center of the resulting plane. |
2 |
Vector |
Plane Normal (in working coordinates) |
The normal direction of the resulting plane. |
3 |
Double |
Plane Edge Dimension |
The length of each edge of the plane as depicted in the graphical view. |
Return Arguments
None.
Returned Status
SUCCESS |
The plane was created successfully. |
FAILURE |
A normal of zero length was specified. |
Remarks
If the specified plane name already exists, the name will be incremented to avoid duplicates.
The plane normal cannot be a vector of zero length. While the plane edge dimension can be zero or negative, this could potentially cause problems with other calculations, so a positive edge dimension should always be specified.
The edge dimension is merely used to draw the plane in the graphical view. When used for analysis, a plane extends infinitely in two dimensions.