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

This builder allows you to define the section view information for ship drawing. 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...
 

Public Member Functions

NXOpen::SelectNXObjectListAdditionalStructures ()
 Returns the additional structures to be sectioned. More...
 
NXString DrawingName ()
 Returns the drawing name
Created in NX10.0.0. 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...
 
NXOpen::Features::ShipDesign::SectionViewBuilder::DirectionOptions GetViewDirection ()
 Gets the view direction. More...
 
NXOpen::SelectNXObjectListHiddenObjects ()
 Returns the hidden object
Created in NX10.0.0. 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 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 SetFlipViewDirection (bool flipViewDirection)
 Sets the option to specify whether to flip the view direction or not
Created in NX10.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...
 
- 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 view information for ship drawing.

It represents NXOpen::Features::ShipDesign::SectionViewBuilder
To create a new instance of this class, use NXOpen::Features::ShipDesign::SectionDrawingBuilder::CreateSectionViewBuilder
Default values.

Property Value

PlaneType

X

SectionRule

ByRule


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

Member Function Documentation

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

Returns the additional structures to be sectioned.


Created in NX10.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::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

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
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::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::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::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

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