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

It represents NXOpen::Features::ShipDesign::SectionViewBuilder . More...

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

Public Types

enum  DirectionOptions {
  DirectionOptionsFw, DirectionOptionsAf, DirectionOptionsIn, DirectionOptionsOt,
  DirectionOptionsP, DirectionOptionsS, DirectionOptionsUp, DirectionOptionsDn
}
 Settings to indicate the view direction. More...
 
enum  PlaneTypes { PlaneTypesX, PlaneTypesY, PlaneTypesZ, PlaneTypesUserSpecified }
 Settings to indicate the plane type. More...
 
enum  SectionRuleOptions { SectionRuleOptionsByRule, SectionRuleOptionsSimpleSection }
 Settings to indicate the section rule. More...
 
enum  SymmetricalStructureOptions { SymmetricalStructureOptionsFull, SymmetricalStructureOptionsPort, SymmetricalStructureOptionsStarboard }
 Settings to indicate to show symmetrical structure. More...
 

Public Member Functions

NXOpen::SelectNXObjectListAdditionalStructures ()
 Returns the additional structures to be sectioned. More...
 
double BackProximity ()
 Returns the back proximity value
Created in NX11.0.0. More...
 
NXString DrawingName ()
 Returns the drawing name
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::DrawingSheetBuilderDrawingSheet ()
 Returns the sheet on which to create this view. More...
 
NXOpen::Features::ShipDesign::DrawingTemplateBuilderDrawingTemplate ()
 Returns the drawing template builder, which represents a NXOpen::Features::ShipDesign::DrawingTemplateBuilder . More...
 
bool FlipViewDirection ()
 Returns the option to specify whether to flip the view direction or not
Created in NX10.0.0. More...
 
double FrontProximity ()
 Returns the front proximity value
Created in NX11.0.0. More...
 
NXOpen::Features::ShipDesign::SectionViewBuilder::DirectionOptions GetViewDirection ()
 Gets the view direction. More...
 
NXOpen::SelectNXObjectListHiddenObjects ()
 Returns the hidden object
More...
 
double Offset ()
 Returns the offset value
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::SectionViewBuilder::PlaneTypes PlaneType ()
 Returns the frame type
Created in NX10.0.0. More...
 
NXOpen::PlaneSectionPlane ()
 Returns the section plane
Created in NX10.0.0. More...
 
NXString SectionPlaneName ()
 Returns the section plane name
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::SectionViewBuilder::SectionRuleOptions SectionRule ()
 Returns the section rule
Created in NX10.0.0. More...
 
NXOpen::SelectDatumPlaneListSelectFrame ()
 Returns the select frame
Created in NX10.0.0. More...
 
void SetBackProximity (double backProximity)
 Sets the back proximity value
Created in NX11.0.0. More...
 
void SetDrawingName (const NXString &drawingName)
 Sets the drawing name
Created in NX10.0.0. More...
 
void SetDrawingName (const char *drawingName)
 Sets the drawing name
Created in NX10.0.0. More...
 
void SetDrawingSheet (NXOpen::Features::ShipDesign::DrawingSheetBuilder *drawingSheet)
 Sets the sheet on which to create this view. More...
 
void SetFlipViewDirection (bool flipViewDirection)
 Sets the option to specify whether to flip the view direction or not
Created in NX10.0.0. More...
 
void SetFrontProximity (double frontProximity)
 Sets the front proximity value
Created in NX11.0.0. More...
 
void SetOffset (double offset)
 Sets the offset value
Created in NX10.0.0. More...
 
void SetPlaneType (NXOpen::Features::ShipDesign::SectionViewBuilder::PlaneTypes frameType)
 Sets the frame type
Created in NX10.0.0. More...
 
void SetSectionPlane (NXOpen::Plane *sectionPlane)
 Sets the section plane
Created in NX10.0.0. More...
 
void SetSectionPlaneName (const NXString &sectionPlaneName)
 Sets the section plane name
Created in NX10.0.0. More...
 
void SetSectionPlaneName (const char *sectionPlaneName)
 Sets the section plane name
Created in NX10.0.0. More...
 
void SetSectionRule (NXOpen::Features::ShipDesign::SectionViewBuilder::SectionRuleOptions sectionRule)
 Sets the section rule
Created in NX10.0.0. More...
 
void SetSheetScale (double sheetScale)
 Sets the scale of the sheet. More...
 
