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

Represents a NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder builder . More...

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

Public Member Functions

void AddAnnotationOfBracket (bool createBracketSymbol, NXOpen::Drawings::DraftingBody *draftingbody)
 Add annotation of bracket
Created in NX11.0.0. More...
 
void AddAnnotationOfEndCuts (bool createEndCutsSymbol, NXOpen::Drawings::DraftingBody *draftingBody)
 Add annotation of end cuts. More...
 
void AddAnnotationOfExpansionPlate (NXOpen::Drawings::DraftingView *tgView, NXOpen::NXObject *shipStructure, bool createScantlingAnnotation)
 Add annotation of expansion plate
Created in NX11.0.0. More...
 
void AddAnnotationOfExpansionStiffenerEndCuts (NXOpen::Drawings::DraftingView *tgView, NXOpen::NXObject *shipStructure, bool createEndCutsSymbol)
 Add annotation of expansion stiffener endcuts
Created in NX11.0.0. More...
 
void AddAnnotationOfExpansionStiffenerSturctureIdAndScantling (NXOpen::Drawings::DraftingView *tgView, NXOpen::NXObject *shipStructure, bool createIDAnnotation, bool createScantlingAnnotation)
 Add annotation of structure ID and scantling on Ship Expansion View
Created in NX11.0.0. More...
 
void AddAnnotationOfOpeningFillingLine (bool createOpeningFillingLine, NXOpen::Drawings::DraftingBody *draftingbody)
 Add annotation of opening filling line
Created in NX11.0.0. More...
 
void AddAnnotationOfSeamForDetailDesign (bool createSeamSymbol, NXOpen::Drawings::DraftingView *tgView, const std::vector< NXOpen::Drawings::DraftingBody * > &objects, NXOpen::Drawings::DraftingBody *selectedObjecty)
 Add annotation of seam symbol for detail design
Created in NX11.0.0. More...
 
void AddAnnotationOfStructureIdAndScantling (bool createIDAnnotation, bool createScantlingAnnotation, NXOpen::Drawings::DraftingBody *draftingBody)
 Add annotations of sturcture ID And scantling. More...
 
void AddFillingLineByChain (const std::vector< NXOpen::Drawings::DraftingCurve * > &curves, bool createChainAnnotation)
 Adds opening filling lines by curve chain method. More...
 
NXOpen::LineAddFillingLineByPoints (NXOpen::Point *spiderPoint, NXOpen::Point *strikingPoint)
 Adds opening filling lines by points method. More...
 
bool AddFillingLinesByModelBody (NXOpen::Drawings::DraftingBody *draftingbody, const std::vector< NXOpen::Drawings::DraftingCurve * > &curves)
 Adds opening filling lines by model body. More...
 
NXOpen::Annotations::TableSectionCreateTable ()
 Creates the Table. More...
 
void DeleteExistingAnnotations ()
 Deletes the existing annotations excluding the opening filling lines. More...
 
void DeleteLines (const std::vector< NXOpen::Drawings::DraftingCurve * > &curves)
 Deletes opening filling lines
Created in NX12.0.0. More...
 
void DeleteOpeningFillingLine (NXOpen::Line *line)
 Deletes the specific opening filling line. More...
 
int GetTableIndex ()
 Gets the table index. More...
 
NXOpen::NXObjectHandleAnnotationForBasicDesign (bool createIDAnnotation, bool createScantlingAnnotation, bool createEndCutsAnnotation, NXOpen::Drawings::DraftingCurve *draftingVDCurve, NXOpen::NXObject *shipEntity, NXOpen::Drawings::DraftingView *view)
 Creates ship annotations for basic design structures. More...
 
void HandleSeamForNonSectionedPlateForBasicDesign (bool createSeamSymbol, NXOpen::Drawings::DraftingCurve *draftingVDCurve, NXOpen::NXObject *tgCurve)
 Add annotation of seam symbol for non-sectioned plate for basic design
Created in NX11.0.0. More...
 
void HandleSeamForSectionedPlateForBasicDesign (bool createSeamSymbol, NXOpen::Drawings::DraftingBody *tgDraftingBody, const std::vector< NXOpen::Drawings::DraftingCurve * > &objects, NXOpen::Drawings::DraftingCurve *selectedObject)
 Add annotation of seam symbol for sectioned plate for basic design
Created in NX11.0.0. More...
 
void ModifyFillingLineByPoints (NXOpen::Point *spiderPoint, NXOpen::Point *strikingPoint, NXOpen::Line *line)
 Modifies the position of opening filling line, which is created by points method. More...
 
void SetPosition (const std::vector< double > &pos)
 Sets the table position
Created in NX12.0.0. More...
 
void SetTableIndex (int inx)
 Sets the table index
Created in NX12.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

Represents a NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder builder .

This builder returns NULL.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateInteractiveAnnotationBuilder

Created in NX11.0.0.

Member Function Documentation

void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfBracket ( bool  createBracketSymbol,
NXOpen::Drawings::DraftingBody draftingbody 
)

Add annotation of bracket
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createBracketSymbolcreatebracketsymbol
draftingbodydraftingbody
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfEndCuts ( bool  createEndCutsSymbol,
NXOpen::Drawings::DraftingBody draftingBody 
)

Add annotation of end cuts.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createEndCutsSymbolCreate End Cuts symbols or not
draftingBodydraftingbody
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfExpansionPlate ( NXOpen::Drawings::DraftingView tgView,
NXOpen::NXObject shipStructure,
bool  createScantlingAnnotation 
)

Add annotation of expansion plate
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
tgViewThe Ship Expansion View
shipStructureThe Ship Structure on that the annotation will create.
createScantlingAnnotationCreate Scantling Annotation or not
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfExpansionStiffenerEndCuts ( NXOpen::Drawings::DraftingView tgView,
NXOpen::NXObject shipStructure,
bool  createEndCutsSymbol 
)

