NavigatorCollection Class — NXOpen Python API Reference 12.0.0 documentation

# NavigatorCollection Class

class `NXOpen.ShipDesign.``NavigatorCollection`

  Bases: `object`

  Represents the interface for navigator action classes

  To obtain an instance of this class, refer to `NXOpen.ShipDesign.ShipSession`

  New in version NX11.0.1.

# Methods

Method | Description
--- | ---
ActiveNavigator | Actives ship navigator.
ChangeNodeState | Change node state.
CopyNode | Copy navigator node.
CreateShipNavigatorNodeBuilder | Creates a `NXOpen.ShipDesign.ShipNavigatorNodeBuilder`.
CutNode | Cut navigator node.
EditFeature | Edit feature.
GetNavigator | Gets ship navigator.
GetNavigatorCount | Gets navigator count.
GetReferencingNodes | Gets all referencing navigator nodes.
GetShipNavigatorRoot | Establish ship navigator root
IsNavigatorRegistered | Checks if ship navigator is registered.
PasteNode | Paste navigator node.
PopulateAndPrintShipNavigator | Populates and prints data for each navigator found.
RefreshNavigator | Loads navigator models.
RegisterNavigator | Registers the navigator.
RemoveNodes | Remove navigator nodes.
ReparentNode | Reparent navigator node.
ReparentNodes | Reparent navigator nodes.
SaveConfigureFile | Saves the configure file.
SendToSubView | Send node to sub view.
SetActiveNode | Set selected node as active node.
SetNodeName | Set node name.
ShowNavigator | Shows the navigator.
UnloadPartAndItsChildren | Unloads part and its children.
UnregisterNavigator | Unregisters the navigator.

# Method Detail

## ActiveNavigator

`NavigatorCollection.``ActiveNavigator`

  Actives ship navigator.

  Signature `ActiveNavigator(index)`

  Parameters: | index (int) – ship navigator id

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## ChangeNodeState

`NavigatorCollection.``ChangeNodeState`

  Change node state.

  Signature `ChangeNodeState(tgTargetNode, status)`

  Parameters:

  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –
  - status (int) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## CopyNode