void SetSymmetricalStructure (NXOpen::Features::ShipDesign::SectionViewBuilder::SymmetricalStructureOptions symmetricalStructure)
 Sets the symmetrical structure
Created in NX11.0.0. More...
 
void SetXPosition (double xPosition)
 Sets the ship section view X position
Created in NX11.0.0. More...
 
void SetYPosition (double yPosition)
 Sets the ship section view Y position
Created in NX11.0.0. More...
 
double SheetScale ()
 Returns the scale of the sheet. More...
 
NXOpen::Features::ShipDesign::ShipStructureBuilderShipStructure ()
 Returns the ship structure builder, which represents a NXOpen::Features::ShipDesign::ShipStructureBuilder . More...
 
NXOpen::Features::ShipDesign::SectionViewBuilder::SymmetricalStructureOptions SymmetricalStructure ()
 Returns the symmetrical structure
Created in NX11.0.0. More...
 
double XPosition ()
 Returns the ship section view X position
Created in NX11.0.0. More...
 
double YPosition ()
 Returns the ship section view Y position
Created in NX11.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

It represents NXOpen::Features::ShipDesign::SectionViewBuilder .

The builder is used to create a Ship Section View and returns NULL.
To create a new instance of this class, use NXOpen::Features::ShipDesign::SectionDrawingBuilder::CreateSectionViewBuilder

Created in NX10.0.0.

Member Enumeration Documentation

Settings to indicate the view direction.

Enumerator
DirectionOptionsFw 

fw

DirectionOptionsAf 

af

DirectionOptionsIn 

in

DirectionOptionsOt 

ot

DirectionOptionsP 

p

DirectionOptionsS 

s

DirectionOptionsUp 

up

DirectionOptionsDn 

dn

Settings to indicate the plane type.

Enumerator
PlaneTypesX 

x

PlaneTypesY 

y

PlaneTypesZ 

z

PlaneTypesUserSpecified 

user specified

Settings to indicate the section rule.

Enumerator
SectionRuleOptionsByRule 

by rule

SectionRuleOptionsSimpleSection 

simple section

Settings to indicate to show symmetrical structure.

Enumerator
SymmetricalStructureOptionsFull 

Show full section view of the bulkhead.

SymmetricalStructureOptionsPort 

Only show port side of the bulkhead section view.

SymmetricalStructureOptionsStarboard 

Only show starboard side of the bulkhead section view.

Member Function Documentation

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SectionViewBuilder::AdditionalStructures ( )

Returns the additional structures to be sectioned.


Deprecated:
Deprecated in NX11.0.0. Use Features::ShipDesign::ShipStructureBuilder .AdditionalStructures() instead.


Created in NX10.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::SectionViewBuilder::BackProximity ( )

Returns the back proximity value
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Features::ShipDesign::SectionViewBuilder::DrawingName ( )

Returns the drawing name
Created in NX10.0.0.



License requirements : None

NXOpen::Features::ShipDesign::DrawingSheetBuilder* NXOpen::Features::ShipDesign::SectionViewBuilder::DrawingSheet ( )

Returns the sheet on which to create this view.

The drawing sheet can be a new created drawing sheet or an existing drawing sheet.
Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::DrawingTemplateBuilder* NXOpen::Features::ShipDesign::SectionViewBuilder::DrawingTemplate ( )

Returns the drawing template builder, which represents a NXOpen::Features::ShipDesign::DrawingTemplateBuilder .


Created in NX10.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::SectionViewBuilder::FlipViewDirection ( )

Returns the option to specify whether to flip the view direction or not
Created in NX10.0.0.



License requirements : None

double NXOpen::Features::ShipDesign::SectionViewBuilder::FrontProximity ( )

Returns the front proximity value
Created in NX11.0.0.



License requirements : None

NXOpen::Features::ShipDesign::SectionViewBuilder::DirectionOptions NXOpen::Features::ShipDesign::SectionViewBuilder::GetViewDirection ( )

Gets the view direction.

Returns

Created in NX10.0.0.

License requirements : None
NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::SectionViewBuilder::HiddenObjects ( )

Returns the hidden object

Deprecated:
Deprecated in NX11.0.0.

Use Features::ShipDesign::ShipStructureBuilder .HiddenObjects() instead.


Created in NX10.0.0.

License requirements : None

double NXOpen::Features::ShipDesign::SectionViewBuilder::Offset ( )

