ForeshorteningSymbolBuilder Class

class NXOpen.Annotations.ForeshorteningSymbolBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Annotations.ForeshorteningSymbolBuilder builder

There is no KF creator for this class.

New in version NX10.0.0.

Properties

Property	Description
Tag	Returns the Tag for this object.

Methods

Method	Description
AddSymbol	Add the foreshortening symbol
DeleteSymbol	Delete the foreshortening symbol
GetSymbols	Get the foreshortening symbol
ModifySymbol	Modify the foreshortening symbol
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Method Detail

AddSymbol

ForeshorteningSymbolBuilder.AddSymbol

Add the foreshortening symbol

Signature AddSymbol(locations)

Parameters:locations (NXOpen.Point3d) –

New in version NX10.0.0.

License requirements: None.

DeleteSymbol

ForeshorteningSymbolBuilder.DeleteSymbol

Delete the foreshortening symbol

Signature DeleteSymbol(symbolIndex)

Parameters:symbolIndex (int) –

New in version NX10.0.0.

License requirements: None.

GetSymbols

ForeshorteningSymbolBuilder.GetSymbols

Get the foreshortening symbol

Signature GetSymbols()

Returns:a tuple Return type:A tuple consisting of (locations, indices). locations is a list of NXOpen.Point3d. indices is a list of int.

New in version NX10.0.0.

License requirements: None.

ModifySymbol

ForeshorteningSymbolBuilder.ModifySymbol

Modify the foreshortening symbol

Signature ModifySymbol(symbolIndex, locations)

Parameters:

• symbolIndex (int) –
• locations (NXOpen.Point3d) –

New in version NX10.0.0.

License requirements: None.

Validate

ForeshorteningSymbolBuilder.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.