SplitSolidBuilder Class¶
-
class
NXOpen.Tooling.
SplitSolidBuilder
¶ Bases:
NXOpen.Builder
Represents a builder to be used to split a solid with geometry tools.
To create a new instance of this class, use
NXOpen.Tooling.SplitSolidCollection.CreateSplitSolidBuilder
Default values.
Property Value IsEnlarge 0 SurfaceRange.AnchorPosition Vertex1 ToolOption ExistingObject New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
IsEnlarge | Returns or sets the option to enlarge a split tool or not, the tool should be a face. |
ReverseTrimDirection | Returns or sets the option to reverse the trim direction or not. |
SplitObject | Returns the tool object to split the target body. |
SplitPlane | Returns or sets the plane to be a split tool. |
SplitTarget | Returns the target body to be split. |
SurfaceRange | Returns the utility to get enlarged parameters. |
Tag | Returns the Tag for this object. |
ToolOption | Returns or sets the tool object selection option |
Type | Returns or sets the operation type to do split body or trim body. |
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. |
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. |
SetEnlargedSurfaceData | Keep enlarged surface data to create enlarged surface. |
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¶
SplitSolidBuilderOperationType Enumeration | the split operation type: split, trim. |
SplitSolidBuilderToolObjectOption Enumeration | the split tool selection type: Existing Object, New Plane. |
Property Detail¶
IsEnlarge¶
-
SplitSolidBuilder.
IsEnlarge
¶ Returns or sets the option to enlarge a split tool or not, the tool should be a face.
-------------------------------------
Getter Method
Signature
IsEnlarge()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsEnlarge(isEnlarge)
Parameters: isEnlarge (bool) – New in version NX7.5.0.
License requirements: None.
ReverseTrimDirection¶
-
SplitSolidBuilder.
ReverseTrimDirection
¶ Returns or sets the option to reverse the trim direction or not.
-------------------------------------
Getter Method
Signature
ReverseTrimDirection()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseTrimDirection(reverseTrimDirection)
Parameters: reverseTrimDirection (bool) – New in version NX7.5.0.
License requirements: None.
SplitObject¶
-
SplitSolidBuilder.
SplitObject
¶ Returns the tool object to split the target body.
-------------------------------------
Getter Method
Signature
SplitObject()
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.5.0.
License requirements: None.
SplitPlane¶
-
SplitSolidBuilder.
SplitPlane
¶ Returns or sets the plane to be a split tool.
-------------------------------------
Getter Method
Signature
SplitPlane()
Returns: Return type: NXOpen.Plane
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SplitPlane(splitPlane)
Parameters: splitPlane ( NXOpen.Plane
) –New in version NX7.5.0.
License requirements: None.
SplitTarget¶
-
SplitSolidBuilder.
SplitTarget
¶ Returns the target body to be split.
-------------------------------------
Getter Method
Signature
SplitTarget()
Returns: Return type: NXOpen.SelectBody
New in version NX7.5.0.
License requirements: None.
SurfaceRange¶
-
SplitSolidBuilder.
SurfaceRange
¶ Returns the utility to get enlarged parameters.
-------------------------------------
Getter Method
Signature
SurfaceRange()
Returns: Return type: NXOpen.GeometricUtilities.SurfaceRangeBuilder
New in version NX7.5.0.
License requirements: None.
ToolOption¶
-
SplitSolidBuilder.
ToolOption
¶ Returns or sets the tool object selection option
-------------------------------------
Getter Method
Signature
ToolOption()
Returns: Return type: NXOpen.Tooling.SplitSolidBuilderToolObjectOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolOption(toolOption)
Parameters: toolOption ( NXOpen.Tooling.SplitSolidBuilderToolObjectOption
) –New in version NX7.5.0.
License requirements: None.
Type¶
-
SplitSolidBuilder.
Type
¶ Returns or sets the operation type to do split body or trim body.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Tooling.SplitSolidBuilderOperationType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(splitOrTrim)
Parameters: splitOrTrim ( NXOpen.Tooling.SplitSolidBuilderOperationType
) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
SetEnlargedSurfaceData¶
-
SplitSolidBuilder.
SetEnlargedSurfaceData
¶ Keep enlarged surface data to create enlarged surface.
Four values passed in represent enlarged parameters in U+, U-, V+ and V-.
Signature
SetEnlargedSurfaceData(enlargedSurfaceData)
Parameters: enlargedSurfaceData (list of float) – array of u and v range values New in version NX7.5.0.
License requirements: None.
Validate¶
-
SplitSolidBuilder.
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.