Object that represents an existing pipe 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. |
| setThickness |
Defines the section thickness of the Pipe. |
| 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. |
| distanceOne | Gets the distance for the pipe created while following the path given as input, in the same order. If the path is open, this value returns the length of Pipe relative to the length of the path. If the path is closed, this value returns the length of the Pipe from the start point going along the curves. Ex: Path is made of curves A-B-C-A. The distanceOne returns the length of the pipe going from A-B-C-A. This property returns null in the case where the feature is non-parametric. |
| distanceTwo | Gets the distance for the pipe created while following the reversed path given as input. If the path is open, getting this value returns null, and setting the value is ignored. If the path is closed, this value returns the length of the Pipe from the start point going in the reverse order of the path. Ex: Path is made of curves A-B-C-A. The distanceTwo returns the length of the pipe going from A-C-B-A. This property returns null in the case where the feature is non-parametric. |
| endFaces | Property that returns the set of faces that cap one end of the Pipe that are coincident with the sketch plane. The end faces are those not coincident to the sketch plane of the feature's profile. In the case of a symmetric Pipe these faces are the ones on the negative normal side of the sketch plane. In the cases where there aren't any end faces this property will return null. |
| 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. |
| isHollow | Specifies if the Pipe is hollow or not. Setting this to true will default the sectionThickness to 0.1 cm. |
| 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. |
| 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. |
| operation | Gets and sets the type of operation performed by the Pipe. |
| parentComponent | Returns the parent component that owns this feature. |
| participantBodies | Gets and sets the list of bodies that will participate in the feature when the operation is a cut or intersection. 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) |
| path | Gets and sets the path to create the Pipe. This property returns null in the case where the feature is non-parametric. The path can be either closed (you can reach again the starting point by following the curves) or open (the starting point and end point are different in the path). The starting point of the Pipe will be the starting point of the first curve in the Path, regardless of it being open or closed. When the desired Pipe has a section that includes the starting point and the path is closed, the curves should be shifted in a circular pattern. 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) |
| sectionSize | Gets and sets the section size of the Pipe. |
| sectionThickness | Gets the section thickness of the Pipe. If the pipe is not hollow, this will return null. |
| sectionType | Gets and sets the section type of the Pipe. The type can be: Circular, Square, Triangular. |
| sideFaces | Property that returns an object that provides access to all of the faces created around the perimeter of the feature. |
| startFaces | Property that returns the set of faces that cap one end of the Pipe that are coincident with the sketch plane. In the cases where there aren't any start faces this property will return null. |
| timelineObject | Returns the timeline object associated with this feature. |