Returns the offset value
Created in NX10.0.0.



License requirements : None

NXOpen::Features::ShipDesign::SectionViewBuilder::PlaneTypes NXOpen::Features::ShipDesign::SectionViewBuilder::PlaneType ( )

Returns the frame type
Created in NX10.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::SectionViewBuilder::SectionPlane ( )

Returns the section plane
Created in NX10.0.0.



License requirements : None

NXString NXOpen::Features::ShipDesign::SectionViewBuilder::SectionPlaneName ( )

Returns the section plane name
Created in NX10.0.0.



License requirements : None

NXOpen::Features::ShipDesign::SectionViewBuilder::SectionRuleOptions NXOpen::Features::ShipDesign::SectionViewBuilder::SectionRule ( )

Returns the section rule
Created in NX10.0.0.



License requirements : None

NXOpen::SelectDatumPlaneList* NXOpen::Features::ShipDesign::SectionViewBuilder::SelectFrame ( )

Returns the select frame
Created in NX10.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::SectionViewBuilder::SetBackProximity ( double  backProximity)

Sets the back proximity value
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
backProximitybackproximity
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetDrawingName ( const NXString drawingName)

Sets the drawing name
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
drawingNamedrawingname
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetDrawingName ( const char *  drawingName)

Sets the drawing name
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
drawingNamedrawingname
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetDrawingSheet ( NXOpen::Features::ShipDesign::DrawingSheetBuilder drawingSheet)

Sets the sheet on which to create this view.

The drawing sheet can be a new created drawing sheet or an existing drawing sheet.
Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
drawingSheetdrawingsheet
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetFlipViewDirection ( bool  flipViewDirection)

Sets the option to specify whether to flip the view direction or not
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
flipViewDirectionflipviewdirection
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetFrontProximity ( double  frontProximity)

Sets the front proximity value
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
frontProximityfrontproximity
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetOffset ( double  offset)

Sets the offset value
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
offsetoffset
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetPlaneType ( NXOpen::Features::ShipDesign::SectionViewBuilder::PlaneTypes  frameType)

Sets the frame type
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
frameTypeframetype
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetSectionPlane ( NXOpen::Plane sectionPlane)

Sets the section plane
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sectionPlanesectionplane
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetSectionPlaneName ( const NXString sectionPlaneName)

Sets the section plane name
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sectionPlaneNamesectionplanename
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetSectionPlaneName ( const char *  sectionPlaneName)

Sets the section plane name
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sectionPlaneNamesectionplanename
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetSectionRule ( NXOpen::Features::ShipDesign::SectionViewBuilder::SectionRuleOptions  sectionRule)

Sets the section rule
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sectionRulesectionrule
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetSheetScale ( double  sheetScale)

Sets the scale of the sheet.

The value should be great than zero.
Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
sheetScalesheetscale
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetSymmetricalStructure ( NXOpen::Features::ShipDesign::SectionViewBuilder::SymmetricalStructureOptions  symmetricalStructure)

Sets the symmetrical structure
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
symmetricalStructuresymmetricalstructure
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetXPosition ( double  xPosition)

Sets the ship section view X position
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
xPositionxposition
void NXOpen::Features::ShipDesign::SectionViewBuilder::SetYPosition ( double  yPosition)

Sets the ship section view Y position
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
yPositionyposition
double NXOpen::Features::ShipDesign::SectionViewBuilder::SheetScale ( )

Returns the scale of the sheet.

The value should be great than zero.
Created in NX11.0.0.

License requirements : None

NXOpen::Features::ShipDesign::ShipStructureBuilder* NXOpen::Features::ShipDesign::SectionViewBuilder::ShipStructure ( )

Returns the ship structure builder, which represents a NXOpen::Features::ShipDesign::ShipStructureBuilder .


Created in NX11.0.0.

License requirements : None

NXOpen::Features::ShipDesign::SectionViewBuilder::SymmetricalStructureOptions NXOpen::Features::ShipDesign::SectionViewBuilder::SymmetricalStructure ( )

Returns the symmetrical structure
Created in NX11.0.0.



License requirements : None

double NXOpen::Features::ShipDesign::SectionViewBuilder::XPosition ( )

Returns the ship section view X position
Created in NX11.0.0.



License requirements : None

double NXOpen::Features::ShipDesign::SectionViewBuilder::YPosition ( )

Returns the ship section view Y position
Created in NX11.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.