Represents the interface for navigator action classes
To obtain an instance of this class, refer to NXOpen::ShipDesign::ShipSession

Created in NX11.0.1. More...

Public Member Functions
void	ActiveNavigator (int index)
	Actives ship navigator. More...

void	ChangeNodeState (NXOpen::ShipDesign::NavigatorNode *tgTargetNode, int status)
	Change node state. More...

void	CopyNode (int index, const std::vector< NXOpen::ShipDesign::NavigatorNode * > &tgNodes)
	Copy navigator node. More...

NXOpen::ShipDesign::ShipNavigatorNodeBuilder *	CreateShipNavigatorNodeBuilder (bool isEdit, NXOpen::ShipDesign::NavigatorNode *tgNode)
	Creates a NXOpen::ShipDesign::ShipNavigatorNodeBuilder . More...

void	CutNode (int index, const std::vector< NXOpen::ShipDesign::NavigatorNode * > &tgNodes)
	Cut navigator node. More...

void	EditFeature (NXOpen::Features::Feature *tgFeat)
	Edit feature. More...

NXOpen::ShipDesign::Navigator *	GetNavigator (int index)
	Gets ship navigator. More...

int	GetNavigatorCount ()
	Gets navigator count. More...

std::vector < NXOpen::ShipDesign::NavigatorNode * >	GetReferencingNodes (NXOpen::TaggedObject *tgReferencedObject)
	Gets all referencing navigator nodes. More...

NXOpen::ShipDesign::ShipNavigatorRoot *	GetShipNavigatorRoot ()
	Establish ship navigator root. More...

bool	IsNavigatorRegistered (int index)
	Checks if ship navigator is registered. More...

void	PasteNode (int index, NXOpen::ShipDesign::NavigatorNode *tgTargetNode)
	Paste navigator node. More...

void	PopulateAndPrintShipNavigator (NXOpen::BasePart *displayPart)
	Populates and prints data for each navigator found. More...

void	RefreshNavigator (int index)
	Loads navigator models. More...

void	RegisterNavigator (int index, const NXString &bitmap, const NXString &tooltip, const NXString &name)
	Registers the navigator. More...

void	RegisterNavigator (int index, const char bitmap, const char tooltip, const char *name)
	Registers the navigator. More...

void	RemoveNodes (int index, const std::vector< NXOpen::ShipDesign::NavigatorNode * > &tgNodes)
	Remove navigator nodes. More...

void	ReparentNode (int index, NXOpen::ShipDesign::NavigatorNode tgTargetNode, NXOpen::ShipDesign::NavigatorNode tgSourceNode)
	Reparent navigator node. More...

void	ReparentNodes (int index, NXOpen::ShipDesign::NavigatorNode tgTargetNode, const std::vector< NXOpen::ShipDesign::NavigatorNode > &tgNodes)
	Reparent navigator nodes. More...

void	SaveConfigureFile (int index)
	Saves the configure file. More...

void	SendToSubView (int index, NXOpen::ShipDesign::NavigatorNode *tgTargetNode)
	Send node to sub view. More...

void	SetActiveNode (int index, NXOpen::ShipDesign::NavigatorNode *tgTargetNode)
	Set selected node as active node. More...

void	SetNodeName (NXOpen::ShipDesign::NavigatorNode *tgTargetNode, const NXString &name)
	Set node name. More...

void	SetNodeName (NXOpen::ShipDesign::NavigatorNode tgTargetNode, const char name)
	Set node name. More...

NXOpen::ShipDesign::Navigator *	ShowNavigator (int index, const NXString &bitmap, const NXString &tooltip, const NXString &name)
	Shows the navigator. More...

NXOpen::ShipDesign::Navigator *	ShowNavigator (int index, const char bitmap, const char tooltip, const char *name)
	Shows the navigator. More...

tag_t	Tag () const
	Returns the tag of this object. More...

