SketchInPlaceBuilder Class¶
-
class
NXOpen.SketchInPlaceBuilder¶ Bases:
NXOpen.BuilderUse the
NXOpen.SketchInPlaceBuilderto create or reattach aNXOpen.Sketchon aNXOpen.DatumPlaneor planarNXOpen.Face.To create a new instance of this class, use
NXOpen.SketchCollection.CreateNewSketchInPlaceBuilderDefault values.
Property Value CreateIntermediateDatumCsys 1 MakeOriginAssociative 1 PlaneOption Inferred New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Axis | Returns the reference axis |
| AxisOrientation | Returns or sets the reference axis orientation (horizontal or vertical) |
| CreateIntermediateDatumCsys | Returns or sets the create intermediate datum csys toggle. |
| MakeOriginAssociative | Returns or sets the associative origin toggle. |
| Plane | Returns the specified datum plane |
| PlaneOption | Returns or sets the attachment plane option (existing plane, new plane, new csys) |
| PlaneOrFace | Returns the specified sketch plane |
| ProjectWorkPartOrigin | Returns or sets the create project work part origin toggle. |
| ReverseAxis | Returns or sets the flag to indicate the reference axis is reversed |
| ReversePlaneNormal | Returns or sets the flag to indicate the normal direction of the sketch plane is reversed. |
| SketchOrigin | Returns or sets the origin point for sketch |
| Tag | Returns the Tag for this object. |
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. |
| 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. |
Property Detail¶
Axis¶
-
SketchInPlaceBuilder.Axis¶ Returns the reference axis
-------------------------------------Getter Method
Signature
Axis()Returns: Return type: NXOpen.SelectIReferenceAxisNew in version NX5.0.0.
License requirements: None.
AxisOrientation¶
-
SketchInPlaceBuilder.AxisOrientation¶ Returns or sets the reference axis orientation (horizontal or vertical)
-------------------------------------Getter Method
Signature
AxisOrientation()Returns: Return type: NXOpen.AxisOrientationNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AxisOrientation(axisOrientation)Parameters: axisOrientation ( NXOpen.AxisOrientation) –New in version NX5.0.0.
License requirements: None.
CreateIntermediateDatumCsys¶
-
SketchInPlaceBuilder.CreateIntermediateDatumCsys¶ Returns or sets the create intermediate datum csys toggle.
-------------------------------------Getter Method
Signature
CreateIntermediateDatumCsys()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateIntermediateDatumCsys(intermediateDatumCsys)Parameters: intermediateDatumCsys (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”)
MakeOriginAssociative¶
-
SketchInPlaceBuilder.MakeOriginAssociative¶ Returns or sets the associative origin toggle.
-------------------------------------Getter Method
Signature
MakeOriginAssociative()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MakeOriginAssociative(associativeOrigin)Parameters: associativeOrigin (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”)
Plane¶
-
SketchInPlaceBuilder.Plane¶ Returns the specified datum plane
-------------------------------------Getter Method
Signature
Plane()Returns: Return type: NXOpen.PlaneNew in version NX5.0.0.
License requirements: None.
PlaneOption¶
-
SketchInPlaceBuilder.PlaneOption¶ Returns or sets the attachment plane option (existing plane, new plane, new csys)
-------------------------------------Getter Method
Signature
PlaneOption()Returns: Return type: NXOpen.SketchPlaneOptionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneOption(planeOption)Parameters: planeOption ( NXOpen.SketchPlaneOption) –New in version NX5.0.0.
License requirements: None.
PlaneOrFace¶
-
SketchInPlaceBuilder.PlaneOrFace¶ Returns the specified sketch plane
-------------------------------------Getter Method
Signature
PlaneOrFace()Returns: Return type: NXOpen.SelectISurfaceNew in version NX5.0.0.
License requirements: None.
ProjectWorkPartOrigin¶
-
SketchInPlaceBuilder.ProjectWorkPartOrigin¶ Returns or sets the create project work part origin toggle.
-------------------------------------Getter Method
Signature
ProjectWorkPartOrigin()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProjectWorkPartOrigin(projectWorkPartOrigin)Parameters: projectWorkPartOrigin (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”)
ReverseAxis¶
-
SketchInPlaceBuilder.ReverseAxis¶ Returns or sets the flag to indicate the reference axis is reversed
-------------------------------------Getter Method
Signature
ReverseAxis()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseAxis(reverseAxis)Parameters: reverseAxis (bool) – New in version NX5.0.0.
License requirements: None.
ReversePlaneNormal¶
-
SketchInPlaceBuilder.ReversePlaneNormal¶ Returns or sets the flag to indicate the normal direction of the sketch plane is reversed.
This is not applicable when the plane is a Face.
-------------------------------------Getter Method
Signature
ReversePlaneNormal()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReversePlaneNormal(reversePlaneNormal)Parameters: reversePlaneNormal (bool) – New in version NX5.0.0.
License requirements: None.
SketchOrigin¶
-
SketchInPlaceBuilder.SketchOrigin¶ Returns or sets the origin point for sketch
-------------------------------------Getter Method
Signature
SketchOrigin()Returns: Return type: NXOpen.PointNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SketchOrigin(origin)Parameters: origin ( NXOpen.Point) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
SketchInPlaceBuilder.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.