CylinderBuilder Class¶
-
class
NXOpen.Features.
CylinderBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.Cylinder
builderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateCylinderBuilder()
Default values.
Property Value BooleanOption.Type Create Diameter.Value 50.0 (millimeters part), 2.0 (inches part) Height.Value 100.0 (millimeters part), 4.0 (inches part) ReverseDirection false Type AxisDiameterAndHeight New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Arc | Returns the arc |
Axis | Returns or sets the axis |
BooleanOption | Returns the boolean option |
Diameter | Returns the diameter. |
Direction | Returns or sets the cylinder direction |
Height | Returns the height |
Origin | Returns or sets the cylinder origin |
ParentAssociativity | Returns or sets the option to keep associativity of the cylinder axis |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
ReverseDirection | Returns or sets the reverse direction |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Type | Returns or sets the type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
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. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
CylinderBuilderTypes Enumeration | the cylinder types |
Property Detail¶
Arc¶
-
CylinderBuilder.
Arc
¶ Returns the arc
-------------------------------------
Getter Method
Signature
Arc()
Returns: Return type: NXOpen.SelectICurve
New in version NX5.0.0.
License requirements: None.
Axis¶
-
CylinderBuilder.
Axis
¶ Returns or sets the axis
-------------------------------------
Getter Method
Signature
Axis()
Returns: Return type: NXOpen.Axis
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Axis(axis)
Parameters: axis ( NXOpen.Axis
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
BooleanOption¶
-
CylinderBuilder.
BooleanOption
¶ Returns the boolean option
-------------------------------------
Getter Method
Signature
BooleanOption()
Returns: Return type: NXOpen.GeometricUtilities.BooleanOperation
New in version NX5.0.0.
License requirements: None.
Diameter¶
-
CylinderBuilder.
Diameter
¶ Returns the diameter.
This will be used only when the law type is Axis, Diameter, and Height
-------------------------------------
Getter Method
Signature
Diameter()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
Direction¶
-
CylinderBuilder.
Direction
¶ Returns or sets the cylinder direction
-------------------------------------
Getter Method
Signature
Direction()
Returns: Return type: NXOpen.Vector3d
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
-------------------------------------
Setter Method
Signature
Direction(vector)
Parameters: vector ( NXOpen.Vector3d
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Height¶
-
CylinderBuilder.
Height
¶ Returns the height
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
Origin¶
-
CylinderBuilder.
Origin
¶ Returns or sets the cylinder origin
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
-------------------------------------
Setter Method
Signature
Origin(origin)
Parameters: origin ( NXOpen.Point3d
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
ParentAssociativity¶
-
CylinderBuilder.
ParentAssociativity
¶ Returns or sets the option to keep associativity of the cylinder axis
-------------------------------------
Getter Method
Signature
ParentAssociativity()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParentAssociativity(parentAssociativity)
Parameters: parentAssociativity (bool) – New in version NX8.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
ReverseDirection¶
-
CylinderBuilder.
ReverseDirection
¶ Returns or sets the reverse direction
-------------------------------------
Getter Method
Signature
ReverseDirection()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection(reverse)
Parameters: reverse (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Type¶
-
CylinderBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.CylinderBuilderTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Features.CylinderBuilderTypes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
Validate¶
-
CylinderBuilder.
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.