This builder allows you to define the general arrangement view information. More...

Inheritance diagram for NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder:

Public Types
enum	InheritedPMISourceOption { InheritedPMISourceOptionNoChange, InheritedPMISourceOptionNone, InheritedPMISourceOptionFromGARoot, InheritedPMISourceOptionFromGAContainer, InheritedPMISourceOptionFromGADrawing, InheritedPMISourceOptionFromSourcePart }
	Settings to indicate the Inherited PMI source type. More...

enum	ViewCreationType { ViewCreationTypeProjectView, ViewCreationTypeSectionView }
	Settings to indicate the view type when view direction is X. More...

enum	ViewDirectionType { ViewDirectionTypeXPositive, ViewDirectionTypeXNegative, ViewDirectionTypeYPositive, ViewDirectionTypeYNegative, ViewDirectionTypeZPositive, ViewDirectionTypeZNegative, ViewDirectionTypeDeck }
	Settings to indicate the view direction type. More...

Public Member Functions
NXOpen::Features::ShipDesign::DeckListBuilder *	Decks ()
	Returns the decks Created in NX12.0.0. More...

NXOpen::Drawings::DrawingSheet *	DrawingSheet ()
	Returns the drawing sheet which the view on Created in NX12.0.0. More...

NXOpen::NXObject *	EndFrame ()
	Returns the end frame Created in NX12.0.0. More...

NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::InheritedPMISourceOption	InheritedPMISource ()
	Returns the inherited source Created in NX12.0.0. More...

NXOpen::Drawings::ViewPlacementBuilder *	Placement ()
	Returns the view placement Created in NX12.0.0. More...

double	Scale ()
	Returns the view Scale Created in NX12.0.0. More...

NXOpen::SelectModelingViewList *	SelectedModelView ()
	Returns the list of selected Model View which are the source of PMI Created in NX12.0.0. More...

NXOpen::Features::ShipDesign::SelectStructuresBuilder *	SelectStructures ()
	Returns the selected structure Created in NX12.0.0. More...

void	SetDrawingSheet (NXOpen::Drawings::DrawingSheet *drawingSheet)
	Sets the drawing sheet which the view on Created in NX12.0.0. More...

void	SetEndFrame (NXOpen::NXObject *endFrame)
	Sets the end frame Created in NX12.0.0. More...

void	SetInheritedPMISource (NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::InheritedPMISourceOption inheritedPMISource)
	Sets the inherited source Created in NX12.0.0. More...

void	SetScale (double scale)
	Sets the view Scale Created in NX12.0.0. More...

void	SetSourcePart (NXOpen::TaggedObject *sourcePart)
	Sets the source part Created in NX12.0.0. More...

void	SetStartFrame (NXOpen::NXObject *startFrame)
	Sets the start frame Created in NX12.0.0. More...

void	SetViewCreation (NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewCreationType viewCreation)
	Sets the view creation type Created in NX12.0.0. More...

void	SetViewDirection (NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewDirectionType viewDirection)
	Sets the view direction Created in NX12.0.0. More...

void	SetViewName (const NXString &viewName)
	Sets the view name Created in NX12.0.0. More...

void	SetViewName (const char *viewName)
	Sets the view name Created in NX12.0.0. More...

void	SetViewPosition (double xPosition, double yPosition)
	Sets the view position on the drawing Created in NX12.0.0. More...

void	SetViewType (const NXString &viewType)
	Sets the view type Created in NX12.0.0. More...

void	SetViewType (const char *viewType)
	Sets the view type Created in NX12.0.0. More...

NXOpen::TaggedObject *	SourcePart ()
	Returns the source part Created in NX12.0.0. More...

NXOpen::NXObject *	StartFrame ()
	Returns the start frame Created in NX12.0.0. More...

NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewCreationType	ViewCreation ()
	Returns the view creation type Created in NX12.0.0. More...

NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewDirectionType	ViewDirection ()
	Returns the view direction Created in NX12.0.0. More...

NXString	ViewName ()
	Returns the view name Created in NX12.0.0. More...

NXString	ViewType ()
	Returns the view type Created in NX12.0.0. More...

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

This builder allows you to define the general arrangement view information.

It represents NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder . This builder creates one Ship General Arrangement View and return it.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateGeneralArrangementViewBuilder
Default values.

Property

