SnipFacetBodyBuilder Class¶
-
class
NXOpen.Facet.SnipFacetBodyBuilder¶ Bases:
NXOpen.BuilderRepresents a SnipFacetBody builder
To create a new instance of this class, use
NXOpen.Facet.FacetedBodyCollection.CreateSnipFacetBodyBuilder()Default values.
Property Value AlongDirection ViewDirection BoundaryFacetTreatmentType SnipFacets CanDivide 0 IsEditCopy 0 IsSnipNearFacets 0 New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| AlongDirection | Returns or sets the direction in which snipping profiles are projected on the facet bodies |
| Bodies | Returns the facet bodies to snip. |
| BoundaryFacetTreatmentType | Returns or sets the boundary facet treatment type |
| CanDivide | Returns or sets the value indicating if facet body is to be divided |
| FacetBodies | Returns the facet bodies to snip |
| IsEditCopy | Returns or sets the value indicating if a copy of the facet body to be snipped without altering the original |
| IsSnipNearFacets | Returns or sets the value indicating if only facets near to the viewer to be snipped |
| Plane | Returns or sets the snipping plane |
| ProfileList | Returns the list of snipping profiles |
| ProjectionVector | Returns or sets the projection vector |
| RegionList | Returns the list of regions to snip |
| RegionPoint | Returns the point indicating the portion of the facet body with respect to specified region to be snipped. |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the snipping method accessor |
| ViewDirection | Returns or sets the view 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. |
| SwitchRegion | Switch the region to be snipped indicated by the region point. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| SnipFacetBodyBuilderBoundaryFacetTreatmentMethod Enumeration | Boundary facet treatment type: |
| SnipFacetBodyBuilderDirectionType Enumeration | Snipping direction when snipping type by profiles |
| SnipFacetBodyBuilderTypes Enumeration | Snip method |
Property Detail¶
AlongDirection¶
-
SnipFacetBodyBuilder.AlongDirection¶ Returns or sets the direction in which snipping profiles are projected on the facet bodies
-------------------------------------Getter Method
Signature
AlongDirection()Returns: Return type: NXOpen.Facet.SnipFacetBodyBuilderDirectionTypeNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AlongDirection(alongDirection)Parameters: alongDirection ( NXOpen.Facet.SnipFacetBodyBuilderDirectionType) –New in version NX7.5.0.
License requirements: None.
Bodies¶
-
SnipFacetBodyBuilder.Bodies¶ Returns the facet bodies to snip.
Inputs to this command can be convergent objects.
-------------------------------------Getter Method
Signature
Bodies()Returns: Return type: NXOpen.SelectDisplayableObjectListNew in version NX11.0.0.
License requirements: None.
BoundaryFacetTreatmentType¶
-
SnipFacetBodyBuilder.BoundaryFacetTreatmentType¶ Returns or sets the boundary facet treatment type
-------------------------------------Getter Method
Signature
BoundaryFacetTreatmentType()Returns: Return type: NXOpen.Facet.SnipFacetBodyBuilderBoundaryFacetTreatmentMethodNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BoundaryFacetTreatmentType(boundaryFacetTreatmentType)Parameters: boundaryFacetTreatmentType ( NXOpen.Facet.SnipFacetBodyBuilderBoundaryFacetTreatmentMethod) –New in version NX7.5.0.
License requirements: None.
CanDivide¶
-
SnipFacetBodyBuilder.CanDivide¶ Returns or sets the value indicating if facet body is to be divided
-------------------------------------Getter Method
Signature
CanDivide()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CanDivide(canDivide)Parameters: canDivide (bool) – New in version NX7.5.0.
License requirements: None.
FacetBodies¶
-
SnipFacetBodyBuilder.FacetBodies¶ Returns the facet bodies to snip
-------------------------------------Getter Method
Signature
FacetBodies()Returns: Return type: NXOpen.Facet.SelectFacetedBodyListNew in version NX7.5.0.
Deprecated since version NX11.0.0: Use
NXOpen.Facet.SnipFacetBodyBuilder.Bodies()instead.License requirements: None.
IsEditCopy¶
-
SnipFacetBodyBuilder.IsEditCopy¶ Returns or sets the value indicating if a copy of the facet body to be snipped without altering the original
-------------------------------------Getter Method
Signature
IsEditCopy()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsEditCopy(isEditCopy)Parameters: isEditCopy (bool) – New in version NX7.5.0.
License requirements: None.
IsSnipNearFacets¶
-
SnipFacetBodyBuilder.IsSnipNearFacets¶ Returns or sets the value indicating if only facets near to the viewer to be snipped
-------------------------------------Getter Method
Signature
IsSnipNearFacets()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsSnipNearFacets(isSnipNearFacets)Parameters: isSnipNearFacets (bool) – New in version NX7.5.0.
License requirements: None.
Plane¶
-
SnipFacetBodyBuilder.Plane¶ Returns or sets the snipping plane
-------------------------------------Getter Method
Signature
Plane()Returns: Return type: NXOpen.PlaneNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Plane(plane)Parameters: plane ( NXOpen.Plane) –New in version NX7.5.0.
License requirements: None.
ProfileList¶
-
SnipFacetBodyBuilder.ProfileList¶ Returns the list of snipping profiles
-------------------------------------Getter Method
Signature
ProfileList()Returns: Return type: NXOpen.SectionListNew in version NX7.5.0.
License requirements: None.
ProjectionVector¶
-
SnipFacetBodyBuilder.ProjectionVector¶ Returns or sets the projection vector
-------------------------------------Getter Method
Signature
ProjectionVector()Returns: Return type: NXOpen.DirectionNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProjectionVector(projectionVector)Parameters: projectionVector ( NXOpen.Direction) –New in version NX7.5.0.
License requirements: None.
RegionList¶
-
SnipFacetBodyBuilder.RegionList¶ Returns the list of regions to snip
-------------------------------------Getter Method
Signature
RegionList()Returns: Return type: NXOpen.GeometricUtilities.BoundaryDefinitionBuilderListNew in version NX7.5.0.
License requirements: None.
RegionPoint¶
-
SnipFacetBodyBuilder.RegionPoint¶ Returns the point indicating the portion of the facet body with respect to specified region to be snipped.
-------------------------------------Getter Method
Signature
RegionPoint()Returns: Return type: NXOpen.SelectPointListNew in version NX7.5.0.
License requirements: None.
Type¶
-
SnipFacetBodyBuilder.Type¶ Returns or sets the snipping method accessor
-------------------------------------Getter Method
Signature
Type()Returns: Return type: NXOpen.Facet.SnipFacetBodyBuilderTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(type)Parameters: type ( NXOpen.Facet.SnipFacetBodyBuilderTypes) –New in version NX7.5.0.
License requirements: None.
ViewDirection¶
-
SnipFacetBodyBuilder.ViewDirection¶ Returns or sets the view direction
-------------------------------------Getter Method
Signature
ViewDirection()Returns: Return type: NXOpen.Vector3dNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ViewDirection(viewDirection)Parameters: viewDirection ( NXOpen.Vector3d) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
SwitchRegion¶
-
SnipFacetBodyBuilder.SwitchRegion¶ Switch the region to be snipped indicated by the region point.
Signature
SwitchRegion()New in version NX7.5.0.
License requirements: None.
Validate¶
-
SnipFacetBodyBuilder.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.