PlanarShipGridBuilder Class¶
-
class
NXOpen.Display.PlanarShipGridBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.PlanarShipGridbuilder.To create a new instance of this class, use
NXOpen.Display.GridCollection.CreatePlanarShipGridBuilder()Default values.
Property Value IntersectType Everything LabelDisplayType ShowAll LabelSettingInheritted 0 LineFontType Solid LineSettingInheritted 1 LineWidthType Normal New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| BasePlane | Returns or sets the base plane where the planar ship grid is created. |
| IntersectType | Returns or sets the value that determines how to find objects that intersect the plane. |
| LabelColor | Returns or sets the grid line label color. |
| LabelDisplayType | Returns or sets the setting that indicates what grid lines are to be labelled. |
| LabelSettingInheritted | Returns or sets the setting that indicates whether the grid line label will inherit the intersected plane’s color |
| LineColor | Returns or sets the grid line color. |
| LineFontType | Returns or sets the grid line font. |
| LineSettingInheritted | Returns or sets the setting that indicates whether the grid line will inherit the intersected plane’s color/font/width. |
| LineWidthType | Returns or sets the grid line width. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetExtent | Get corner points of the grid extent. |
| GetIntersectedObjects | Get the objects that were searched to find intersections with the plane. |
| GetObject | Returns the object currently being edited by this builder. |
| SetExtent | Set corner points for the grid extent. |
| SetIntersectedObjects | Set the objects that are to be searched to find intersections with the plane. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| SwitchLabelLocationX | Switch label location in X direction. |
| SwitchLabelLocationY | Switch label location in Y direction. |
| SwitchLabelLocationZ | Switch label location in Z direction. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| PlanarShipGridBuilderIntersectOption Enumeration | Settings that indicate how to search for objects that intersect the plane. |
| PlanarShipGridBuilderLabelDisplayOption Enumeration | Settings that indicate what grid lines should be labelled. |
Property Detail¶
BasePlane¶
-
PlanarShipGridBuilder.BasePlane¶ Returns or sets the base plane where the planar ship grid is created.
-------------------------------------Getter Method
Signature
BasePlaneReturns: Return type: NXOpen.DatumPlaneNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
BasePlaneParameters: basePlane ( NXOpen.DatumPlane) –New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
IntersectType¶
-
PlanarShipGridBuilder.IntersectType¶ Returns or sets the value that determines how to find objects that intersect the plane.
-------------------------------------Getter Method
Signature
IntersectTypeReturns: Return type: NXOpen.Display.PlanarShipGridBuilderIntersectOptionNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
IntersectTypeParameters: intersectType ( NXOpen.Display.PlanarShipGridBuilderIntersectOption) –New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LabelColor¶
-
PlanarShipGridBuilder.LabelColor¶ Returns or sets the grid line label color.
Only used if the color is not inherited from the intersected plane.
-------------------------------------Getter Method
Signature
LabelColorReturns: Return type: Id New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LabelColorParameters: labelColor (Id) – New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LabelDisplayType¶
-
PlanarShipGridBuilder.LabelDisplayType¶ Returns or sets the setting that indicates what grid lines are to be labelled.
-------------------------------------Getter Method
Signature
LabelDisplayTypeReturns: Return type: NXOpen.Display.PlanarShipGridBuilderLabelDisplayOptionNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LabelDisplayTypeParameters: labelDisplayType ( NXOpen.Display.PlanarShipGridBuilderLabelDisplayOption) –New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LabelSettingInheritted¶
-
PlanarShipGridBuilder.LabelSettingInheritted¶ Returns or sets the setting that indicates whether the grid line label will inherit the intersected plane’s color
-------------------------------------Getter Method
Signature
LabelSettingInherittedReturns: Return type: bool New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LabelSettingInherittedParameters: labelSettingInheritted (bool) – New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LineColor¶
-
PlanarShipGridBuilder.LineColor¶ Returns or sets the grid line color.
Only used if the color is not inherited from the intersected plane.
-------------------------------------Getter Method
Signature
LineColorReturns: Return type: Id New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LineColorParameters: lineColor (Id) – New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LineFontType¶
-
PlanarShipGridBuilder.LineFontType¶ Returns or sets the grid line font.
Only used if the font is not inherited from the intersected plane.
-------------------------------------Getter Method
Signature
LineFontTypeReturns: Return type: NXOpen.DisplayableObjectObjectFontNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LineFontTypeParameters: lineFontType ( NXOpen.DisplayableObjectObjectFont) –New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LineSettingInheritted¶
-
PlanarShipGridBuilder.LineSettingInheritted¶ Returns or sets the setting that indicates whether the grid line will inherit the intersected plane’s color/font/width.
-------------------------------------Getter Method
Signature
LineSettingInherittedReturns: Return type: bool New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LineSettingInherittedParameters: lineSettingInheritted (bool) – New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
LineWidthType¶
-
PlanarShipGridBuilder.LineWidthType¶ Returns or sets the grid line width.
Only used if the width is not inherited from the intersected plane.
-------------------------------------Getter Method
Signature
LineWidthTypeReturns: Return type: NXOpen.DisplayableObjectObjectWidthNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
-------------------------------------Setter Method
Signature
LineWidthTypeParameters: lineWidthType ( NXOpen.DisplayableObjectObjectWidth) –New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
Method Detail¶
GetExtent¶
-
PlanarShipGridBuilder.GetExtent¶ Get corner points of the grid extent.
The extent is a rectangle. The four points: point1, point2, point3, point4 are in clockwise or counterclockwise direction.
Signature
GetExtent()Returns: a tuple Return type: A tuple consisting of (valid, point1, point2, point3, point4). valid is a bool. Flag indicating whether the corner points are valid point1 is a NXOpen.Point3d. First corner point point2 is aNXOpen.Point3d. Second corner point point3 is aNXOpen.Point3d. Third corner point point4 is aNXOpen.Point3d. Fourth corner pointNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
GetIntersectedObjects¶
-
PlanarShipGridBuilder.GetIntersectedObjects¶ Get the objects that were searched to find intersections with the plane.
Signature
GetIntersectedObjects()Returns: Array of intersected objects Return type: list of NXOpen.TaggedObjectNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
SetExtent¶
-
PlanarShipGridBuilder.SetExtent¶ Set corner points for the grid extent.
The extent is a rectangle. The four points: point1, point2, point3, point4 should be in clockwise or counterclockwise direction.
Signature
SetExtent(point1, point2, point3, point4)Parameters: - point1 (
NXOpen.Point3d) – First corner point - point2 (
NXOpen.Point3d) – Second corner point - point3 (
NXOpen.Point3d) – Third corner point - point4 (
NXOpen.Point3d) – Fourth corner point
Returns: Flag indicating whether the corner points are valid
Return type: bool
New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
- point1 (
SetIntersectedObjects¶
-
PlanarShipGridBuilder.SetIntersectedObjects¶ Set the objects that are to be searched to find intersections with the plane.
Signature
SetIntersectedObjects(intersectedObjects)Parameters: intersectedObjects (list of NXOpen.TaggedObject) – Array of intersected objectsNew in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
SwitchLabelLocationX¶
-
PlanarShipGridBuilder.SwitchLabelLocationX¶ Switch label location in X direction.
Signature
SwitchLabelLocationX()New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
SwitchLabelLocationY¶
-
PlanarShipGridBuilder.SwitchLabelLocationY¶ Switch label location in Y direction.
Signature
SwitchLabelLocationY()New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
SwitchLabelLocationZ¶
-
PlanarShipGridBuilder.SwitchLabelLocationZ¶ Switch label location in Z direction.
Signature
SwitchLabelLocationZ()New in version NX8.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”) OR nx_ship_detail (“Ship Detail Design”) OR nx_ship_basic (“Ship Basic Design”)
Validate¶
-
PlanarShipGridBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.