NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::ShipDesign::SectionDrawingBuilder Class Reference

This builder allows you to define the section drawing information. More...

Inheritance diagram for NXOpen::Features::ShipDesign::SectionDrawingBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SectionsPerDrawingOptions { SectionsPerDrawingOptionsSingle, SectionsPerDrawingOptionsMultiple }
 Settings to indicate the section per drawing. More...
 
enum  ViewsPerSheetOptions {
  ViewsPerSheetOptionsOne, ViewsPerSheetOptionsTwo, ViewsPerSheetOptionsThree, ViewsPerSheetOptionsFour,
  ViewsPerSheetOptionsFive, ViewsPerSheetOptionsSix
}
 Settings to indicate the views per sheet. More...
 
enum  ViewTypeOptions { ViewTypeOptionsBasicDesign, ViewTypeOptionsDetailDesign }
 Settings to indicate the view type. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::DrawingPartBuilderCreateDrawingPartBuilder (NXOpen::Part *drawingPart)
 Creates a NXOpen::Features::ShipDesign::DrawingPartBuilder. More...
 
NXOpen::Features::ShipDesign::SectionViewBuilderCreateSectionViewBuilder ()
 Creates a NXOpen::Features::ShipDesign::SectionViewBuilder. More...
 
NXOpen::Features::ShipDesign::DrawingPartBuilderListDrawingPartList ()
 Returns the list of drawing parts in current NX session
Created in NX12.0.0. More...
 
std::vector< NXOpen::NXObject * > FindFocusPlates (NXOpen::NXObject *frame, double offset, double frontProximity, double backProximity)
 Returns a list of focus plates at the given position, this function just used when the frontProximity and backProximity has the same value. More...
 
std::vector< NXOpen::NXObject * > FindFocusPlates (NXOpen::NXObject *frame, NXOpen::Features::ShipDesign::SectionViewBuilder::DirectionOptions direction, double offset, double frontProximity, double backProximity)
 Returns a list of focus plates at the given position, this function is used when user want use different frontProximity and backProximity. More...
 
NXOpen::Features::ShipDesign::SectionDrawingBuilder::SectionsPerDrawingOptions SectionsPerDrawing ()
 Returns the sct per drawing
Created in NX10.0.0. More...
 
void SetSectionsPerDrawing (NXOpen::Features::ShipDesign::SectionDrawingBuilder::SectionsPerDrawingOptions sctPerDrawing)
 Sets the sct per drawing
Created in NX10.0.0. More...
 
void SetViewsPerSheet (NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewsPerSheetOptions sctPerDrawing)
 Sets the views per sheet
Created in NX10.0.0. More...
 
void SetViewType (NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewTypeOptions viewType)
 Sets the view type
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::SectionViewBuilderListViewList ()
 Returns the section view list
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewsPerSheetOptions ViewsPerSheet ()
 Returns the views per sheet
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewTypeOptions ViewType ()
 Returns the view type
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 section drawing information.

It represents NXOpen::Features::ShipDesign::SectionDrawingBuilder . This builder creates one or more Ship Section View and just returns NULL.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateSectionDrawingBuilder
Default values.

Property Value

SectionsPerDrawing

Multiple

ViewType

DetailDesign

ViewsPerSheet

One


Created in NX10.0.0.

Member Enumeration Documentation

Settings to indicate the section per drawing.

Enumerator
SectionsPerDrawingOptionsSingle 

single

SectionsPerDrawingOptionsMultiple 

multiple

Settings to indicate the views per sheet.

Enumerator
ViewsPerSheetOptionsOne 

one

ViewsPerSheetOptionsTwo 

two

ViewsPerSheetOptionsThree 

three

ViewsPerSheetOptionsFour 

four

ViewsPerSheetOptionsFive 

five

ViewsPerSheetOptionsSix 

six

Settings to indicate the view type.

Enumerator
ViewTypeOptionsBasicDesign 

the view is created on basic design

ViewTypeOptionsDetailDesign 

the view is created on detail design

Member Function Documentation

NXOpen::Features::ShipDesign::DrawingPartBuilder* NXOpen::Features::ShipDesign::SectionDrawingBuilder::CreateDrawingPartBuilder ( NXOpen::Part drawingPart)

Creates a NXOpen::Features::ShipDesign::DrawingPartBuilder.

Returns

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
Parameters
drawingPartdrawingpart
NXOpen::Features::ShipDesign::SectionViewBuilder* NXOpen::Features::ShipDesign::SectionDrawingBuilder::CreateSectionViewBuilder ( )

Creates a NXOpen::Features::ShipDesign::SectionViewBuilder.

Returns

Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
NXOpen::Features::ShipDesign::DrawingPartBuilderList* NXOpen::Features::ShipDesign::SectionDrawingBuilder::DrawingPartList ( )

Returns the list of drawing parts in current NX session
Created in NX12.0.0.



License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Features::ShipDesign::SectionDrawingBuilder::FindFocusPlates ( NXOpen::NXObject frame,
double  offset,
double  frontProximity,
double  backProximity 
)

Returns a list of focus plates at the given position, this function just used when the frontProximity and backProximity has the same value.

Otherwise it just use the big value for both frontProximity and backProximity

Returns
the found focus plates
Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
Parameters
framethe frame or plane
offsetthe offset of view position to the plane
frontProximitythe proximity in front of the view
backProximitythe proximity at the back of the view
std::vector<NXOpen::NXObject *> NXOpen::Features::ShipDesign::SectionDrawingBuilder::FindFocusPlates ( NXOpen::NXObject frame,
NXOpen::Features::ShipDesign::SectionViewBuilder::DirectionOptions  direction,
double  offset,
double  frontProximity,
double  backProximity 
)

Returns a list of focus plates at the given position, this function is used when user want use different frontProximity and backProximity.

Returns
the found focus plates
Created in NX11.0.2.

License requirements : nx_ship_drafting ("Ship Drafting")
Parameters
framethe frame
directionthe direction of the view
offsetthe offset of view position to the plane
frontProximitythe proximity in front of the view
backProximitythe proximity at the back of the view
NXOpen::Features::ShipDesign::SectionDrawingBuilder::SectionsPerDrawingOptions NXOpen::Features::ShipDesign::SectionDrawingBuilder::SectionsPerDrawing ( )

Returns the sct per drawing
Created in NX10.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::SectionDrawingBuilder::SetSectionsPerDrawing ( NXOpen::Features::ShipDesign::SectionDrawingBuilder::SectionsPerDrawingOptions  sctPerDrawing)

Sets the sct per drawing
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sctPerDrawingsctperdrawing
void NXOpen::Features::ShipDesign::SectionDrawingBuilder::SetViewsPerSheet ( NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewsPerSheetOptions  sctPerDrawing)

Sets the views per sheet
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sctPerDrawingsctperdrawing
void NXOpen::Features::ShipDesign::SectionDrawingBuilder::SetViewType ( NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewTypeOptions  viewType)

Sets the view type
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
viewTypeviewtype
NXOpen::Features::ShipDesign::SectionViewBuilderList* NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewList ( )

Returns the section view list
Created in NX10.0.0.



License requirements : None

NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewsPerSheetOptions NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewsPerSheet ( )

Returns the views per sheet
Created in NX10.0.0.



License requirements : None

NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewTypeOptions NXOpen::Features::ShipDesign::SectionDrawingBuilder::ViewType ( )

Returns the view type
Created in NX10.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.