NXOpen.UF.Ui.SpecifyPlane

Ui.SpecifyPlane()

Refer to UF_UI_specify_plane for documentation.

Signature: SpecifyPlane(message, mode, display, orientation, origin)

Parameters:

• message (str) – Cue line message (80 character maximum)
• mode (int) – On input default plane subfunction. On output the plane subfunction actually used: -1 = Enable ok without default selection 0 = Inhibit default selection 1 = Three Points 2 = Two Lines 3 = Point, Perp Curve 4 = Plane of Arc/Conic 5 = Plane of WCS 6 = Plane of CSYS 7 = Principal Plane 8 = Existing Plane 9 = Two Tangent Faces 10 = Point, Tangent Face 11 = Coefficients 12 = Parallel Thru Pt 13 = Parallel At Dist 14 = Perp, Thru Line
• display (int) – 0 = Display temporary plane in all active views 1 = Do not display temporary plane
• orientation (list of float) – Plane orientation in absolute coordinate
• origin (list of float) – Plane origin in absolute coordinate

Returns:

A Tuple

Return type:

A tuple consisting of (mode,response,planeEid)

mode(int): Modified value of mode

response(int): 1 = Back 2 = Cancel 3 = Ok

planeEid(Tag): Object identifier of plane if mode 8 was selected NULL_TAG for other modes.

License requirements: None