OrientationPointMethodsBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
OrientationPointMethodsBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
This class is used to define the boundary of the regions when definining the orientation of a profile.
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
Distance | Returns the distance used to determine the boundary of the region. |
MeasureAlong | Returns or sets the indication of how to measure the distance used to determine the boundary of the region. |
PointMethod | Returns or sets the method used to define the boundary. |
Reference | Returns the object used to measure the distance from to determine the boundary of the region. |
SpecifyPoint | Returns or sets the point used to determine the boundary of the region. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
OrientationPointMethodsBuilderMeasureAlongTypes Enumeration | Settings to indicate how the distance is measured. |
OrientationPointMethodsBuilderPointMethodTypes Enumeration | Settings to indicate how the boundary is defined. |
Property Detail¶
Distance¶
-
OrientationPointMethodsBuilder.
Distance
¶ Returns the distance used to determine the boundary of the region.
Only used when PointMethod is
Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.ByDistance
,Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.FromStart
, orFeatures.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.FromEnd
.-------------------------------------
Getter Method
Signature
Distance()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
MeasureAlong¶
-
OrientationPointMethodsBuilder.
MeasureAlong
¶ Returns or sets the indication of how to measure the distance used to determine the boundary of the region.
Only used when PointMethod is
Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.ByDistance
,Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.FromStart
, orFeatures.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.FromEnd
.-------------------------------------
Getter Method
Signature
MeasureAlong()
Returns: Return type: NXOpen.Features.ShipDesign.OrientationPointMethodsBuilderMeasureAlongTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MeasureAlong(measureAlong)
Parameters: measureAlong ( NXOpen.Features.ShipDesign.OrientationPointMethodsBuilderMeasureAlongTypes
) –New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
PointMethod¶
-
OrientationPointMethodsBuilder.
PointMethod
¶ Returns or sets the method used to define the boundary.
-------------------------------------
Getter Method
Signature
PointMethod()
Returns: Return type: NXOpen.Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PointMethod(pointMethod)
Parameters: pointMethod ( NXOpen.Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes
) –New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Reference¶
-
OrientationPointMethodsBuilder.
Reference
¶ Returns the object used to measure the distance from to determine the boundary of the region.
Only used when PointMethod is
Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.ByDistance
.-------------------------------------
Getter Method
Signature
Reference()
Returns: Return type: NXOpen.SelectNXObject
New in version NX9.0.0.
License requirements: None.
SpecifyPoint¶
-
OrientationPointMethodsBuilder.
SpecifyPoint
¶ Returns or sets the point used to determine the boundary of the region.
Only used when PointMethod is
Features.ShipDesign.OrientationPointMethodsBuilderPointMethodTypes.ByPoint
.-------------------------------------
Getter Method
Signature
SpecifyPoint()
Returns: Return type: NXOpen.Point
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpecifyPoint(specifyPoint)
Parameters: specifyPoint ( NXOpen.Point
) –New in version NX9.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)
Method Detail¶
Validate¶
-
OrientationPointMethodsBuilder.
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.