FeatureControlFrameBuilder Class¶
-
class
NXOpen.Annotations.
FeatureControlFrameBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Annotations.FeatureControlFrameBuilder
This is an abstract class, and cannot be instantiated.
Default values.
Property Value Text.CustomSymbolScale 1.0 Text.SymbolAspectRatio 1.0 Text.SymbolHeight 25.4 (millimeters part), 1.0 (inches part) Text.SymbolLength 25.4 (millimeters part), 1.0 (inches part) Text.SymbolPreferences UseCurrent Text.SymbolScale 1.0 Text.SymbolSizeMethod ScaleAndAspectRatio New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Characteristic | Returns or sets the characteristic |
FeatureControlFrameDataList | Returns the feature control frame data list. |
FrameStyle | Returns or sets the frame style |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
Origin | Returns the NXOpen.Annotations.OriginBuilder for the annotation |
Style | Returns the style |
Tag | Returns the Tag for this object. |
Text | Returns the text |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
FeatureControlFrameData | The feature control frame data list. |
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. |
InheritFrom | The feature control frame is inherited form existing feature control frame. |
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. |
Enumerations¶
FeatureControlFrameBuilderFcfCharacteristic Enumeration | Specifies the characteristitic of the feature control frame |
FeatureControlFrameBuilderFcfFrameStyle Enumeration | Specifies whether the feature control frame is a single frame or composite |
Property Detail¶
Characteristic¶
-
FeatureControlFrameBuilder.
Characteristic
¶ Returns or sets the characteristic
-------------------------------------
Getter Method
Signature
Characteristic
Returns: Return type: NXOpen.Annotations.FeatureControlFrameBuilderFcfCharacteristic
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Characteristic
Parameters: characteristic ( NXOpen.Annotations.FeatureControlFrameBuilderFcfCharacteristic
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
FeatureControlFrameDataList¶
-
FeatureControlFrameBuilder.
FeatureControlFrameDataList
¶ Returns the feature control frame data list.
this method will always return at least two frames. for single feature control frames (frame type is single frame type) only the first frame is used.
-------------------------------------
Getter Method
Signature
FeatureControlFrameDataList
Returns: Return type: NXOpen.Annotations.FeatureControlFrameDataBuilderList
New in version NX6.0.0.
License requirements: None.
FrameStyle¶
-
FeatureControlFrameBuilder.
FrameStyle
¶ Returns or sets the frame style
-------------------------------------
Getter Method
Signature
FrameStyle
Returns: Return type: NXOpen.Annotations.FeatureControlFrameBuilderFcfFrameStyle
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FrameStyle
Parameters: frameStyle ( NXOpen.Annotations.FeatureControlFrameBuilderFcfFrameStyle
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Leader¶
-
FeatureControlFrameBuilder.
Leader
¶ Returns the
NXOpen.Annotations.LeaderBuilder
for the annotation-------------------------------------
Getter Method
Signature
Leader
Returns: Return type: NXOpen.Annotations.LeaderBuilder
New in version NX6.0.0.
License requirements: None.
Origin¶
-
FeatureControlFrameBuilder.
Origin
¶ Returns the
NXOpen.Annotations.OriginBuilder
for the annotation-------------------------------------
Getter Method
Signature
Origin
Returns: Return type: NXOpen.Annotations.OriginBuilder
New in version NX6.0.0.
License requirements: None.
Style¶
-
FeatureControlFrameBuilder.
Style
¶ Returns the style
-------------------------------------
Getter Method
Signature
Style
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX6.0.0.
License requirements: None.
Text¶
-
FeatureControlFrameBuilder.
Text
¶ Returns the text
-------------------------------------
Getter Method
Signature
Text
Returns: Return type: NXOpen.Annotations.TextWithSymbolsBuilder
New in version NX6.0.0.
License requirements: None.
Method Detail¶
FeatureControlFrameData¶
-
FeatureControlFrameBuilder.
FeatureControlFrameData
¶ The feature control frame data list.
this method will always return at least two frames. for single feature control frames (frame type is single frame type) only the first frame is used.
Signature
FeatureControlFrameData()
Returns: feature control frame data builders Return type: list of NXOpen.Annotations.FeatureControlFrameDataBuilder
New in version NX6.0.0.
License requirements: None.
InheritFrom¶
-
FeatureControlFrameBuilder.
InheritFrom
¶ The feature control frame is inherited form existing feature control frame.
Signature
InheritFrom(inheritTag)
Parameters: inheritTag ( NXOpen.Annotations.BaseFcf
) –New in version NX8.5.0.
License requirements: None.
Validate¶
-
FeatureControlFrameBuilder.
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.