Object that represents an existing path pattern feature in a design.
| 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. |
| 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. |
| distance | Gets the distance. Edit the value through ModelParameter. Returns nothing in the case where the feature is non-parametric. |
| 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. |
| inputEntities | Gets and sets the entities to pattern using an ObjectCollection. The collection can contain BRepFace, PartFeature, BRepBody, or Occurrence objects. All of the entities provided must be the same type. For example, it must contain only bodies and can't contain both bodies and faces. ConstructionPoint, ConstructionAxis, and ConstructionPlane objects can also be patterned. When patterning any construction geometry, only one entity can be patterned at a time, so the ObjectCollection will always contain a single entity 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) |
| isFlipDirection | Gets and sets if flip the direction from start point. 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) |
| isOrientationAlongPath | Gets and sets if the orientation is along path. If false, the orientation is identical. 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. |
| isSuppressed | Gets and sets if this feature is suppressed. This is only valid for parametric features. |
| isSymmetric | Gets and sets if the pattern is in one direction or symmetric. 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) |
| 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. |
| path | Gets and sets the path to create the pattern on path. 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) |
| patternComputeOption | Gets and sets the compute option for this pattern feature. This property only applies when patterning features and is ignored in the direct modeling environment. 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) |
| patternDistanceType | Gets and sets how the distance between elements is computed. 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) |
| patternElements | Gets the PatternElements collection that contains the elements created by this pattern. |
| patternEntityType | Returns the type of entities the pattern consists of. This can be used to help determine the type of results that will be found in the pattern elements. |
| quantity | Gets the quantity of the elements. Edit the value through ModelParameter. Returns nothing in the case where the feature is non-parametric. |
| resultFeatures | Get the features that were created for this mirror. Returns null in the case where the feature is parametric. |
| startPoint | Gets and sets the start point on the path to count the distance. It's between 0 and 1. 0 means start point of the path, 1 means end point of the path. 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) |
| suppressedElementsIds | Gets and sets the id's of the elements to suppress. 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) |
| timelineObject | Returns the timeline object associated with this feature. |
| Name | Description |
| Path Pattern Feature API Sample | Demonstrates creating a new path pattern feature. |