InteractiveAnnotationBuilder Class¶

class NXOpen.Features.ShipDesign.InteractiveAnnotationBuilder¶

Bases: NXOpen.Builder

Represents a NXOpen.Features.ShipDesign.InteractiveAnnotationBuilder builder .

This builder returns None. To create a new instance of this class, use NXOpen.Features.ShipCollection.CreateInteractiveAnnotationBuilder()

New in version NX11.0.0.

Properties¶

Property	Description
Tag	Returns the Tag for this object.

Methods¶

Method	Description
AddAnnotationOfBracket	Add annotation of bracket
AddAnnotationOfEndCuts	Add annotation of end cuts.
AddAnnotationOfExpansionPlate	Add annotation of expansion plate
AddAnnotationOfExpansionStiffenerEndCuts	Add annotation of expansion stiffener endcuts
AddAnnotationOfExpansionStiffenerSturctureIdAndScantling	Add annotation of structure ID and scantling on Ship Expansion View
AddAnnotationOfOpeningFillingLine	Add annotation of opening filling line
AddAnnotationOfSeamForDetailDesign	Add annotation of seam symbol for detail design
AddAnnotationOfStructureIdAndScantling	Add annotations of sturcture ID And scantling.
AddFillingLineByChain	Adds opening filling lines by curve chain method.
AddFillingLineByPoints	Adds opening filling lines by points method.
AddFillingLinesByModelBody	Adds opening filling lines by model body.
Commit	Commits any edits that have been applied to the builder.
CreateTable	Creates the Table.
DeleteExistingAnnotations	Deletes the existing annotations excluding the opening filling lines.
DeleteLines	Deletes opening filling lines
DeleteOpeningFillingLine	Deletes the specific opening filling line.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetTableIndex	Gets the table index
HandleAnnotationForBasicDesign	Creates ship annotations for basic design structures.
HandleSeamForNonSectionedPlateForBasicDesign	Add annotation of seam symbol for non-sectioned plate for basic design
HandleSeamForSectionedPlateForBasicDesign	Add annotation of seam symbol for sectioned plate for basic design
ModifyFillingLineByPoints	Modifies the position of opening filling line, which is created by points method.
SetPosition	Sets the table position
SetTableIndex	Sets the table index
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Method Detail¶

AddAnnotationOfBracket¶

InteractiveAnnotationBuilder.AddAnnotationOfBracket¶

Add annotation of bracket

Signature AddAnnotationOfBracket(createBracketSymbol, draftingbody)

Parameters:	createBracketSymbol (bool) – draftingbody (`NXOpen.Drawings.DraftingBody`) –

New in version NX11.0.0.

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

AddAnnotationOfEndCuts¶

InteractiveAnnotationBuilder.AddAnnotationOfEndCuts¶

Add annotation of end cuts.

Signature AddAnnotationOfEndCuts(createEndCutsSymbol, draftingBody)

Parameters:	createEndCutsSymbol (bool) – Create End Cuts symbols or not draftingBody (`NXOpen.Drawings.DraftingBody`) –

New in version NX11.0.0.

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

AddAnnotationOfExpansionPlate¶

InteractiveAnnotationBuilder.AddAnnotationOfExpansionPlate¶

Add annotation of expansion plate

Signature AddAnnotationOfExpansionPlate(tgView, shipStructure, createScantlingAnnotation)

Parameters:	tgView (`NXOpen.Drawings.DraftingView`) – The Ship Expansion View shipStructure (`NXOpen.NXObject`) – The Ship Structure on that the annotation will create. createScantlingAnnotation (bool) – Create Scantling Annotation or not

New in version NX11.0.0.

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

AddAnnotationOfExpansionStiffenerEndCuts¶

InteractiveAnnotationBuilder.AddAnnotationOfExpansionStiffenerEndCuts¶

Add annotation of expansion stiffener endcuts

Signature AddAnnotationOfExpansionStiffenerEndCuts(tgView, shipStructure, createEndCutsSymbol)

Parameters:	tgView (`NXOpen.Drawings.DraftingView`) – The Ship Expansion View shipStructure (`NXOpen.NXObject`) – The Ship Structure on that the annotation will create. createEndCutsSymbol (bool) – Create End Cuts Symbol or not

New in version NX11.0.0.

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

AddAnnotationOfExpansionStiffenerSturctureIdAndScantling¶

InteractiveAnnotationBuilder.AddAnnotationOfExpansionStiffenerSturctureIdAndScantling¶

Add annotation of structure ID and scantling on Ship Expansion View

