OrientationDefinitionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# OrientationDefinitionBuilder Class

class `NXOpen.Features.ShipDesign.``OrientationDefinitionBuilder`

  Bases: `NXOpen.Builder`

  This class defines the top level object for use in definining the orientation of stiffeners and edge reinforcements.

  This object allows you to define regions of a profile and allows you to define a different method of orientation for each region. To create a new instance of this class, use `NXOpen.Features.ShipCollection.CreateOrientationDefinitionBuilder()`

  Default values.

  Property | Value
  --- | ---
  MeasureAngles | NormaltoCurve
  ShowSurfaceAngles | 0
  ShowTwistRate | 0
  ShowWebAngles | 0

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AngleTolerance | Returns or sets the angle tolerance used in the orientation objects to determine if vectors are parallel.
DistanceTolerance | Returns or sets the distance tolerance used in the orientation objects to determine if locations are coincident.
MeasureAngles | Returns or sets the method in which to measure angles in the orientation objects.
NewRegionPoint | Returns the new region point or datum that will be used for the boundary of the new region.
PlacementSide | Returns or sets the side of the placement faces the stiffener is to be placed upon.
RegionItemData | Returns the regionItem builder.
RegionList | Returns the list containing all the defined regions.
ShowSurfaceAngles | Returns or sets the indication if the surface angles analysis display is on or off.
ShowTwistRate | Returns or sets the indication if the twist rate analysis display is on or off.
ShowWebAngles | Returns or sets the indication if the web angle analysis display is on or off.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateNewRegion | Creates a new region on the landing curve to allow you to change the orientation for this area of the landing curve.
CreatePathCurve | Sets the landing curve that is being processed into the builder.
CreateRegionsAtFrames | Will create new regions at each frame.
DeleteRegion | Deletes a previously created region.
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.
GetNextRegion | Gets the next region to the current one.
GetObject | Returns the object currently being edited by this builder.
SetAnglesNormal | Will set all angle values of input regions so that web is normal to surface.
SetPlacementFaces | Sets the faces or datum that are being processed into the 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

OrientationDefinitionBuilderMeasureAngleTypes Enumeration | Settings to indicate how angles are measured in all orientation objects.
OrientationDefinitionBuilderPlacementSideTypes Enumeration | Settings to indicate which side of the placement faces the stiffener is to be placed.

# Property Detail

## AngleTolerance

`OrientationDefinitionBuilder.``AngleTolerance`

  Returns or sets the angle tolerance used in the orientation objects to determine if vectors are parallel.

  `-------------------------------------`

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AngleTolerance`

  Parameters: | tolerance (float) –

  New in version NX9.0.0.

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

## DistanceTolerance

`OrientationDefinitionBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance used in the orientation objects to determine if locations are coincident.

  `-------------------------------------`

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | tolerance (float) –

  New in version NX9.0.0.

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

## MeasureAngles

`OrientationDefinitionBuilder.``MeasureAngles`

  Returns or sets the method in which to measure angles in the orientation objects.

  `-------------------------------------`

  Getter Method

  Signature `MeasureAngles`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.OrientationDefinitionBuilderMeasureAngleTypes`

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MeasureAngles`

  Parameters: | measureAngles (`NXOpen.Features.ShipDesign.OrientationDefinitionBuilderMeasureAngleTypes`) –

  New in version NX9.0.0.

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

## NewRegionPoint

`OrientationDefinitionBuilder.``NewRegionPoint`

  Returns the new region point or datum that will be used for the boundary of the new region.

  `-------------------------------------`

  Getter Method

  Signature `NewRegionPoint`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX9.0.0.

  License requirements: None.

## PlacementSide

`OrientationDefinitionBuilder.``PlacementSide`

  Returns or sets the side of the placement faces the stiffener is to be placed upon.

  `-------------------------------------`

  Getter Method

  Signature `PlacementSide`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.OrientationDefinitionBuilderPlacementSideTypes`

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlacementSide`

  Parameters: | placementSide (`NXOpen.Features.ShipDesign.OrientationDefinitionBuilderPlacementSideTypes`) –

  New in version NX9.0.0.

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

## RegionItemData

