OrientationAngleMethodsBuilder Class

class NXOpen.Features.ShipDesign.OrientationAngleMethodsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

This class defines the method of angle definition used in the definition of the region’s orientation.

New in version NX9.0.0.

Properties

Property Description
AlignAt Returns or sets the indication if the region should be aligned with the adjacent region at the start of this region, or with the adjacent region at the end of this region.
AlignVector Returns or sets the vector used to calculate the angle by aligning to this vector.
AngleMethod Returns or sets the method used to calculate the angle.
AngleReference Returns or sets the object used to measure the angle from.
MountingAngle Returns the constant angle value to rotate from the given vector or reference object.
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

OrientationAngleMethodsBuilderAlignAtTypes Enumeration Is the angle to be aligned with the region adjacent to start of this region or adjacent to the end of this region.
OrientationAngleMethodsBuilderMethodTypes Enumeration Settings used to determine how the angle is defined.

Property Detail

AlignAt

OrientationAngleMethodsBuilder.AlignAt

Returns or sets the indication if the region should be aligned with the adjacent region at the start of this region, or with the adjacent region at the end of this region.

Only used when NXOpen.Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes is Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.PlanarAtAngle.

-------------------------------------

Getter Method

Signature AlignAt

Returns:
Return type:NXOpen.Features.ShipDesign.OrientationAngleMethodsBuilderAlignAtTypes

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AlignAt

Parameters:alignAt (NXOpen.Features.ShipDesign.OrientationAngleMethodsBuilderAlignAtTypes) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)

AlignVector

OrientationAngleMethodsBuilder.AlignVector

Returns or sets the vector used to calculate the angle by aligning to this vector.

Only used when AngleMethod is Features.ShipDesign.OrientationAngleMethodsBuilderMethodTypes.Vector.

-------------------------------------

Getter Method

Signature AlignVector

Returns:
Return type:NXOpen.Direction

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AlignVector

Parameters:alignVector (NXOpen.Direction) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)

AngleMethod

OrientationAngleMethodsBuilder.AngleMethod

Returns or sets the method used to calculate the angle.

-------------------------------------

Getter Method

Signature AngleMethod

Returns:
Return type:NXOpen.Features.ShipDesign.OrientationAngleMethodsBuilderMethodTypes

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AngleMethod

Parameters:angleMethod (NXOpen.Features.ShipDesign.OrientationAngleMethodsBuilderMethodTypes) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)

AngleReference

OrientationAngleMethodsBuilder.AngleReference

Returns or sets the object used to measure the angle from.

Only used when AngleMethod is Features.ShipDesign.OrientationAngleMethodsBuilderMethodTypes.Angle.

-------------------------------------

Getter Method

Signature AngleReference

Returns:
Return type:NXOpen.Plane

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AngleReference

Parameters:angleReference (NXOpen.Plane) –

New in version NX9.0.0.

License requirements: nx_ship_basic (“Ship Basic Design”) OR nx_ship_detail (“Ship Detail Design”)

MountingAngle

OrientationAngleMethodsBuilder.MountingAngle

Returns the constant angle value to rotate from the given vector or reference object.

-------------------------------------

Getter Method

Signature MountingAngle

Returns:
Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

Method Detail

Validate

OrientationAngleMethodsBuilder.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.