Represents the ship standard part item builder. More...

Inheritance diagram for NXOpen::Features::ShipDesign::StandardPartItemBuilder:

Public Types
enum	Direction { DirectionFore, DirectionAft, DirectionUp, DirectionDown, DirectionPort, DirectionStarboard, DirectionIn, DirectionOut, DirectionCenter }
	Represents the ship standard part installation direction and thickness direction. More...

Public Member Functions
void	AddAcrossObject (NXOpen::DisplayableObject *acrossObject)
	Adds the specific object to the across object list.

void	AddDeselectedAcrossObject (NXOpen::DisplayableObject *acrossObject)
	Adds the specific object to the deselected across object list.

bool	CheckScallopSize ()
	Checks the scallop size by enabling the predefined requirement check inside the standard part, and resets to original state afterwards.

void	ConvertReferenceGeometry (int index, NXOpen::DisplayableObject *selObj)
	Converts the selected reference geometry.

NXOpen::SelectDisplayableObject *	FifthObject ()
	Returns the fifth selected object.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	FirstChainInstallDirection ()
	Returns the flag to indicate whether to flip the direction of the first selected chain object or not.

NXOpen::ScCollector *	FirstChainObject ()
	Returns the first chain selected object.

NXOpen::SelectDisplayableObject *	FirstObject ()
	Returns the first selected object.

NXOpen::SelectDisplayableObject *	FirstPlane ()
	Returns the first selected plane.

NXOpen::SelectDisplayableObject *	FourthObject ()
	Returns the fourth selected object.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	InstallFifthDirection ()
	Returns the flag to indicate whether to flip the direction of the fifth selected object or not.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	InstallFirstDirection ()
	Returns the flag to indicate whether to flip the direction of the first selected object or not.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	InstallFourthDirection ()
	Returns the flag to indicate whether to flip the direction of the fourth selected object or not.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	InstallSecondDirection ()
	Returns the flag to indicate whether to flip the direction of the second selected object or not.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	InstallThirdDirection ()
	Returns the flag to indicate whether to flip the direction of the third selected object or not.

NXString	LookupRegistration ()
	Checks the registration context string when an object is selected.

void	RemoveAcrossObject (NXOpen::DisplayableObject *acrossObject)
	Removes the specific object from the across object list.

void	RemoveDeselectedAcrossObject (NXOpen::DisplayableObject *acrossObject)
	Removes the specific object from the deselected across object list.

void	ResetItem ()
	Resets the standard part item builder to its intial state.

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction	SecondChainInstallDirection ()
	Returns the flag to indicate whether to flip the direction of the second selected chain object or not.

NXOpen::ScCollector *	SecondChainObject ()
	Returns the second chain selected object.

NXOpen::SelectDisplayableObject *	SecondObject ()
	Returns the second selected object.

NXOpen::SelectDisplayableObject *	SecondPlane ()
	Returns the second selected plane.

void	SetFirstChainInstallDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction firstChainInstallDirection)
	Sets the flag to indicate whether to flip the direction of the first selected chain object or not.

void	SetInstallFifthDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction fifthDirectionInstall)
	Sets the flag to indicate whether to flip the direction of the fifth selected object or not.

void	SetInstallFirstDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction firstDirectionInstall)
	Sets the flag to indicate whether to flip the direction of the first selected object or not.

void	SetInstallFourthDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction fourthDirectionInstall)
	Sets the flag to indicate whether to flip the direction of the fourth selected object or not.

void	SetInstallSecondDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction secondDirectionInstall)
	Sets the flag to indicate whether to flip the direction of the second selected object or not.

void	SetInstallThirdDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction thirdDirectionInstall)
	Sets the flag to indicate whether to flip the direction of the third selected object or not.

void	SetOptionalGeometry (NXOpen::DisplayableObject *selectedGeometry)
	Sets one geometry for input selection which has multiple options.

void	SetSecondChainInstallDirection (NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction secondChainInstallDirection)
	Sets the flag to indicate whether to flip the direction of the second selected chain object or not.

void	SetTransitionGeometry (int index, NXOpen::DisplayableObject *transitionGeometry)
	Sets the transition geometry given the index.

NXOpen::SelectDisplayableObject *	ThirdObject ()
	Returns the third selected object.

void	UpdateReferences (bool bToUpdateGeometry)
	Updates and relinks the external references.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

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

Detailed Description

Represents the ship standard part item builder.

This class cannot be directly instantiated and has to be created by CreateStandardPartItem.

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction

Represents the ship standard part installation direction and thickness direction.

Enumerator:

DirectionFore	fore
DirectionAft	aft
DirectionUp	up
DirectionDown	down
DirectionPort	port
DirectionStarboard	starboard
DirectionIn	in
DirectionOut	out
DirectionCenter	center

Member Function Documentation

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::AddAcrossObject ( NXOpen::DisplayableObject * acrossObject )

Adds the specific object to the across object list.

Created in NX9.0.0.

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

Parameters

acrossObject body, face or curve entity.

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::AddDeselectedAcrossObject ( NXOpen::DisplayableObject * acrossObject )

Adds the specific object to the deselected across object list.

Created in NX9.0.0.

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

Parameters

acrossObject body, face or curve.

bool NXOpen::Features::ShipDesign::StandardPartItemBuilder::CheckScallopSize ( )

Checks the scallop size by enabling the predefined requirement check inside the standard part, and resets to original state afterwards.

If there is no vialation of the requirement, nothing will happen.

