ShipDesignPreferencesBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ShipDesignPreferencesBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder
which is used to change default object display settings for ship structures.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateShipDesignPreferencesBuilder()
Default values.
Property Value AnalysisSpacing 100 AngleRule RightHand ColorOption Default Layer 0 SurfaceAngleFailureLimit 20 SurfaceAngleWarningLimit 10 TwistRateFailureLimit 3 TwistRateWarningLimit 1 New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AnalysisSpacing | Returns or sets the distance between points on the path used to check twist rate or surface angle. |
AngleRule | Returns or sets the indication of how angles are to be measured. |
Color | Returns or sets the default color to use for the current ship structure type, only used if the ColorOption is NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderColorType.Set . |
ColorOption | Returns or sets the color option of the current ship structure type. |
Font | Returns or sets the default font to use for the current ship structure type. |
Layer | Returns or sets the default layer to use for the current ship structure type. |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
ShipStructureType | Returns or sets the ship structure type. |
SurfaceAngleAcceptableColor | Returns or sets the surface angle acceptable color. |
SurfaceAngleFailureColor | Returns or sets the surface angle failure color. |
SurfaceAngleFailureLimit | Returns or sets the surface angle failure limit. |
SurfaceAngleWarningColor | Returns or sets the surface angle warning color. |
SurfaceAngleWarningLimit | Returns or sets the surface angle warning limit. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TwistRateAcceptableColor | Returns or sets the twist rate acceptable color. |
TwistRateFailureColor | Returns or sets the twist rate failure color. |
TwistRateFailureLimit | Returns or sets the twist rate failure limit. |
TwistRateWarningColor | Returns or sets the twist rate warning color. |
TwistRateWarningLimit | Returns or sets the twist rate warning limit. |
Type | Returns or sets the ship structure type. |
Width | Returns or sets the default width to use for the current ship structure type. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ShipDesignPreferencesBuilderAngleRuleTypes Enumeration | The methods that can be used to measure angles in ship design. |
ShipDesignPreferencesBuilderColorType Enumeration | the color option type |
ShipDesignPreferencesBuilderTypes Enumeration | This enum represents the ship structure types. |
Property Detail¶
AnalysisSpacing¶
-
ShipDesignPreferencesBuilder.
AnalysisSpacing
¶ Returns or sets the distance between points on the path used to check twist rate or surface angle.
-------------------------------------
Getter Method
Signature
AnalysisSpacing()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnalysisSpacing(analysisSpacing)
Parameters: analysisSpacing (float) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
AngleRule¶
-
ShipDesignPreferencesBuilder.
AngleRule
¶ Returns or sets the indication of how angles are to be measured.
-------------------------------------
Getter Method
Signature
AngleRule()
Returns: Return type: NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderAngleRuleTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleRule(angleRule)
Parameters: angleRule ( NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderAngleRuleTypes
) –New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Color¶
-
ShipDesignPreferencesBuilder.
Color
¶ Returns or sets the default color to use for the current ship structure type, only used if the ColorOption is
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderColorType.Set
.-------------------------------------
Getter Method
Signature
Color()
Returns: Return type: Id New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Color(color)
Parameters: color (Id) – New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
ColorOption¶
-
ShipDesignPreferencesBuilder.
ColorOption
¶ Returns or sets the color option of the current ship structure type.
-------------------------------------
Getter Method
Signature
ColorOption()
Returns: Return type: NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderColorType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ColorOption(colorOption)
Parameters: colorOption ( NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderColorType
) –New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Font¶
-
ShipDesignPreferencesBuilder.
Font
¶ Returns or sets the default font to use for the current ship structure type.
-------------------------------------
Getter Method
Signature
Font()
Returns: Return type: NXOpen.Preferences.PartObjectLineFontType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Font(font)
Parameters: font ( NXOpen.Preferences.PartObjectLineFontType
) –New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Layer¶
-
ShipDesignPreferencesBuilder.
Layer
¶ Returns or sets the default layer to use for the current ship structure type.
-------------------------------------
Getter Method
Signature
Layer()
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Layer(layer)
Parameters: layer (int) – New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
ShipStructureType¶
-
ShipDesignPreferencesBuilder.
ShipStructureType
¶ Returns or sets the ship structure type.
Any subsequent calls to
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorOption()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorOption()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Color()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Color()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Font()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Font()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Width()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Width()
,NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Layer()
orNXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Layer()
will affect the settings for this ship structure type.-------------------------------------
Getter Method
Signature
ShipStructureType()
Returns: Return type: NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShipStructureType(type)
Parameters: type ( NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderTypes
) –New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
SurfaceAngleAcceptableColor¶
-
ShipDesignPreferencesBuilder.
SurfaceAngleAcceptableColor
¶ Returns or sets the surface angle acceptable color.
All analysis that has a angle from the surface normal to the web lower than the surface angle warning limit will be displayed in this color.
-------------------------------------
Getter Method
Signature
SurfaceAngleAcceptableColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SurfaceAngleAcceptableColor(surfaceAngleAcceptableColor)
Parameters: surfaceAngleAcceptableColor (Id) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
SurfaceAngleFailureColor¶
-
ShipDesignPreferencesBuilder.
SurfaceAngleFailureColor
¶ Returns or sets the surface angle failure color.
All analysis that has a angle between the surface normal and the web exceeding the surface angle failure limit will be displayed in this color.
-------------------------------------
Getter Method
Signature
SurfaceAngleFailureColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SurfaceAngleFailureColor(surfaceAngleFailureColor)
Parameters: surfaceAngleFailureColor (Id) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
SurfaceAngleFailureLimit¶
-
ShipDesignPreferencesBuilder.
SurfaceAngleFailureLimit
¶ Returns or sets the surface angle failure limit.
If the angle between the surface normal and the web exceeds this value the analysis will be display with the surface angle failure color.
-------------------------------------
Getter Method
Signature
SurfaceAngleFailureLimit()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SurfaceAngleFailureLimit(surfaceAngleFailureLimit)
Parameters: surfaceAngleFailureLimit (float) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
SurfaceAngleWarningColor¶
-
ShipDesignPreferencesBuilder.
SurfaceAngleWarningColor
¶ Returns or sets the surface angle warning color.
All analysis that has a angle between the surface normal and the web exceeding the surface angle warning limit will be displayed in this color.
-------------------------------------
Getter Method
Signature
SurfaceAngleWarningColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SurfaceAngleWarningColor(surfaceAngleWarningColor)
Parameters: surfaceAngleWarningColor (Id) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
SurfaceAngleWarningLimit¶
-
ShipDesignPreferencesBuilder.
SurfaceAngleWarningLimit
¶ Returns or sets the surface angle warning limit.
If the angle between the surface normal and the web exceeds this value the analysis will be display with the surface angle warning color.
-------------------------------------
Getter Method
Signature
SurfaceAngleWarningLimit()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SurfaceAngleWarningLimit(surfaceAngleWarningLimit)
Parameters: surfaceAngleWarningLimit (float) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TwistRateAcceptableColor¶
-
ShipDesignPreferencesBuilder.
TwistRateAcceptableColor
¶ Returns or sets the twist rate acceptable color.
All analysis that has a twist rate lower than the twist rate warning limit will be displayed in this color.
-------------------------------------
Getter Method
Signature
TwistRateAcceptableColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TwistRateAcceptableColor(twistRateAcceptableColor)
Parameters: twistRateAcceptableColor (Id) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TwistRateFailureColor¶
-
ShipDesignPreferencesBuilder.
TwistRateFailureColor
¶ Returns or sets the twist rate failure color.
All analysis that exceeds the twist rate failure limit will be displayed using this color.
-------------------------------------
Getter Method
Signature
TwistRateFailureColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TwistRateFailureColor(twistRateFailureColor)
Parameters: twistRateFailureColor (Id) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TwistRateFailureLimit¶
-
ShipDesignPreferencesBuilder.
TwistRateFailureLimit
¶ Returns or sets the twist rate failure limit.
If the twist rate exceeds this value the analysis will be display with the twist rate failure color.
-------------------------------------
Getter Method
Signature
TwistRateFailureLimit()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TwistRateFailureLimit(twistRateFailureLimit)
Parameters: twistRateFailureLimit (float) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TwistRateWarningColor¶
-
ShipDesignPreferencesBuilder.
TwistRateWarningColor
¶ Returns or sets the twist rate warning color.
All analysis that exceeds the twist rate warning limit will be displayed using this color.
-------------------------------------
Getter Method
Signature
TwistRateWarningColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TwistRateWarningColor(twistRateWarningColor)
Parameters: twistRateWarningColor (Id) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
TwistRateWarningLimit¶
-
ShipDesignPreferencesBuilder.
TwistRateWarningLimit
¶ Returns or sets the twist rate warning limit.
If the twist rate exceeds this value the analysis will be display with the twist rate warning color.
-------------------------------------
Getter Method
Signature
TwistRateWarningLimit()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TwistRateWarningLimit(twistRateWarningLimit)
Parameters: twistRateWarningLimit (float) – New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Type¶
-
ShipDesignPreferencesBuilder.
Type
¶ Returns or sets the ship structure type.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderTypes
New in version NX8.0.0.
Deprecated since version NX9.0.0: Get the active ship structure using
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ShipStructureType()
.License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilderTypes
) –New in version NX8.0.0.
Deprecated since version NX9.0.0: Set the active ship structure using
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ShipStructureType()
.License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Width¶
-
ShipDesignPreferencesBuilder.
Width
¶ Returns or sets the default width to use for the current ship structure type.
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: NXOpen.Preferences.PartObjectWidthType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Width(width)
Parameters: width ( NXOpen.Preferences.PartObjectWidthType
) –New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Method Detail¶
Validate¶
-
ShipDesignPreferencesBuilder.
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.