`OrientationDefinitionBuilder.``RegionItemData`

  Returns the regionItem builder.

  `-------------------------------------`

  Getter Method

  Signature `RegionItemData`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`

  New in version NX9.0.0.

  License requirements: None.

## RegionList

`OrientationDefinitionBuilder.``RegionList`

  Returns the list containing all the defined regions.

  `-------------------------------------`

  Getter Method

  Signature `RegionList`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.OrientationRegionItemBuilderList`

  New in version NX9.0.0.

  License requirements: None.

## ShowSurfaceAngles

`OrientationDefinitionBuilder.``ShowSurfaceAngles`

  Returns or sets the indication if the surface angles analysis display is on or off.

  `-------------------------------------`

  Getter Method

  Signature `ShowSurfaceAngles`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShowSurfaceAngles`

  Parameters: | showSurfaceAngles (bool) –

  New in version NX9.0.0.

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

## ShowTwistRate

`OrientationDefinitionBuilder.``ShowTwistRate`

  Returns or sets the indication if the twist rate analysis display is on or off.

  `-------------------------------------`

  Getter Method

  Signature `ShowTwistRate`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShowTwistRate`

  Parameters: | showTwistRate (bool) –

  New in version NX9.0.0.

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

## ShowWebAngles

`OrientationDefinitionBuilder.``ShowWebAngles`

  Returns or sets the indication if the web angle analysis display is on or off.

  `-------------------------------------`

  Getter Method

  Signature `ShowWebAngles`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShowWebAngles`

  Parameters: | showWebAngles (bool) –

  New in version NX9.0.0.

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

# Method Detail

## CreateNewRegion

`OrientationDefinitionBuilder.``CreateNewRegion`

  Creates a new region on the landing curve to allow you to change the orientation for this area of the landing curve.

  Signature `CreateNewRegion(regionPoint)`

  Parameters: | regionPoint (`NXOpen.NXObject`) – New region boundary point
  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`

  New in version NX9.0.0.

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

## CreatePathCurve

`OrientationDefinitionBuilder.``CreatePathCurve`

  Sets the landing curve that is being processed into the builder.

  If regions have already been defined the closest point on this new curve to the region boundaries will be used for the new region boundaries when the boundary has been defined by a specified point otherwise the boundary definition will be reevaluated for this new curve and the boundary set appropriately.

  Signature `CreatePathCurve(curves)`

  Parameters: | curves (list of `NXOpen.NXObject`) – The curves defining the path of the profile that is being oriented.

  New in version NX9.0.0.

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

## CreateRegionsAtFrames

`OrientationDefinitionBuilder.``CreateRegionsAtFrames`

  Will create new regions at each frame.

  Signature `CreateRegionsAtFrames()`

  Returns: | The regions created.
  Return type: | list of `NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`

  New in version NX9.0.0.

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

## DeleteRegion

`OrientationDefinitionBuilder.``DeleteRegion`

  Deletes a previously created region.

  The deleted region will be combined with the previous region.

  Signature `DeleteRegion(region)`

  Parameters: | region (`NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`) –

  New in version NX9.0.0.

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

## GetNextRegion

`OrientationDefinitionBuilder.``GetNextRegion`

  Gets the next region to the current one.

  Signature `GetNextRegion(region)`

  Parameters: | region (`NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`) –
  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`

  New in version NX9.0.0.

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

## SetAnglesNormal

`OrientationDefinitionBuilder.``SetAnglesNormal`

  Will set all angle values of input regions so that web is normal to surface.

  Signature `SetAnglesNormal(regions)`

  Parameters: | regions (list of `NXOpen.Features.ShipDesign.OrientationRegionItemBuilder`) – The regions to process.

  New in version NX9.0.0.

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

## SetPlacementFaces

`OrientationDefinitionBuilder.``SetPlacementFaces`

  Sets the faces or datum that are being processed into the builder.

  Signature `SetPlacementFaces(faces)`

  Parameters: | faces (list of `NXOpen.DisplayableObject`) – The faces/datums defining the placement of the profile that is being oriented.

  New in version NX9.0.0.

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

## Validate

`OrientationDefinitionBuilder.``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.