Returns: Created in NX8.0.0.

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

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::ConvertReferenceGeometry	(	int	index,
		NXOpen::DisplayableObject *	selObj
	)

Converts the selected reference geometry.

For instance stiffener curve, which represents stiffener body, into an equivalent reference geometry such as molding face, opposing molding face, top face.

Created in NX9.0.0.

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

Parameters

index	index
selObj	selobj

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::FifthObject ( )

Returns the fifth selected object.

Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::FirstChainInstallDirection ( )

Returns the flag to indicate whether to flip the direction of the first selected chain object or not.

Created in NX9.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::StandardPartItemBuilder::FirstChainObject ( )

Returns the first chain selected object.

Created in NX8.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::FirstObject ( )

Returns the first selected object.

Created in NX8.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::FirstPlane ( )

Returns the first selected plane.

Created in NX8.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::FourthObject ( )

Returns the fourth selected object.

Created in NX8.0.0.

License requirements : None

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::InstallFifthDirection ( )

Returns the flag to indicate whether to flip the direction of the fifth selected object or not.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::InstallFirstDirection ( )

Returns the flag to indicate whether to flip the direction of the first selected object or not.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::InstallFourthDirection ( )

Returns the flag to indicate whether to flip the direction of the fourth selected object or not.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::InstallSecondDirection ( )

Returns the flag to indicate whether to flip the direction of the second selected object or not.

Created in NX8.5.0.

License requirements : None

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::InstallThirdDirection ( )

Returns the flag to indicate whether to flip the direction of the third selected object or not.

Created in NX8.5.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::StandardPartItemBuilder::LookupRegistration ( )

Checks the registration context string when an object is selected.

        @return

Created in NX8.0.0.

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

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::RemoveAcrossObject ( NXOpen::DisplayableObject * acrossObject )

Removes the specific object from the across object list.

Created in NX9.0.0.

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

Parameters

acrossObject body, face or curve.

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::RemoveDeselectedAcrossObject ( NXOpen::DisplayableObject * acrossObject )

Removes the specific object from the deselected across object list.

Created in NX9.0.0.

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

Parameters

acrossObject body, face or curve.

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::ResetItem ( )

Resets the standard part item builder to its intial state.

Created in NX8.5.0.

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

NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction NXOpen::Features::ShipDesign::StandardPartItemBuilder::SecondChainInstallDirection ( )

Returns the flag to indicate whether to flip the direction of the second selected chain object or not.

Created in NX9.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::ShipDesign::StandardPartItemBuilder::SecondChainObject ( )

Returns the second chain selected object.

Created in NX8.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::SecondObject ( )

Returns the second selected object.

Created in NX8.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::SecondPlane ( )

Returns the second selected plane.

Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetFirstChainInstallDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction firstChainInstallDirection )

Sets the flag to indicate whether to flip the direction of the first selected chain object or not.

Created in NX9.0.0.

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

Parameters

firstChainInstallDirection firstchaininstalldirection

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetInstallFifthDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction fifthDirectionInstall )

Sets the flag to indicate whether to flip the direction of the fifth selected object or not.

Created in NX8.5.0.

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

Parameters

fifthDirectionInstall fifthdirectioninstall

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetInstallFirstDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction firstDirectionInstall )

Sets the flag to indicate whether to flip the direction of the first selected object or not.

Created in NX8.5.0.

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

Parameters

firstDirectionInstall firstdirectioninstall

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetInstallFourthDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction fourthDirectionInstall )

Sets the flag to indicate whether to flip the direction of the fourth selected object or not.

Created in NX8.5.0.

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

Parameters

fourthDirectionInstall fourthdirectioninstall

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetInstallSecondDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction secondDirectionInstall )

Sets the flag to indicate whether to flip the direction of the second selected object or not.

Created in NX8.5.0.

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

Parameters

secondDirectionInstall seconddirectioninstall

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetInstallThirdDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction thirdDirectionInstall )

Sets the flag to indicate whether to flip the direction of the third selected object or not.

Created in NX8.5.0.

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

Parameters

thirdDirectionInstall thirddirectioninstall

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetOptionalGeometry ( NXOpen::DisplayableObject * selectedGeometry )

Sets one geometry for input selection which has multiple options.

Multiple options could come from selection configuration setting, or several geometries with the same attributes.

Created in NX8.0.0.

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

Parameters

selectedGeometry selectedgeometry

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetSecondChainInstallDirection ( NXOpen::Features::ShipDesign::StandardPartItemBuilder::Direction secondChainInstallDirection )

Sets the flag to indicate whether to flip the direction of the second selected chain object or not.

Created in NX9.0.0.

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

Parameters

secondChainInstallDirection secondchaininstalldirection

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::SetTransitionGeometry	(	int	index,
		NXOpen::DisplayableObject *	transitionGeometry
	)

Sets the transition geometry given the index.

Created in NX8.5.0.

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

Parameters

index	index
transitionGeometry	transitiongeometry

NXOpen::SelectDisplayableObject* NXOpen::Features::ShipDesign::StandardPartItemBuilder::ThirdObject ( )

Returns the third selected object.

Created in NX8.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::StandardPartItemBuilder::UpdateReferences ( bool bToUpdateGeometry )

Updates and relinks the external references.

bToUpdateGeometry is used to decide if the input geometries need to be recalculated.

Created in NX8.0.0.

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

Parameters

bToUpdateGeometry btoupdategeometry

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

Features_ShipDesign_StandardPartItemBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation