SplitBodyFeature Object

Derived from: Feature Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/SplitBodyFeature.h>

Description

Object that represents an existing split body feature in a design.

Methods

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.

setSplittingTool

Sets the splitting tool used for the feature.

To use this method, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True)

Properties

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.
isParametric Indicates if this feature is parametric or not.
isSplittingToolExtended Gets whether or not the splitting tool is to be automatically extended (if possible) so as to completely intersect the bodyToSplit.
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.
splitBodies Gets and sets the input solid or open bodies that are split.

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)
splittingTool Gets the entity that defines the splitting tool. The splitting tool is a single entity that can be either a solid body, open body, plane, sketch curve or face that partially or fully intersects the bodyToSplit.

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)
timelineObject Returns the timeline object associated with this feature.

Accessed From

SplitBodyFeature.createForAssemblyContext, SplitBodyFeature.nativeObject, SplitBodyFeatures.add, SplitBodyFeatures.item, SplitBodyFeatures.itemByName

Samples

Name Description
Split Body Feature API Sample Demonstrates creating a new split body feature.

Version

Introduced in version June 2015