void	UnloadPartAndItsChildren (NXOpen::BasePart *partTag)
	Unloads part and its children. More...

void	UnregisterNavigator (int index)
	Unregisters the navigator. More...

Detailed Description

Represents the interface for navigator action classes
To obtain an instance of this class, refer to NXOpen::ShipDesign::ShipSession

Created in NX11.0.1.

Member Function Documentation

void NXOpen::ShipDesign::NavigatorCollection::ActiveNavigator ( int index )

Actives ship navigator.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index ship navigator id

void NXOpen::ShipDesign::NavigatorCollection::ChangeNodeState	(	NXOpen::ShipDesign::NavigatorNode *	tgTargetNode,
		int	status
	)

Change node state.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

tgTargetNode	tgtargetnode
status	status

void NXOpen::ShipDesign::NavigatorCollection::CopyNode	(	int	index,
		const std::vector< NXOpen::ShipDesign::NavigatorNode * > &	tgNodes
	)

Copy navigator node.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgNodes	tgnodes

NXOpen::ShipDesign::ShipNavigatorNodeBuilder* NXOpen::ShipDesign::NavigatorCollection::CreateShipNavigatorNodeBuilder	(	bool	isEdit,
		NXOpen::ShipDesign::NavigatorNode *	tgNode
	)

Creates a NXOpen::ShipDesign::ShipNavigatorNodeBuilder .

Returns: Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

isEdit	isedit
tgNode	tgnode

void NXOpen::ShipDesign::NavigatorCollection::CutNode	(	int	index,
		const std::vector< NXOpen::ShipDesign::NavigatorNode * > &	tgNodes
	)

Cut navigator node.

Created in NX12.0.0.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgNodes	tgnodes

void NXOpen::ShipDesign::NavigatorCollection::EditFeature ( NXOpen::Features::Feature * tgFeat )

Edit feature.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

tgFeat NXOpen::Features::Feature to be edited

NXOpen::ShipDesign::Navigator* NXOpen::ShipDesign::NavigatorCollection::GetNavigator ( int index )

Gets ship navigator.

Returns: Created in NX11.0.2.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index ship navigator id

int NXOpen::ShipDesign::NavigatorCollection::GetNavigatorCount ( )

Gets navigator count.

Returns: Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

std::vector<NXOpen::ShipDesign::NavigatorNode *> NXOpen::ShipDesign::NavigatorCollection::GetReferencingNodes ( NXOpen::TaggedObject * tgReferencedObject )

Gets all referencing navigator nodes.

Returns: Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

tgReferencedObject tgreferencedobject

NXOpen::ShipDesign::ShipNavigatorRoot* NXOpen::ShipDesign::NavigatorCollection::GetShipNavigatorRoot ( )

Establish ship navigator root.

Returns: Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

bool NXOpen::ShipDesign::NavigatorCollection::IsNavigatorRegistered ( int index )

Checks if ship navigator is registered.

Returns: Created in NX11.0.2.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index index

void NXOpen::ShipDesign::NavigatorCollection::PasteNode	(	int	index,
		NXOpen::ShipDesign::NavigatorNode *	tgTargetNode
	)

Paste navigator node.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgTargetNode	tgtargetnode

void NXOpen::ShipDesign::NavigatorCollection::PopulateAndPrintShipNavigator ( NXOpen::BasePart * displayPart )

Populates and prints data for each navigator found.

Created in NX11.0.2.

License requirements : None

Parameters

displayPart part being validated

void NXOpen::ShipDesign::NavigatorCollection::RefreshNavigator ( int index )

Loads navigator models.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index ship navigator id

void NXOpen::ShipDesign::NavigatorCollection::RegisterNavigator	(	int	index,
		const NXString &	bitmap,
		const NXString &	tooltip,
		const NXString &	name
	)

Registers the navigator.

Created in NX11.0.2.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	index
bitmap	bitmap
tooltip	tooltip
name	name