Value

Placement.AlignmentMethod

Infer

Placement.AlignmentOption

ToView

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::InheritedPMISourceOption

Settings to indicate the Inherited PMI source type.

Enumerator
InheritedPMISourceOptionNoChange	do nothing about PMI, this option only work when edit genearl arrangement view
InheritedPMISourceOptionNone	none
InheritedPMISourceOptionFromGARoot	Copy PMI label from General Arrangement Root part.
InheritedPMISourceOptionFromGAContainer	Copy PMI label from General Arrangement Deck Container.
InheritedPMISourceOptionFromGADrawing	Copy PMI label from General Arrangement Drawing Root part.
InheritedPMISourceOptionFromSourcePart	Copy PMI label from the selected source part.

enum NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewCreationType

Settings to indicate the view type when view direction is X.

Enumerator
ViewCreationTypeProjectView	project view
ViewCreationTypeSectionView	section view

enum NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewDirectionType

Settings to indicate the view direction type.

Enumerator
ViewDirectionTypeXPositive	xpositive
ViewDirectionTypeXNegative	xnegative
ViewDirectionTypeYPositive	ypositive
ViewDirectionTypeYNegative	ynegative
ViewDirectionTypeZPositive	zpositive
ViewDirectionTypeZNegative	znegative
ViewDirectionTypeDeck	deck

Member Function Documentation

NXOpen::Features::ShipDesign::DeckListBuilder* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::Decks ( )

Returns the decks
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

NXOpen::Drawings::DrawingSheet* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::DrawingSheet ( )

Returns the drawing sheet which the view on
Created in NX12.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::EndFrame ( )

Returns the end frame
Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::InheritedPMISourceOption NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::InheritedPMISource ( )

Returns the inherited source
Created in NX12.0.0.

License requirements : None

NXOpen::Drawings::ViewPlacementBuilder* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::Placement ( )

Returns the view placement
Created in NX12.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::Scale ( )

Returns the view Scale
Created in NX12.0.0.

License requirements : None

NXOpen::SelectModelingViewList* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SelectedModelView ( )

Returns the list of selected Model View which are the source of PMI
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

NXOpen::Features::ShipDesign::SelectStructuresBuilder* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SelectStructures ( )

Returns the selected structure
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetDrawingSheet ( NXOpen::Drawings::DrawingSheet * drawingSheet )

Sets the drawing sheet which the view on
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

drawingSheet drawingsheet

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetEndFrame ( NXOpen::NXObject * endFrame )

Sets the end frame
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

endFrame endframe

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetInheritedPMISource ( NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::InheritedPMISourceOption inheritedPMISource )

Sets the inherited source
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

inheritedPMISource inheritedpmisource

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetScale ( double scale )

Sets the view Scale
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

scale scale

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetSourcePart ( NXOpen::TaggedObject * sourcePart )

Sets the source part
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

sourcePart sourcepart

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetStartFrame ( NXOpen::NXObject * startFrame )

Sets the start frame
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

startFrame startframe

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewCreation ( NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewCreationType viewCreation )

Sets the view creation type
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

viewCreation viewcreation

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewDirection ( NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewDirectionType viewDirection )

Sets the view direction
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

viewDirection viewdirection

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewName ( const NXString & viewName )

Sets the view name
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

viewName viewname

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewName ( const char * viewName )

Sets the view name
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

viewName viewname

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewPosition	(	double	xPosition,
		double	yPosition
	)

Sets the view position on the drawing
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

xPosition	xposition
yPosition	yposition

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewType ( const NXString & viewType )

Sets the view type
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

viewType viewtype

void NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SetViewType ( const char * viewType )

Sets the view type
Created in NX12.0.0.

License requirements : nx_ship_gen_arrange ("Ship General Arrangement")

Parameters

viewType viewtype

NXOpen::TaggedObject* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::SourcePart ( )

Returns the source part
Created in NX12.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::StartFrame ( )

Returns the start frame
Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewCreationType NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewCreation ( )

Returns the view creation type
Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewDirectionType NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewDirection ( )

Returns the view direction
Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewName ( )

Returns the view name
Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::GeneralArrangementViewBuilder::ViewType ( )

Returns the view type
Created in NX12.0.0.

License requirements : None

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

Features_ShipDesign_GeneralArrangementViewBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation