SketchInPlaceBuilder Class¶
-
class
NXOpen.
SketchInPlaceBuilder
¶ Bases:
NXOpen.Builder
Use the
NXOpen.SketchInPlaceBuilder
to create or reattach aNXOpen.Sketch
on aNXOpen.DatumPlane
or planarNXOpen.Face
.To create a new instance of this class, use
NXOpen.SketchCollection.CreateNewSketchInPlaceBuilder()
Default values.
Property Value CreateIntermediateDatumCsys (deprecated) 1 MakeOriginAssociative (deprecated) 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) |
AxisOrientationInfer | Returns or sets the reference axis orientation (horizontal or vertical) |
AxisReference | Returns or sets the reference axis for sketch |
CreateIntermediateDatumCsys | Returns or sets the create intermediate datum csys toggle. |
Csystem | Returns or sets the csys method for sketch |
MakeOriginAssociative | Returns or sets the associative origin toggle. |
OriginOption | Returns or sets the origin method for sketch |
OriginOptionInfer | Returns or sets the origin method for sketch |
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 |
PlaneReference | Returns or sets the placement plane for sketch |
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.SelectIReferenceAxis
New in version NX5.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.SketchInPlaceBuilder.AxisReference()
instead.License requirements: None.
AxisOrientation¶
-
SketchInPlaceBuilder.
AxisOrientation
¶ Returns or sets the reference axis orientation (horizontal or vertical)
-------------------------------------
Getter Method
Signature
AxisOrientation()
Returns: Return type: NXOpen.AxisOrientation
New 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.
AxisOrientationInfer¶
-
SketchInPlaceBuilder.
AxisOrientationInfer
¶ Returns or sets the reference axis orientation (horizontal or vertical)
-------------------------------------
Getter Method
Signature
AxisOrientationInfer()
Returns: Return type: NXOpen.AxisOrientation
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AxisOrientationInfer(axisOrientation)
Parameters: axisOrientation ( NXOpen.AxisOrientation
) –New in version NX11.0.0.
License requirements: None.
AxisReference¶
-
SketchInPlaceBuilder.
AxisReference
¶ Returns or sets the reference axis for sketch
-------------------------------------
Getter Method
Signature
AxisReference()
Returns: Return type: NXOpen.Direction
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AxisReference(axis)
Parameters: axis ( NXOpen.Direction
) –New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”)
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.
Deprecated since version NX11.0.0: None
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateIntermediateDatumCsys(intermediateDatumCsys)
Parameters: intermediateDatumCsys (bool) – New in version NX7.5.0.
Deprecated since version NX11.0.0: None
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
Csystem¶
-
SketchInPlaceBuilder.
Csystem
¶ Returns or sets the csys method for sketch
-------------------------------------
Getter Method
Signature
Csystem()
Returns: Return type: NXOpen.CartesianCoordinateSystem
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Csystem(csystem)
Parameters: csystem ( NXOpen.CartesianCoordinateSystem
) –New in version NX11.0.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.
Deprecated since version NX11.0.0: None
License requirements: None.
-------------------------------------
Setter Method
Signature
MakeOriginAssociative(associativeOrigin)
Parameters: associativeOrigin (bool) – New in version NX7.5.0.
Deprecated since version NX11.0.0: None
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
OriginOption¶
-
SketchInPlaceBuilder.
OriginOption
¶ Returns or sets the origin method for sketch
-------------------------------------
Getter Method
Signature
OriginOption()
Returns: Specify Point or Use Work Part Origin Return type: NXOpen.OriginMethod
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OriginOption(method)
Parameters: method ( NXOpen.OriginMethod
) – Specify Point or Use Work Part OriginNew in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”)
OriginOptionInfer¶
-
SketchInPlaceBuilder.
OriginOptionInfer
¶ Returns or sets the origin method for sketch
-------------------------------------
Getter Method
Signature
OriginOptionInfer()
Returns: Specify Point or Use Work Part Origin Return type: NXOpen.OriginMethod
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OriginOptionInfer(method)
Parameters: method ( NXOpen.OriginMethod
) – Specify Point or Use Work Part OriginNew in version NX11.0.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.Plane
New in version NX5.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.SketchInPlaceBuilder.PlaneReference()
instead.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.SketchPlaneOption
New 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.SelectISurface
New in version NX5.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.SketchInPlaceBuilder.PlaneReference()
instead.License requirements: None.
PlaneReference¶
-
SketchInPlaceBuilder.
PlaneReference
¶ Returns or sets the placement plane for sketch
-------------------------------------
Getter Method
Signature
PlaneReference()
Returns: Return type: NXOpen.Plane
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlaneReference(plane)
Parameters: plane ( NXOpen.Plane
) –New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”)
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.
Deprecated since version NX11.0.0: Use
NXOpen.SketchInPlaceBuilder.OriginOption()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectWorkPartOrigin(projectWorkPartOrigin)
Parameters: projectWorkPartOrigin (bool) – New in version NX7.5.0.
Deprecated since version NX11.0.0: Use
NXOpen.SketchInPlaceBuilder.OriginOption()
instead.License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
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.
Deprecated since version NX11.0.0: None
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseAxis(reverseAxis)
Parameters: reverseAxis (bool) – New in version NX5.0.0.
Deprecated since version NX11.0.0: Get NXOpen.SketchInPlaceBuilder.AxisReference, and then reverse the smart direction.
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.
Deprecated since version NX11.0.0: None
License requirements: None.
-------------------------------------
Setter Method
Signature
ReversePlaneNormal(reversePlaneNormal)
Parameters: reversePlaneNormal (bool) – New in version NX5.0.0.
Deprecated since version NX11.0.0: Get NXOpen.SketchInPlaceBuilder.PlaneReference, and then reverse the smart plane normal.
License requirements: None.
SketchOrigin¶
-
SketchInPlaceBuilder.
SketchOrigin
¶ Returns or sets the origin point for sketch
-------------------------------------
Getter Method
Signature
SketchOrigin()
Returns: Return type: NXOpen.Point
New 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.