OvercrownBuilder Class¶
-
class
NXOpen.Features.
OvercrownBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a Overcrown Builder
To create an instance of this this class use
Features.FeatureCollection.CreateOvercrownFeatureBuilder
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
AngularTolerance | Returns or sets the angular tolerance |
BaseSurface | Returns or sets the Base Surface when the Global Shaping Operator control is by **Function</b>. |
BoundarySection | Returns or sets the boundary section. |
ControlSurface | Returns or sets the Control Surface when the Global Shaping Operator control is by **Function</b>. |
Direction | Returns or sets the direction of deformation. |
DistanceTolerance | Returns or sets the distance tolerance |
Height | Returns or sets the maximum height of deformation. |
OperatorControlType | Returns or sets the controlling type Global Shaping Operation. |
OperatorOperationType | Returns or sets the Type of Global Shaping Operation |
OperatorOutputType | Returns or sets the output type Global Shaping Operation |
OperatorTransitionType | Returns or sets the Transition option for Global Shaping Operator |
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 |
PointInFormingRegion | Returns or sets the point in forming region. |
ReverseNormal | Returns or sets the reverse normal flag for the target faces. |
ShapeControl | Returns or sets the shape control parameter. |
StretchDirection | Returns or sets the stretch direction of deformation. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
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. |
GetTargetFaces | The target faces for the Global Shaping Operator @return target faces |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
InitData | Initializes the builder. |
SetCenterPoint | Sets the point in forming region. |
SetDefaultDirection | The default direction. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetTargetFaces | Sets the target faces for the Global Shaping Operator |
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¶
OvercrownBuilderControlType Enumeration | This enum represents the control type of Global Shaping Operation |
OvercrownBuilderOperationType Enumeration | This enum represents the type of Global Shaping Operation |
OvercrownBuilderOutputType Enumeration | This enum represents the output type of Global Shaping Operation |
OvercrownBuilderTransitionType Enumeration | This enum represents the transition type of Global Shaping Operation |
Property Detail¶
AngularTolerance¶
-
OvercrownBuilder.
AngularTolerance
¶ Returns or sets the angular tolerance
-------------------------------------
Getter Method
Signature
AngularTolerance()
Returns: Return type: float New in version NX7.5.1.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
AngularTolerance(angularTolerance)
Parameters: angularTolerance (float) – New in version NX7.5.1.
License requirements: solid_modeling (“SOLIDS MODELING”)
BaseSurface¶
-
OvercrownBuilder.
BaseSurface
¶ Returns or sets the Base Surface when the Global Shaping Operator control is by **Function</b>.
-------------------------------------
Getter Method
Signature
BaseSurface()
Returns: Base surface Return type: NXOpen.Body
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
BaseSurface(base)
Parameters: base ( NXOpen.Body
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BoundarySection¶
-
OvercrownBuilder.
BoundarySection
¶ Returns or sets the boundary section.
When Global Shaping operator control is is by **Function</b>, this section bounds the effect of the shape function
-------------------------------------
Getter Method
Signature
BoundarySection()
Returns: boundary section Return type: NXOpen.Section
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
BoundarySection(section)
Parameters: section ( NXOpen.Section
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ControlSurface¶
-
OvercrownBuilder.
ControlSurface
¶ Returns or sets the Control Surface when the Global Shaping Operator control is by **Function</b>.
-------------------------------------
Getter Method
Signature
ControlSurface()
Returns: Control surface Return type: NXOpen.Body
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
ControlSurface(control)
Parameters: control ( NXOpen.Body
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Direction¶
-
OvercrownBuilder.
Direction
¶ Returns or sets the direction of deformation.
When Global Shaping operator control is is by **Function</b>, this direction provides the direction of influence of shape function
-------------------------------------
Getter Method
Signature
Direction()
Returns: direction Return type: NXOpen.Direction
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
Direction(direction)
Parameters: direction ( NXOpen.Direction
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DistanceTolerance¶
-
OvercrownBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance
-------------------------------------
Getter Method
Signature
DistanceTolerance()
Returns: Return type: float New in version NX7.5.1.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
DistanceTolerance(distanceTolerance)
Parameters: distanceTolerance (float) – New in version NX7.5.1.
License requirements: solid_modeling (“SOLIDS MODELING”)
Height¶
-
OvercrownBuilder.
Height
¶ Returns or sets the maximum height of deformation.
When Global Shaping operator control is by **Function</b> this value sets the maximum deformation height
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: str New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
Height(heightExpression)
Parameters: heightExpression (str) – New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OperatorControlType¶
-
OvercrownBuilder.
OperatorControlType
¶ Returns or sets the controlling type Global Shaping Operation.
Type can be
-------------------------------------
Getter Method
Signature
OperatorControlType()
Returns: Control type of Global Shaping Operation :rtype:
NXOpen.Features.OvercrownBuilderControlType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
OperatorControlType(type)
Parameters: type ( NXOpen.Features.OvercrownBuilderControlType
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OperatorOperationType¶
-
OvercrownBuilder.
OperatorOperationType
¶ Returns or sets the Type of Global Shaping Operation
-------------------------------------
Getter Method
Signature
OperatorOperationType()
Returns: Type of Global Shaping Operation :rtype:
NXOpen.Features.OvercrownBuilderOperationType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
OperatorOperationType(type)
Parameters: type ( NXOpen.Features.OvercrownBuilderOperationType
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OperatorOutputType¶
-
OvercrownBuilder.
OperatorOutputType
¶ Returns or sets the output type Global Shaping Operation
-------------------------------------
Getter Method
Signature
OperatorOutputType()
Returns: Output type of Global Shaping Operation :rtype:
NXOpen.Features.OvercrownBuilderOutputType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
OperatorOutputType(type)
Parameters: type ( NXOpen.Features.OvercrownBuilderOutputType
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OperatorTransitionType¶
-
OvercrownBuilder.
OperatorTransitionType
¶ Returns or sets the Transition option for Global Shaping Operator
-------------------------------------
Getter Method
Signature
OperatorTransitionType()
Returns: Transition type Return type: NXOpen.Features.OvercrownBuilderTransitionType
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
OperatorTransitionType(type)
Parameters: type ( NXOpen.Features.OvercrownBuilderTransitionType
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PointInFormingRegion¶
-
OvercrownBuilder.
PointInFormingRegion
¶ Returns or sets the point in forming region.
When Global Shaping operator control is is by **Function</b>, this point provides the location of maximum influence of shape function
-------------------------------------
Getter Method
Signature
PointInFormingRegion()
Returns: Point in forming region Return type: NXOpen.NXObject
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
PointInFormingRegion(point)
Parameters: point ( NXOpen.NXObject
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ReverseNormal¶
-
OvercrownBuilder.
ReverseNormal
¶ Returns or sets the reverse normal flag for the target faces.
Used by the Variable Offset type.
-------------------------------------
Getter Method
Signature
ReverseNormal()
Returns: Return type: int New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
ReverseNormal(reverseNormal)
Parameters: reverseNormal (int) – New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ShapeControl¶
-
OvercrownBuilder.
ShapeControl
¶ Returns or sets the shape control parameter.
When Global Shaping operator control is by **Function</b> this value sets the shape control parameter for the shape function. Value is between 0.0 - 1.0
-------------------------------------
Getter Method
Signature
ShapeControl()
Returns: Shape control value Return type: float New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
ShapeControl(shape)
Parameters: shape (float) – New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
StretchDirection¶
-
OvercrownBuilder.
StretchDirection
¶ Returns or sets the stretch direction of deformation.
When Global Shaping operator control is by **Function</b> and the type is **Stretch</b> this direction provides the stretch direction
-------------------------------------
Getter Method
Signature
StretchDirection()
Returns: direction Return type: NXOpen.Direction
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
-------------------------------------
Setter Method
Signature
StretchDirection(stretch)
Parameters: stretch ( NXOpen.Direction
) –New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
GetTargetFaces¶
-
OvercrownBuilder.
GetTargetFaces
¶ The target faces for the Global Shaping Operator
Signature
GetTargetFaces()
Returns: target faces Return type: list of NXOpen.NXObject
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
InitData¶
-
OvercrownBuilder.
InitData
¶ Initializes the builder.
Signature
InitData()
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetCenterPoint¶
-
OvercrownBuilder.
SetCenterPoint
¶ Sets the point in forming region.
When Global Shaping operator control is is by **Function</b>, this point provides the location of maximum influence of shape function
Signature
SetCenterPoint()
New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetDefaultDirection¶
SetTargetFaces¶
-
OvercrownBuilder.
SetTargetFaces
¶ Sets the target faces for the Global Shaping Operator
Signature
SetTargetFaces(faces)
Parameters: faces (list of NXOpen.NXObject
) – target facesNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
OvercrownBuilder.
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.