`NavigatorCollection.``CopyNode`

  Copy navigator node.

  Signature `CopyNode(index, tgNodes)`

  Parameters:

  - index (int) – ship navigator id
  - tgNodes (list of `NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## CreateShipNavigatorNodeBuilder

`NavigatorCollection.``CreateShipNavigatorNodeBuilder`

  Creates a `NXOpen.ShipDesign.ShipNavigatorNodeBuilder`.

  Signature `CreateShipNavigatorNodeBuilder(isEdit, tgNode)`

  Parameters:

  - isEdit (bool) –
  - tgNode (`NXOpen.ShipDesign.NavigatorNode`) –

  Returns: |
  Return type: | `NXOpen.ShipDesign.ShipNavigatorNodeBuilder`

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## CutNode

`NavigatorCollection.``CutNode`

  Cut navigator node.

  Signature `CutNode(index, tgNodes)`

  Parameters:

  - index (int) – ship navigator id
  - tgNodes (list of `NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX12.0.0.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## EditFeature

`NavigatorCollection.``EditFeature`

  Edit feature.

  Signature `EditFeature(tgFeat)`

  Parameters: | tgFeat (`NXOpen.Features.Feature`) – `NXOpen.Features.Feature` to be edited

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## GetNavigator

`NavigatorCollection.``GetNavigator`

  Gets ship navigator.

  Signature `GetNavigator(index)`

  Parameters: | index (int) – ship navigator id
  Returns: |
  Return type: | `NXOpen.ShipDesign.Navigator`

  New in version NX11.0.2.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## GetNavigatorCount

`NavigatorCollection.``GetNavigatorCount`

  Gets navigator count.

  Signature `GetNavigatorCount()`

  Returns: |
  Return type: | int

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## GetReferencingNodes

`NavigatorCollection.``GetReferencingNodes`

  Gets all referencing navigator nodes.

  Signature `GetReferencingNodes(tgReferencedObject)`

  Parameters: | tgReferencedObject (`NXOpen.TaggedObject`) –
  Returns: |
  Return type: | list of `NXOpen.ShipDesign.NavigatorNode`

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## GetShipNavigatorRoot

`NavigatorCollection.``GetShipNavigatorRoot`

  Establish ship navigator root

  Signature `GetShipNavigatorRoot()`

  Returns: |
  Return type: | `NXOpen.ShipDesign.ShipNavigatorRoot`

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## IsNavigatorRegistered

`NavigatorCollection.``IsNavigatorRegistered`

  Checks if ship navigator is registered.

  Signature `IsNavigatorRegistered(index)`

  Parameters: | index (int) –
  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## PasteNode

`NavigatorCollection.``PasteNode`

  Paste navigator node.

  Signature `PasteNode(index, tgTargetNode)`

  Parameters:

  - index (int) – ship navigator id
  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## PopulateAndPrintShipNavigator

`NavigatorCollection.``PopulateAndPrintShipNavigator`

  Populates and prints data for each navigator found.

  Signature `PopulateAndPrintShipNavigator(displayPart)`

  Parameters: | displayPart (`NXOpen.BasePart`) – part being validated

  New in version NX11.0.2.

  License requirements: None.

## RefreshNavigator

`NavigatorCollection.``RefreshNavigator`

  Loads navigator models.

  Signature `RefreshNavigator(index)`

  Parameters: | index (int) – ship navigator id

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## RegisterNavigator

`NavigatorCollection.``RegisterNavigator`

  Registers the navigator.

  Signature `RegisterNavigator(index, bitmap, tooltip, name)`

  Parameters:

  - index (int) –
  - bitmap (str) –
  - tooltip (str) –
  - name (str) –

  New in version NX11.0.2.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## RemoveNodes

`NavigatorCollection.``RemoveNodes`

  Remove navigator nodes.

  Signature `RemoveNodes(index, tgNodes)`

  Parameters:

  - index (int) – ship navigator id
  - tgNodes (list of `NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## ReparentNode

`NavigatorCollection.``ReparentNode`

  Reparent navigator node.

  Signature `ReparentNode(index, tgTargetNode, tgSourceNode)`

  Parameters:

  - index (int) – ship navigator id
  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –
  - tgSourceNode (`NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## ReparentNodes

`NavigatorCollection.``ReparentNodes`

  Reparent navigator nodes.

  Signature `ReparentNodes(index, tgTargetNode, tgNodes)`

  Parameters:

  - index (int) – ship navigator id
  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –
  - tgNodes (list of `NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.2.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SaveConfigureFile

`NavigatorCollection.``SaveConfigureFile`

  Saves the configure file.

  Signature `SaveConfigureFile(index)`

  Parameters: | index (int) – ship navigator id

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SendToSubView

`NavigatorCollection.``SendToSubView`

  Send node to sub view.

  Signature `SendToSubView(index, tgTargetNode)`

  Parameters:

  - index (int) – ship navigator id
  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SetActiveNode

`NavigatorCollection.``SetActiveNode`

  Set selected node as active node.

  Signature `SetActiveNode(index, tgTargetNode)`

  Parameters:

  - index (int) – ship navigator id
  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## SetNodeName

`NavigatorCollection.``SetNodeName`

  Set node name.

  Signature `SetNodeName(tgTargetNode, name)`

  Parameters:

  - tgTargetNode (`NXOpen.ShipDesign.NavigatorNode`) –
  - name (str) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## ShowNavigator

`NavigatorCollection.``ShowNavigator`

  Shows the navigator.

  Signature `ShowNavigator(index, bitmap, tooltip, name)`

  Parameters:

  - index (int) –
  - bitmap (str) –
  - tooltip (str) –
  - name (str) –

  Returns: |
  Return type: | `NXOpen.ShipDesign.Navigator`

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## UnloadPartAndItsChildren

`NavigatorCollection.``UnloadPartAndItsChildren`

  Unloads part and its children.

  Signature `UnloadPartAndItsChildren(partTag)`

  Parameters: | partTag (`NXOpen.BasePart`) –

  New in version NX11.0.1.

  License requirements: nx_ship_basic (“Ship Basic Design”)

## UnregisterNavigator

`NavigatorCollection.``UnregisterNavigator`

  Unregisters the navigator.

  Signature `UnregisterNavigator(index)`

  Parameters: | index (int) –

  New in version NX11.0.2.

  License requirements: nx_ship_basic (“Ship Basic Design”)