Add annotation of expansion stiffener endcuts
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
tgViewThe Ship Expansion View
shipStructureThe Ship Structure on that the annotation will create.
createEndCutsSymbolCreate End Cuts Symbol or not
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfExpansionStiffenerSturctureIdAndScantling ( NXOpen::Drawings::DraftingView tgView,
NXOpen::NXObject shipStructure,
bool  createIDAnnotation,
bool  createScantlingAnnotation 
)

Add annotation of structure ID and scantling on Ship Expansion View
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
tgViewThe Ship Expansion View
shipStructureThe Ship Structure on that the annotation will create.
createIDAnnotationCreate ID annotation or not
createScantlingAnnotationCreate Scantling Annotation or not
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfOpeningFillingLine ( bool  createOpeningFillingLine,
NXOpen::Drawings::DraftingBody draftingbody 
)

Add annotation of opening filling line
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createOpeningFillingLinecreateopeningfillingline
draftingbodydraftingbody
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfSeamForDetailDesign ( bool  createSeamSymbol,
NXOpen::Drawings::DraftingView tgView,
const std::vector< NXOpen::Drawings::DraftingBody * > &  objects,
NXOpen::Drawings::DraftingBody selectedObjecty 
)

Add annotation of seam symbol for detail design
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createSeamSymbolcreateseamsymbol
tgViewtgview
objectsobjects
selectedObjectyselectedobjecty
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddAnnotationOfStructureIdAndScantling ( bool  createIDAnnotation,
bool  createScantlingAnnotation,
NXOpen::Drawings::DraftingBody draftingBody 
)

Add annotations of sturcture ID And scantling.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createIDAnnotationCreate ID annotation or not
createScantlingAnnotationCreate Scantling annotation or not
draftingBodydraftingbody
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddFillingLineByChain ( const std::vector< NXOpen::Drawings::DraftingCurve * > &  curves,
bool  createChainAnnotation 
)

Adds opening filling lines by curve chain method.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
curvesShip drafting curves
createChainAnnotationCreate Chain Annotation or not
NXOpen::Line* NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddFillingLineByPoints ( NXOpen::Point spiderPoint,
NXOpen::Point strikingPoint 
)

Adds opening filling lines by points method.

Returns
Create line by points
Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")
Parameters
spiderPointspider point
strikingPointstriking point
bool NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::AddFillingLinesByModelBody ( NXOpen::Drawings::DraftingBody draftingbody,
const std::vector< NXOpen::Drawings::DraftingCurve * > &  curves 
)

Adds opening filling lines by model body.

Returns
Create Annotation or not
Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")
Parameters
draftingbodydraftingbody
curvesShip drafting curves
NXOpen::Annotations::TableSection* NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::CreateTable ( )

Creates the Table.

Returns
table section
Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::DeleteExistingAnnotations ( )

Deletes the existing annotations excluding the opening filling lines.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::DeleteLines ( const std::vector< NXOpen::Drawings::DraftingCurve * > &  curves)

Deletes opening filling lines
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
curvescurves
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::DeleteOpeningFillingLine ( NXOpen::Line line)

Deletes the specific opening filling line.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
lineline
int NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::GetTableIndex ( )

Gets the table index.

Returns

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")
NXOpen::NXObject* NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::HandleAnnotationForBasicDesign ( bool  createIDAnnotation,
bool  createScantlingAnnotation,
bool  createEndCutsAnnotation,
NXOpen::Drawings::DraftingCurve draftingVDCurve,
NXOpen::NXObject shipEntity,
NXOpen::Drawings::DraftingView view 
)

Creates ship annotations for basic design structures.

Returns
The ship entity annotation, entity type can be NXOpen::Body or NXOpen::Face
Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")
Parameters
createIDAnnotationCreate Structure ID Annotation or not
createScantlingAnnotationCreate Scantling Annotation or not
createEndCutsAnnotationCreate EndCuts Annotation or not
draftingVDCurveShip drafting curve
shipEntityThe ship entity, entity type can be NXOpen::Body or NXOpen::Face
viewShip drafting section view
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::HandleSeamForNonSectionedPlateForBasicDesign ( bool  createSeamSymbol,
NXOpen::Drawings::DraftingCurve draftingVDCurve,
NXOpen::NXObject tgCurve 
)

Add annotation of seam symbol for non-sectioned plate for basic design
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createSeamSymbolcreateseamsymbol
draftingVDCurveShip drafting curve
tgCurvetgcurve
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::HandleSeamForSectionedPlateForBasicDesign ( bool  createSeamSymbol,
NXOpen::Drawings::DraftingBody tgDraftingBody,
const std::vector< NXOpen::Drawings::DraftingCurve * > &  objects,
NXOpen::Drawings::DraftingCurve selectedObject 
)

Add annotation of seam symbol for sectioned plate for basic design
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
createSeamSymbolcreateseamsymbol
tgDraftingBodytgdraftingbody
objectsobjects
selectedObjectselectedobject
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::ModifyFillingLineByPoints ( NXOpen::Point spiderPoint,
NXOpen::Point strikingPoint,
NXOpen::Line line 
)

Modifies the position of opening filling line, which is created by points method.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
spiderPointspider point
strikingPointstriking point
lineline which created by point
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::SetPosition ( const std::vector< double > &  pos)

Sets the table position
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
posposition
void NXOpen::Features::ShipDesign::InteractiveAnnotationBuilder::SetTableIndex ( int  inx)

Sets the table index
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting") OR nx_ship_gen_arrange ("Ship General Arrangement")

Parameters
inxinx

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