Object that represents an existing thread feature in a design. The creation of a tapped hole also results in the creation of a thread feature. There are some limitation when the thread feature is associated with a hole, which are described in the documentation for the property or method where the limitation exists.
| Name | Description |
| classType |
Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType(). |
| createForAssemblyContext |
Creates or returns a proxy for the native object - i.e. a new object that represents this object but adds the assembly context defined by the input occurrence. |
| deleteMe |
Deletes the feature. This works for both parametric and non-parametric features. |
| dissolve |
Dissolves the feature so that the feature information is lost and only the B-Rep geometry defined by the feature remains. This is only valid for non-parametric features. |
| setThreadOffsetLength |
Sets the thread offset, length and location. Calling this method will cause the isFullLength property to be set to false. |
| Name | Description |
| assemblyContext | Returns the assembly occurrence (i.e. the occurrence) of this object in an assembly. This is only valid in the case where this is acting as a proxy in an assembly. Returns null in the case where the object is not in the context of an assembly but is already the native object. |
| attributes | Returns the collection of attributes associated with this face. |
| baseFeature | If this feature is associated with a base feature, this property will return that base feature. If it's not associated with a base feature, this property will return null. |
| bodies | Returns the bodies that were modified or created by this feature. This works for both parametric and non-parametric features. For a BaseFeature this returns the bodies that are owned by the base feature. |
| entityToken | |
| errorOrWarningMessage | Returns the error or warning message in the case where the healthState property returns either WarningFeatureHealthState or ErrorFeatureHealthState. Otherwise this property returns an empty string. |
| faces | Returns the faces that were created by this feature. This works for both parametric and non-parametric features. |
| healthState | Returns the current health state of the feature. |
| hole | If this thread feature is was created as the result of creating a tapped hole, this property will return the associated hole feature. If this is a standard thread feature, this property will return null. |
| inputCylindricalFace | Gets and sets the threaded face. In the case where there are multiple faces, only the first one is returned. Setting this results in a thread being applied to only a single face. It is recommended that you use the inputCylindricalfaces property in order to have full access to the collection of faces to be threaded. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) If the thread feature is associated with a hole (the hole property is not null), this property will always return null and will fail if set. |
| inputCylindricalFaces | Gets and sets the cylindrical input faces. To use this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) If the thread feature is associated with a hole (the hole property is not null), this property will always return null and will fail if set. |
| isFullLength | Gets and sets if this thread is the full length of the cylinder. It only can be set to true. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| isModeled | Gets and sets if the thread is physical or cosmetic thread. A value of true indicates a physical thread. It defaults to false. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| isParametric | Indicates if this feature is parametric or not. |
| isRightHanded | Gets and sets if the thread is right or left-handed thread. A value of true indicates a right-handed thread. It defaults to true. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| isSuppressed | Gets and sets if this feature is suppressed. This is only valid for parametric features. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| linkedFeatures | Returns the set of features that are linked to this feature. The set of linked features are all of the features that were created in various components as the result of a single feature being created in the user interface. |
| name | Returns the name of the feature as seen in the browser (non-parametric) or in the timeline (parametric). |
| nativeObject | The NativeObject is the object outside the context of an assembly and in the context of its parent component. Returns null in the case where this object is not in the context of an assembly but is already the native object. |
| objectType | Returns a string indicating the type of the object. |
| parentComponent | Returns the parent component that owns this feature. |
| threadInfo | Gets and sets the thread data. Also can edit the thread through the properties and methods on the ThreadInfo object. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| threadLength | Gets the parameter that controls the depth of the thread. Even though the parameter for the thread depth is always created and accessible through this property, it is only used in the case where the isFullLength property is false. Returns nothing in the case where the feature is non-parametric. |
| threadLocation | Gets and sets where the thread length is measured from. This property is only used in the case where the isFullLength property is false. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) If the thread feature is associated with a hole (the hole property is not null), this property will always return null and will always return LowEndThreadLocation and will fail if set. |
| threadOffset | Gets the parameter that controls the offset value of the thread. The offset is the distance along the axis of the cylinder from the edge to the start of the thread, it is only used in the case where the isFullLength property is false. Returns nothing in the case where the feature is non-parametric. |
| timelineObject | Returns the timeline object associated with this feature. |
| Name | Description |
| Thread Feature API Sample | Demonstrates creating a new thread feature. |