OrientationRegionItemBuilder Class

class NXOpen.Features.ShipDesign.OrientationRegionItemBuilder

Bases: NXOpen.Builder

This class defines each region of the orientation.

To create a new instance of this class, use NXOpen.Features.ShipDesign.OrientationDefinitionBuilder.CreateNewRegion()

New in version NX9.0.0.

Properties

Property Description
AngleMethods Returns the angle definition for the region’s orientation.
EndAngleMethods Returns the angle definition for the end of this region’s orientation.
EndPointMethods Returns the boundary definition at the end of this region.
OrientationMethod Returns or sets the orientation method used to define the direction of the web for this region.
StartAngleMethods Returns the angle definition for the start of this region’s orientation.
StartPointMethods Returns the boundary definition at the start of this region.
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.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

OrientationRegionItemBuilderOrientationMethodTypes Enumeration Settings to indicate how the web orientation is defined for this region.

Property Detail

AngleMethods

OrientationRegionItemBuilder.AngleMethods

Returns the angle definition for the region’s orientation.

Only used when OrientationMethod is Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.NormalToSurface, Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.Orthogonal, Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.AlongVector, or Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.PlanarAtAngle

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

Getter Method

Signature AngleMethods

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

New in version NX9.0.0.

License requirements: None.

EndAngleMethods

OrientationRegionItemBuilder.EndAngleMethods

Returns the angle definition for the end of this region’s orientation.

Only used when OrientationMethod is Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.LinearTwist, of Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.CubicTwist.

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

Getter Method

Signature EndAngleMethods

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

New in version NX9.0.0.

License requirements: None.

EndPointMethods

OrientationRegionItemBuilder.EndPointMethods

Returns the boundary definition at the end of this region.

Note this is NULL for the last region. The object output is the same as the start of the following region.

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

Getter Method

Signature EndPointMethods

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

New in version NX9.0.0.

License requirements: None.

OrientationMethod

OrientationRegionItemBuilder.OrientationMethod

Returns or sets the orientation method used to define the direction of the web for this region.

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

Getter Method

Signature OrientationMethod

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

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature OrientationMethod

Parameters:orientationMethod (NXOpen.Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes) –

New in version NX9.0.0.

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

StartAngleMethods

OrientationRegionItemBuilder.StartAngleMethods

Returns the angle definition for the start of this region’s orientation.

Only used when OrientationMethod is Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.LinearTwist, of Features.ShipDesign.OrientationRegionItemBuilderOrientationMethodTypes.CubicTwist.

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

Getter Method

Signature StartAngleMethods

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

New in version NX9.0.0.

License requirements: None.

StartPointMethods

OrientationRegionItemBuilder.StartPointMethods

Returns the boundary definition at the start of this region.

Note this is NULL for the first region. The object output is the same as the end of the previous region.

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

Getter Method

Signature StartPointMethods

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

New in version NX9.0.0.

License requirements: None.

Method Detail

Validate

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