void NXOpen::ShipDesign::NavigatorCollection::RegisterNavigator	(	int	index,
		const char *	bitmap,
		const char *	tooltip,
		const char *	name
	)

Registers the navigator.

Created in NX11.0.2.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	index
bitmap	bitmap
tooltip	tooltip
name	name

void NXOpen::ShipDesign::NavigatorCollection::RemoveNodes	(	int	index,
		const std::vector< NXOpen::ShipDesign::NavigatorNode * > &	tgNodes
	)

Remove navigator nodes.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgNodes	tgnodes

void NXOpen::ShipDesign::NavigatorCollection::ReparentNode	(	int	index,
		NXOpen::ShipDesign::NavigatorNode *	tgTargetNode,
		NXOpen::ShipDesign::NavigatorNode *	tgSourceNode
	)

Reparent navigator node.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgTargetNode	tgtargetnode
tgSourceNode	tgsourcenode

void NXOpen::ShipDesign::NavigatorCollection::ReparentNodes	(	int	index,
		NXOpen::ShipDesign::NavigatorNode *	tgTargetNode,
		const std::vector< NXOpen::ShipDesign::NavigatorNode * > &	tgNodes
	)

Reparent navigator nodes.

Created in NX11.0.2.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgTargetNode	tgtargetnode
tgNodes	tgnodes

void NXOpen::ShipDesign::NavigatorCollection::SaveConfigureFile ( int index )

Saves the configure file.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index ship navigator id

void NXOpen::ShipDesign::NavigatorCollection::SendToSubView	(	int	index,
		NXOpen::ShipDesign::NavigatorNode *	tgTargetNode
	)

Send node to sub view.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgTargetNode	tgtargetnode

void NXOpen::ShipDesign::NavigatorCollection::SetActiveNode	(	int	index,
		NXOpen::ShipDesign::NavigatorNode *	tgTargetNode
	)

Set selected node as active node.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	ship navigator id
tgTargetNode	tgtargetnode

void NXOpen::ShipDesign::NavigatorCollection::SetNodeName	(	NXOpen::ShipDesign::NavigatorNode *	tgTargetNode,
		const NXString &	name
	)

Set node name.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

tgTargetNode	tgtargetnode
name	name

void NXOpen::ShipDesign::NavigatorCollection::SetNodeName	(	NXOpen::ShipDesign::NavigatorNode *	tgTargetNode,
		const char *	name
	)

Set node name.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

tgTargetNode	tgtargetnode
name	name

NXOpen::ShipDesign::Navigator* NXOpen::ShipDesign::NavigatorCollection::ShowNavigator	(	int	index,
		const NXString &	bitmap,
		const NXString &	tooltip,
		const NXString &	name
	)

Shows the navigator.

Returns: Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	index
bitmap	bitmap
tooltip	tooltip
name	name

NXOpen::ShipDesign::Navigator* NXOpen::ShipDesign::NavigatorCollection::ShowNavigator	(	int	index,
		const char *	bitmap,
		const char *	tooltip,
		const char *	name
	)

Shows the navigator.

Returns: Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index	index
bitmap	bitmap
tooltip	tooltip
name	name

tag_t NXOpen::ShipDesign::NavigatorCollection::Tag ( ) const

Returns the tag of this object.

void NXOpen::ShipDesign::NavigatorCollection::UnloadPartAndItsChildren ( NXOpen::BasePart * partTag )

Unloads part and its children.

Created in NX11.0.1.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

partTag parttag

void NXOpen::ShipDesign::NavigatorCollection::UnregisterNavigator ( int index )

Unregisters the navigator.

Created in NX11.0.2.

License requirements : nx_ship_basic ("Ship Basic Design")

Parameters

index index

The documentation for this class was generated from the following file:

ShipDesign_NavigatorCollection.hxx

Public Member Functions

Detailed Description

Member Function Documentation