Signature AddAnnotationOfExpansionStiffenerSturctureIdAndScantling(tgView, shipStructure, createIDAnnotation, createScantlingAnnotation)

Parameters:	tgView (`NXOpen.Drawings.DraftingView`) – The Ship Expansion View shipStructure (`NXOpen.NXObject`) – The Ship Structure on that the annotation will create. createIDAnnotation (bool) – Create ID annotation or not createScantlingAnnotation (bool) – Create Scantling Annotation or not

New in version NX11.0.0.

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

AddAnnotationOfOpeningFillingLine¶

InteractiveAnnotationBuilder.AddAnnotationOfOpeningFillingLine¶

Add annotation of opening filling line

Signature AddAnnotationOfOpeningFillingLine(createOpeningFillingLine, draftingbody)

Parameters:	createOpeningFillingLine (bool) – draftingbody (`NXOpen.Drawings.DraftingBody`) –

New in version NX11.0.0.

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

AddAnnotationOfSeamForDetailDesign¶

InteractiveAnnotationBuilder.AddAnnotationOfSeamForDetailDesign¶

Add annotation of seam symbol for detail design

Signature AddAnnotationOfSeamForDetailDesign(createSeamSymbol, tgView, objects, selectedObjecty)

Parameters:	createSeamSymbol (bool) – tgView (`NXOpen.Drawings.DraftingView`) – objects (list of `NXOpen.Drawings.DraftingBody`) – selectedObjecty (`NXOpen.Drawings.DraftingBody`) –

New in version NX11.0.0.

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

AddAnnotationOfStructureIdAndScantling¶

InteractiveAnnotationBuilder.AddAnnotationOfStructureIdAndScantling¶

Add annotations of sturcture ID And scantling.

Signature AddAnnotationOfStructureIdAndScantling(createIDAnnotation, createScantlingAnnotation, draftingBody)

Parameters:	createIDAnnotation (bool) – Create ID annotation or not createScantlingAnnotation (bool) – Create Scantling annotation or not draftingBody (`NXOpen.Drawings.DraftingBody`) –

New in version NX11.0.0.

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

AddFillingLineByChain¶

InteractiveAnnotationBuilder.AddFillingLineByChain¶

Adds opening filling lines by curve chain method.

Signature AddFillingLineByChain(curves, createChainAnnotation)

Parameters:	curves (list of `NXOpen.Drawings.DraftingCurve`) – Ship drafting curves createChainAnnotation (bool) – Create Chain Annotation or not

New in version NX11.0.0.

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

AddFillingLineByPoints¶

InteractiveAnnotationBuilder.AddFillingLineByPoints¶

Adds opening filling lines by points method.

Signature AddFillingLineByPoints(spiderPoint, strikingPoint)

Parameters:	spiderPoint (`NXOpen.Point`) – spider point strikingPoint (`NXOpen.Point`) – striking point
Returns:	Create line by points
Return type:	`NXOpen.Line`

New in version NX11.0.0.

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

AddFillingLinesByModelBody¶

InteractiveAnnotationBuilder.AddFillingLinesByModelBody¶

Adds opening filling lines by model body.

Signature AddFillingLinesByModelBody(draftingbody, curves)

Parameters:	draftingbody (`NXOpen.Drawings.DraftingBody`) – curves (list of `NXOpen.Drawings.DraftingCurve`) – Ship drafting curves
Returns:	Create Annotation or not
Return type:	bool

New in version NX12.0.0.

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

CreateTable¶

InteractiveAnnotationBuilder.CreateTable¶

Creates the Table.

Signature CreateTable()

Returns:	table section
Return type:	`NXOpen.Annotations.TableSection`

New in version NX12.0.0.

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

DeleteExistingAnnotations¶

InteractiveAnnotationBuilder.DeleteExistingAnnotations¶

Deletes the existing annotations excluding the opening filling lines.

Signature DeleteExistingAnnotations()

New in version NX11.0.0.

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

DeleteLines¶

InteractiveAnnotationBuilder.DeleteLines¶

Deletes opening filling lines

Signature DeleteLines(curves)

Parameters:	curves (list of `NXOpen.Drawings.DraftingCurve`) –

New in version NX12.0.0.

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

DeleteOpeningFillingLine¶

InteractiveAnnotationBuilder.DeleteOpeningFillingLine¶

Deletes the specific opening filling line.

Signature DeleteOpeningFillingLine(line)

Parameters:	line (`NXOpen.Line`) –

New in version NX11.0.0.

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

