SubdivisionPrimitiveShapeBuilder Class¶
-
class
NXOpen.Features.Subdivision.
SubdivisionPrimitiveShapeBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.Subdivision.SubdivisionPrimitiveShapeBuilder
builder.To create a new instance of this class, use
NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateSubdivisionPrimitiveShapeBuilder()
Default values.
Property Value CircularSegments 4 Height.Value 100 (millimeters part), 4 (inches part) HeightZ.Value 100 (millimeters part), 4 (inches part) InnerSize.Value 50 (millimeters part), 2 (inches part) LengthX.Value 100 (millimeters part), 4 (inches part) OuterSize.Value 100 (millimeters part), 4 (inches part) RadialSegments 8 Size.Value 100 (millimeters part), 4 (inches part) WidthY.Value 100 (millimeters part), 4 (inches part) New in version NX9.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.Features.Subdivision.SubdivisionPrimitiveShapeBuilderEx
instead.
Properties¶
Property | Description |
---|---|
CircularSegments | Returns or sets the number of segments in circular sectional direction of torus. |
Height | Returns the height. |
HeightZ | Returns the height in z direction. |
InnerSize | Returns the inner size of torus. |
LengthX | Returns the length in x direction. |
Origin | Returns or sets the origin. |
OuterSize | Returns the outer size of torus. |
RadialSegments | Returns or sets the number of segments in radial direction of torus. |
Size | Returns the size. |
Tag | Returns the Tag for this object. |
Transformer | Returns the transformation tool. |
Type | Returns or sets the type. |
WidthY | Returns the width in y direction. |
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. |
UpdateMesh | Updates the mesh data after changes in the origin. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SubdivisionPrimitiveShapeBuilderTypes Enumeration | Type of primitive. |
Property Detail¶
CircularSegments¶
-
SubdivisionPrimitiveShapeBuilder.
CircularSegments
¶ Returns or sets the number of segments in circular sectional direction of torus.
-------------------------------------
Getter Method
Signature
CircularSegments
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CircularSegments
Parameters: numSegments (int) – New in version NX10.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Height¶
-
SubdivisionPrimitiveShapeBuilder.
Height
¶ Returns the height.
-------------------------------------
Getter Method
Signature
Height
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
HeightZ¶
-
SubdivisionPrimitiveShapeBuilder.
HeightZ
¶ Returns the height in z direction.
-------------------------------------
Getter Method
Signature
HeightZ
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
InnerSize¶
-
SubdivisionPrimitiveShapeBuilder.
InnerSize
¶ Returns the inner size of torus.
-------------------------------------
Getter Method
Signature
InnerSize
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
LengthX¶
-
SubdivisionPrimitiveShapeBuilder.
LengthX
¶ Returns the length in x direction.
-------------------------------------
Getter Method
Signature
LengthX
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
Origin¶
-
SubdivisionPrimitiveShapeBuilder.
Origin
¶ Returns or sets the origin.
-------------------------------------
Getter Method
Signature
Origin
Returns: Return type: NXOpen.Point
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Origin
Parameters: origin ( NXOpen.Point
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
OuterSize¶
-
SubdivisionPrimitiveShapeBuilder.
OuterSize
¶ Returns the outer size of torus.
-------------------------------------
Getter Method
Signature
OuterSize
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
RadialSegments¶
-
SubdivisionPrimitiveShapeBuilder.
RadialSegments
¶ Returns or sets the number of segments in radial direction of torus.
-------------------------------------
Getter Method
Signature
RadialSegments
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RadialSegments
Parameters: numSegments (int) – New in version NX10.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Size¶
-
SubdivisionPrimitiveShapeBuilder.
Size
¶ Returns the size.
-------------------------------------
Getter Method
Signature
Size
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
Transformer¶
-
SubdivisionPrimitiveShapeBuilder.
Transformer
¶ Returns the transformation tool.
-------------------------------------
Getter Method
Signature
Transformer
Returns: Return type: NXOpen.GeometricUtilities.TransformerData
New in version NX10.0.0.
License requirements: None.
Type¶
-
SubdivisionPrimitiveShapeBuilder.
Type
¶ Returns or sets the type.
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Features.Subdivision.SubdivisionPrimitiveShapeBuilderTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Features.Subdivision.SubdivisionPrimitiveShapeBuilderTypes
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
WidthY¶
-
SubdivisionPrimitiveShapeBuilder.
WidthY
¶ Returns the width in y direction.
-------------------------------------
Getter Method
Signature
WidthY
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
Method Detail¶
UpdateMesh¶
-
SubdivisionPrimitiveShapeBuilder.
UpdateMesh
¶ Updates the mesh data after changes in the origin.
Signature
UpdateMesh()
New in version NX9.0.0.
License requirements: None.
Validate¶
-
SubdivisionPrimitiveShapeBuilder.
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.