GetTableIndex¶

InteractiveAnnotationBuilder.GetTableIndex¶

Gets the table index

Signature GetTableIndex()

Returns:
Return type:	int

New in version NX12.0.0.

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

HandleAnnotationForBasicDesign¶

InteractiveAnnotationBuilder.HandleAnnotationForBasicDesign¶

Creates ship annotations for basic design structures.

Signature HandleAnnotationForBasicDesign(createIDAnnotation, createScantlingAnnotation, createEndCutsAnnotation, draftingVDCurve, shipEntity, view)

Parameters:	createIDAnnotation (bool) – Create Structure ID Annotation or not createScantlingAnnotation (bool) – Create Scantling Annotation or not createEndCutsAnnotation (bool) – Create EndCuts Annotation or not draftingVDCurve (`NXOpen.Drawings.DraftingCurve`) – Ship drafting curve shipEntity (`NXOpen.NXObject`) – The ship entity, entity type can be `NXOpen.Body` or `NXOpen.Face` view (`NXOpen.Drawings.DraftingView`) – Ship drafting section view
Returns:	The ship entity annotation, entity type can be `NXOpen.Body` or `NXOpen.Face`
Return type:	`NXOpen.NXObject`

New in version NX11.0.0.

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

HandleSeamForNonSectionedPlateForBasicDesign¶

InteractiveAnnotationBuilder.HandleSeamForNonSectionedPlateForBasicDesign¶

Add annotation of seam symbol for non-sectioned plate for basic design

Signature HandleSeamForNonSectionedPlateForBasicDesign(createSeamSymbol, draftingVDCurve, tgCurve)

Parameters:	createSeamSymbol (bool) – draftingVDCurve (`NXOpen.Drawings.DraftingCurve`) – Ship drafting curve tgCurve (`NXOpen.NXObject`) –

New in version NX11.0.0.

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

HandleSeamForSectionedPlateForBasicDesign¶

InteractiveAnnotationBuilder.HandleSeamForSectionedPlateForBasicDesign¶

Add annotation of seam symbol for sectioned plate for basic design

Signature HandleSeamForSectionedPlateForBasicDesign(createSeamSymbol, tgDraftingBody, objects, selectedObject)

Parameters:	createSeamSymbol (bool) – tgDraftingBody (`NXOpen.Drawings.DraftingBody`) – objects (list of `NXOpen.Drawings.DraftingCurve`) – selectedObject (`NXOpen.Drawings.DraftingCurve`) –

New in version NX11.0.0.

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

ModifyFillingLineByPoints¶

InteractiveAnnotationBuilder.ModifyFillingLineByPoints¶

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

Signature ModifyFillingLineByPoints(spiderPoint, strikingPoint, line)

Parameters:	spiderPoint (`NXOpen.Point`) – spider point strikingPoint (`NXOpen.Point`) – striking point line (`NXOpen.Line`) – line which created by point

New in version NX11.0.0.

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

SetPosition¶

InteractiveAnnotationBuilder.SetPosition¶

Sets the table position

Signature SetPosition(pos)

Parameters:	pos (list of float) – position

New in version NX12.0.0.

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

SetTableIndex¶

InteractiveAnnotationBuilder.SetTableIndex¶

Sets the table index

Signature SetTableIndex(inx)

Parameters:	inx (int) –

New in version NX12.0.0.

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

Validate¶

InteractiveAnnotationBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.

InteractiveAnnotationBuilder Class¶

Properties¶

Methods¶

Method Detail¶

AddAnnotationOfBracket¶

AddAnnotationOfEndCuts¶

AddAnnotationOfExpansionPlate¶

AddAnnotationOfExpansionStiffenerEndCuts¶

AddAnnotationOfExpansionStiffenerSturctureIdAndScantling¶

AddAnnotationOfOpeningFillingLine¶

AddAnnotationOfSeamForDetailDesign¶

AddAnnotationOfStructureIdAndScantling¶

AddFillingLineByChain¶

AddFillingLineByPoints¶

AddFillingLinesByModelBody¶

CreateTable¶

DeleteExistingAnnotations¶

DeleteLines¶

DeleteOpeningFillingLine¶

GetTableIndex¶

HandleAnnotationForBasicDesign¶

HandleSeamForNonSectionedPlateForBasicDesign¶

HandleSeamForSectionedPlateForBasicDesign¶

ModifyFillingLineByPoints¶

SetPosition¶

SetTableIndex¶

Validate¶

NXOpen Python API Reference

Navigation

Related Topics