nxopen

Interface Section

All Superinterfaces:

DisplayableObject, IFitTo, INXObject, NXObject, Remote, TaggedObject

public interface Section
extends DisplayableObject

Represents a section
Section consists of "chained_entity", a chain or a single entity of edge or curve. The entire chain(or a single entity) may be used by the section or only a portion of the chain (or single entity) might be used. The portion of the chain (or single entity) that is used is defined by the "start_connector" and "end_connector".

start_connector: It represents the start of the portion of the chain (or single entity) that is used. If "start_connector" is null (Nothing), then the start point of the chained_entity along its "natural" direction is used.

start_connector_intersection_point: The point of intersection of the "chained_entity" and the "start_connector". This is used to determine what portion of the chain to use in case the "start_connector" intersects the "chained_entity" in multiple locations.

end_connector: It represents the end of the portion of the chain (or single entity) that is used.

end_connector_intersection_point: The point of intersection of the "chained_entity" and the "end_connector". This is used to determine what portion of the chain to use in case the "end_connector" intersects the "chained_entity" in multiple locations.

To create a new instance of this class, use SectionCollection.createSection(double, double, double)

Created in NX3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Section.AllowTypes Defines entity types allowed.
static class	Section.DeselectOption Defines type of deselect option.
static class	Section.Mode Defines mode with respect to feature create or edit mode.
static class	Section.StartAndDirectionData This class holds the data returned from getStartAndDirection()
static class	Section.StartAndDirectionOfLoopData This class holds the data returned from getStartAndDirectionOfLoop(int)

Nested classes/interfaces inherited from interface nxopen.DisplayableObject

DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat

Method Summary

Modifier and Type	Method and Description
void	addChainBetweenIntersectionPoints(SelectionIntentRule[] rules, NXObject startConnector, Point3d startIntersectionPoint, NXObject endConnector, Point3d endIntersectionPoint, NXObject seed, Point3d helpPoint, Section.Mode featureMode, boolean chainWithinFeature) Adds a chain between given two intersection points to the section.
void	addSmartPoint(Point smartPt, double tol) Deprecated. Deprecated in NX7.5.0. Please use ScRuleFactory.createRuleCurveDumb(nxopen.Curve[]) followed by addToSection(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.NXObject, nxopen.Point3d, nxopen.Section.Mode) instead.
void	addToSection(SelectionIntentRule[] rules, NXObject seed, NXObject startConnector, NXObject endConnector, Point3d helpPoint, Section.Mode featureMode) Adds selection intent rules to the section.
void	addToSection(SelectionIntentRule[] rules, NXObject seed, NXObject startConnector, NXObject endConnector, Point3d helpPoint, Section.Mode featureMode, boolean chainWithinFeature) Adds selection intent rules to the section with the option of restricting chaining and limit discovery to a single feature.
void	alignDirectionOfLoop(Point3d point, Vector3d direction) Set the direction of a single loop of the section along the given vector.
void	allowSelfIntersection(boolean allowSelfIntersection) Allow self intersecting section or not.
double	angleTolerance() Returns the angle tolerance License requirements: gateway ("UG GATEWAY") .
double	chainingTolerance() Returns the chaining tolerance License requirements: gateway ("UG GATEWAY") .
void	cleanMappingData() Cleans Mapping Data This method should be used to clean mapping data after mapping is done License requirements: gateway ("UG GATEWAY") .
void	clear() Clear the section of all its constituents License requirements: gateway ("UG GATEWAY") .
Section	cloneSection() Clone section.
void	deselectPortion(Point3d seedPoint, NXObject startLimit, NXObject endLimit, Section.DeselectOption deselectionType) Deselects Portion of the section depending on the option provided.
void	destroy() Destroy the section object License requirements: gateway ("UG GATEWAY") .
double	distanceTolerance() Returns the distance tolerance License requirements: gateway ("UG GATEWAY") .
NXObject[]	evaluateAndAskOutputEntities() Recalculates section collection.
Section.AllowTypes	getAllowedEntityTypes() Get the Allowed Entity Types.
int	getLoopIndex(NXObject sectionElement) Returns the index of the section loop conatining the section element.
int	getLoopIndex(Point3d pointSpecifyingLoop, double tolerance) Returns the index of the loop on which the given point lies.
boolean	getMultiComponent() Gets the option set on Section for collection from multiple components.
boolean	getNonFeatureMode() Gets the option set on Section for collection in non-feature mode.
NXObject[]	getOldOutputCurves() Gives the old output curves of the section.
NXObject[]	getOutputCurves() Gives the output curves of the section.
SectionData[]	getSectionData() Gets the section data License requirements: gateway ("UG GATEWAY") .
Section.StartAndDirectionData	getStartAndDirection() Gets the start element and the direction of the section.
Section.StartAndDirectionOfLoopData	getStartAndDirectionOfLoop(int index) Gets the start point and the direction of a specified single loop of the section.
void	mapSectionElements(NXObject oldWf, NXObject newWf) Maps old section curves to new section curves This method should be used to map old section curves to new section curves when some or all curves from section are removed and some or all new curves are added.
void	prepareMappingData() Prepares Mapping Data This method should be used to create mapping data if mapping is to be done License requirements: gateway ("UG GATEWAY") .
void	removeMultipleCurves(ICurve[] wfs, NXObject[] startConnector, NXObject[] endConnector, Section.Mode featureMode) Deprecated. Deprecated in NX8.5.0. Please use removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode) instead.
void	removeMultipleElements(ICurve[] wfs, NXObject[] startConnectors, NXObject[] endConnectors, boolean[] isCombinationsResultIntoOnlyOneCurvePerCombination, Point3d[] pointsOnCurvesToBeRemoved, Point[] points, Section.Mode featureMode) Removes multiple section elements.
void	removeMultiplePoints(Point[] points, Section.Mode featureMode) Deprecated. Deprecated in NX8.5.0. Please use removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode) instead.
void	removeRules(ICurve sectionElement, NXObject startConnector, NXObject endConnector, Section.Mode featureMode) Removes all the selection intent rules related to the section element.
void	removeRules(SelectionIntentRule[] rules, NXObject startConnector, NXObject endConnector, Section.Mode featureMode) Removes selection intent rules from the section.
void	removeSingleSectionElement(ICurve sectionElement, NXObject startConnector, NXObject endConnector, Section.Mode featureMode) Removes one section element curve.
void	removeSingleSectionElement(Point sectionElement, Section.Mode featureMode) Removes one section element that is a point.
void	removeUnderlyingChain(Point3d pointSpecifyingChain, double tolerance, Section.Mode featureMode) Removes all the selection intent rules related to the chain on which the given point lies.
void	removeUnderlyingCurve(Point3d pointSpecifyingCurve, double tolerance, Section.Mode featureMode) Removes the single curve which is within tolerance to the given point, from the section.
void	reverseDirection() Reverse the section direction License requirements: gateway ("UG GATEWAY") .
void	reverseDirectionOfClosedLoop(int index) Reverse the loop direction of a closed loop while keeping the start curve same.
void	reverseDirectionOfLoop(int index) Reverse the direction of of a specified single loop of the section.
void	setAllowedEntityTypes(Section.AllowTypes allowedEntityTypes) Set the Allowed Entity Types.
void	setAllowRefCrvs(boolean allowRefCrvs) Sets to the section whether to allow reference curves or not.
void	setAngleTolerance(double angleTolerance) License requirements: gateway ("UG GATEWAY") .
void	setChainingTolerance(double chainingTolerance) License requirements: gateway ("UG GATEWAY") .
void	setDistanceTolerance(double distanceTolerance) License requirements: gateway ("UG GATEWAY") .
void	setInterpart(boolean interpart) Set inter-part state of section and make it empty.
void	setMultiComponent() Sets the true option on Section for collection from multiple components.
void	setNonFeatureMode() Sets the true option on Section for collection in non-feature mode.
void	setStartAndDirection(ICurve startElement, Point3d startPoint, Vector3d direction) Sets the start element and the direction of the section.
void	setStartCurveOfClosedLoop(int index, Point3d pointOnStartCurve) Set the curve on which the specified point lies as the start curve of a specified single loop of the section.
void	skipSorting(boolean skipSorting) Sets the option to skip sorting the section loops or not.

Methods inherited from interface nxopen.DisplayableObject

blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight

Methods inherited from interface nxopen.NXObject

deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

setChainingTolerance

void setChainingTolerance(double chainingTolerance)
                   throws NXException,
                          RemoteException

License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Parameters:

chainingTolerance - chaining tolerance

Throws:

NXException

RemoteException

setDistanceTolerance

void setDistanceTolerance(double distanceTolerance)
                   throws NXException,
                          RemoteException

License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Parameters:

distanceTolerance - distance tolerance

Throws:

NXException

RemoteException

setAngleTolerance

void setAngleTolerance(double angleTolerance)
                throws NXException,
                       RemoteException

License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Parameters:

angleTolerance - angle tolerance

Throws:

NXException

RemoteException

chainingTolerance

double chainingTolerance()
                  throws NXException,
                         RemoteException

Returns the chaining tolerance
License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Returns:

chaining tolerance

Throws:

NXException

RemoteException

distanceTolerance

double distanceTolerance()
                  throws NXException,
                         RemoteException

Returns the distance tolerance
License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Returns:

distance tolerance

Throws:

NXException

RemoteException

angleTolerance

double angleTolerance()
               throws NXException,
                      RemoteException

Returns the angle tolerance
License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Returns:

angle tolerance

Throws:

NXException

RemoteException

addToSection

void addToSection(SelectionIntentRule[] rules,
                  NXObject seed,
                  NXObject startConnector,
                  NXObject endConnector,
                  Point3d helpPoint,
                  Section.Mode featureMode)
           throws NXException,
                  RemoteException

Adds selection intent rules to the section.
License requirements: gateway ("UG GATEWAY")

Created in NX4.0.0

Parameters:

rules - Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.

seed - Seed curve, edge or face

startConnector - It represents the start of the portion of the chain (or single entity) that is used. If "start_connector" is null (Nothing), then the start point of the chained_entity along its "natural" direction is used. It can be point, curve or edge

endConnector - It represents the end of the portion of the chain (or single entity) that is used. It can be point, curve or edge

helpPoint - When ambiguity in multiple solutions is encountered, help_point is used to determine which portion of the chain to use for creating section. It is most useful when used with non-NULL connectors or with Region Boundary Curves rule.

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

addToSection

void addToSection(SelectionIntentRule[] rules,
                  NXObject seed,
                  NXObject startConnector,
                  NXObject endConnector,
                  Point3d helpPoint,
                  Section.Mode featureMode,
                  boolean chainWithinFeature)
           throws NXException,
                  RemoteException

Adds selection intent rules to the section with the option of restricting chaining and limit discovery to a single feature.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

rules - Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.

seed - Seed curve, edge or face

startConnector - It represents the start of the portion of the chain (or single entity) that is used. If "start_connector" is null (Nothing), then the start point of the chained_entity along its "natural" direction is used. It can be point, curve or edge

endConnector - It represents the end of the portion of the chain (or single entity) that is used. It can be point, curve or edge

helpPoint - When ambiguity in multiple solutions is encountered, help_point is used to determine which portion of the chain to use for creating section. It is most useful when used with non-NULL connectors or with Region Boundary Curves rule.

featureMode - Feature create or edit mode.

chainWithinFeature - True if chaining and discovery of intersection limits is to be restricted to the feature of the seed. This is effective only when the seed belongs to a curve feature.

Throws:

NXException

RemoteException

removeRules

void removeRules(SelectionIntentRule[] rules,
                 NXObject startConnector,
                 NXObject endConnector,
                 Section.Mode featureMode)
          throws NXException,
                 RemoteException

Removes selection intent rules from the section.
To get selection intent rules of the section see documentation for getSectionData() and SectionData.getRules() for more details.

License requirements: gateway ("UG GATEWAY")

Created in NX3.0.0

Parameters:

rules - Selection intent rules.

startConnector - It represents the start of the portion of the chain (or single entity) that is used. If "start_connector" is null (Nothing), then the start point of the chained_entity along its "natural" direction is used. It can be be point, curve or edge

endConnector - It represents the end of the portion of the chain (or single entity) that is used. It can be be point, curve or edge

featureMode - Feature create or edit mode

Throws:

NXException

RemoteException

removeSingleSectionElement

void removeSingleSectionElement(ICurve sectionElement,
                                NXObject startConnector,
                                NXObject endConnector,
                                Section.Mode featureMode)
                         throws NXException,
                                RemoteException

Removes one section element curve.
To get selection element see documentation for getSectionData() and SectionData.getSectionElementsData() for more details.

License requirements: gateway ("UG GATEWAY")

Created in NX4.0.0

Parameters:

sectionElement - The element that constructs the section

startConnector - The element that is connected to the section_element near its start_point

endConnector - The element that is connected to the section_element near its end_point

featureMode - Feature create or edit mode

Throws:

NXException

RemoteException

removeSingleSectionElement

void removeSingleSectionElement(Point sectionElement,
                                Section.Mode featureMode)
                         throws NXException,
                                RemoteException

Removes one section element that is a point.
To get selection element see documentation for getSectionData() and SectionData.getSectionElementsData() for more details.

License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

sectionElement - The point that constructs the section

featureMode - Feature create or edit mode

Throws:

NXException

RemoteException

removeRules

void removeRules(ICurve sectionElement,
                 NXObject startConnector,
                 NXObject endConnector,
                 Section.Mode featureMode)
          throws NXException,
                 RemoteException

Removes all the selection intent rules related to the section element.
To get selection elements of the section, see documentation for getSectionData() and SectionData.getSectionElementsData() for more details.

License requirements: gateway ("UG GATEWAY")

Created in NX4.0.0

Parameters:

sectionElement - The element that constructs the section

startConnector - The element that is connected to the section_element near its start_point

endConnector - The element that is connected to the section_element near its end_point

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

removeUnderlyingChain

void removeUnderlyingChain(Point3d pointSpecifyingChain,
                           double tolerance,
                           Section.Mode featureMode)
                    throws NXException,
                           RemoteException

Removes all the selection intent rules related to the chain on which the given point lies.
This method should be used in place of removeRules(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.Section.Mode) when the part containing the section element is not loaded.

License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

pointSpecifyingChain - The point should lie on the chain that is to be removed.

tolerance - Tolerance for specifying point on chain.

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

setStartAndDirection

void setStartAndDirection(ICurve startElement,
                          Point3d startPoint,
                          Vector3d direction)
                   throws NXException,
                          RemoteException

Sets the start element and the direction of the section.
License requirements: gateway ("UG GATEWAY")

Created in NX3.0.0

Parameters:

startElement - The element, curve or edge, specifying the starting of the section. If the section is a loop, then the loop is started by start_element and the direction is followed the input direction. If the section is not a loop, then the section can be started by other element, but the direction of the section is defined by the start_element and direction.

startPoint - The origin of the vector that defines the direction of the section. This point has to be on the start_element.

direction - The direction of the vector defines the direction of the section.

Throws:

NXException

RemoteException

getStartAndDirection

Section.StartAndDirectionData getStartAndDirection()
                                            throws NXException,
                                                   RemoteException

Gets the start element and the direction of the section.
License requirements: gateway ("UG GATEWAY")

Created in NX3.0.0

Throws:

NXException

RemoteException

getStartAndDirectionOfLoop

Section.StartAndDirectionOfLoopData getStartAndDirectionOfLoop(int index)
                                                        throws NXException,
                                                               RemoteException

Gets the start point and the direction of a specified single loop of the section.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

index - The index of the loop of the section for which start point and direction are being queried.

Throws:

NXException

RemoteException

getSectionData

SectionData[] getSectionData()
                      throws NXException,
                             RemoteException

Gets the section data
License requirements: gateway ("UG GATEWAY")
.
Created in NX3.0.0

Throws:

NXException

RemoteException

destroy

void destroy()
      throws NXException,
             RemoteException

Destroy the section object
License requirements: gateway ("UG GATEWAY")
.
Created in NX4.0.0

Throws:

NXException

RemoteException

reverseDirection

void reverseDirection()
               throws NXException,
                      RemoteException

Reverse the section direction
License requirements: gateway ("UG GATEWAY")
.
Created in NX4.0.0

Throws:

NXException

RemoteException

reverseDirectionOfLoop

void reverseDirectionOfLoop(int index)
                     throws NXException,
                            RemoteException

Reverse the direction of of a specified single loop of the section.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

index - The index of the loop of the section that is to be reversed.

Throws:

NXException

RemoteException

setStartCurveOfClosedLoop

void setStartCurveOfClosedLoop(int index,
                               Point3d pointOnStartCurve)
                        throws NXException,
                               RemoteException

Set the curve on which the specified point lies as the start curve of a specified single loop of the section.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

index - Index of the loop for which the start curve is to be set.

pointOnStartCurve - Any point on a curve that is to be set as the start curve.

Throws:

NXException

RemoteException

reverseDirectionOfClosedLoop

void reverseDirectionOfClosedLoop(int index)
                           throws NXException,
                                  RemoteException

Reverse the loop direction of a closed loop while keeping the start curve same. This API can only be used closed loops.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

index - Index of the closed loop for which the direction is to be reversed.

Throws:

NXException

RemoteException

addSmartPoint

void addSmartPoint(Point smartPt,
                   double tol)
            throws NXException,
                   RemoteException

Deprecated. Deprecated in NX7.5.0. Please use ScRuleFactory.createRuleCurveDumb(nxopen.Curve[]) followed by addToSection(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.NXObject, nxopen.Point3d, nxopen.Section.Mode) instead.

Add smart point into section.
This API is now deprecated. Please use ScRuleFactory.createRuleCurveDumb(nxopen.Curve[]) and addToSection(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.NXObject, nxopen.Point3d, nxopen.Section.Mode) instead.

License requirements: gateway ("UG GATEWAY")

Created in NX4.0.0

Parameters:

smartPt - Smart point tobe added into section.

tol - Tolerance.

Throws:

NXException

RemoteException

allowSelfIntersection

void allowSelfIntersection(boolean allowSelfIntersection)
                    throws NXException,
                           RemoteException

Allow self intersecting section or not. By default self intersection is allowed.
License requirements: gateway ("UG GATEWAY")

Created in NX4.0.0

Parameters:

allowSelfIntersection - True if self-intersecting section is allowed else false

Throws:

NXException

RemoteException

clear

void clear()
    throws NXException,
           RemoteException

Clear the section of all its constituents
License requirements: gateway ("UG GATEWAY")
.
Created in NX5.0.0

Throws:

NXException

RemoteException

getLoopIndex

int getLoopIndex(NXObject sectionElement)
          throws NXException,
                 RemoteException

Returns the index of the section loop conatining the section element. If the section element does not exist in the section or is part of more than one loops, this method will return an error.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

sectionElement - an element that constructs the section

Returns:

loop Index

Throws:

NXException

RemoteException

getLoopIndex

int getLoopIndex(Point3d pointSpecifyingLoop,
                 double tolerance)
          throws NXException,
                 RemoteException

Returns the index of the loop on which the given point lies.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.0

Parameters:

pointSpecifyingLoop - a point lying on the loop for which the loop index is being queried

tolerance - Tolerance for specifying point on loop.

Returns:

loop Index

Throws:

NXException

RemoteException

alignDirectionOfLoop

void alignDirectionOfLoop(Point3d point,
                          Vector3d direction)
                   throws NXException,
                          RemoteException

Set the direction of a single loop of the section along the given vector.
License requirements: gateway ("UG GATEWAY")

Created in NX5.0.1

Parameters:

point - Any point on a the desired loop.

direction - Desired tangent direction of the loop at the point.

Throws:

NXException

RemoteException

setInterpart

void setInterpart(boolean interpart)
           throws NXException,
                  RemoteException

Set inter-part state of section and make it empty.
This function sets the value of interpart flag on Section. Error will be raised while setting this option on Section in following conditions: (1) Multi-component option is already set on Section.

License requirements: None.

Created in NX6.0.0

Parameters:

interpart - True to set section interpart

Throws:

NXException

RemoteException

removeMultipleCurves

void removeMultipleCurves(ICurve[] wfs,
                          NXObject[] startConnector,
                          NXObject[] endConnector,
                          Section.Mode featureMode)
                   throws NXException,
                          RemoteException

Deprecated. Deprecated in NX8.5.0. Please use removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode) instead.

Removes multiple section elements that are either curves/edges.
This API is now deprecated. Please use removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode) instead.

License requirements: None.

Created in NX6.0.2

Parameters:

wfs - The elements (curves/edges) that construct the section.

startConnector - The element that is connected to the curve/edge near its start point.

endConnector - The element that is connected to the curve/edge near its end point.

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

removeMultiplePoints

void removeMultiplePoints(Point[] points,
                          Section.Mode featureMode)
                   throws NXException,
                          RemoteException

Deprecated. Deprecated in NX8.5.0. Please use removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode) instead.

Removes multiple section elements that are points.
This API is now deprecated. Please use removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode) instead.

License requirements: gateway ("UG GATEWAY")

Created in NX6.0.2

Parameters:

points - The points that construct the section.

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

removeUnderlyingCurve

void removeUnderlyingCurve(Point3d pointSpecifyingCurve,
                           double tolerance,
                           Section.Mode featureMode)
                    throws NXException,
                           RemoteException

Removes the single curve which is within tolerance to the given point, from the section.
This method should be used in place of removeSingleSectionElement(nxopen.ICurve, nxopen.NXObject, nxopen.NXObject, nxopen.Section.Mode) in any of the conditions: when the part containing the section element is not loaded, when the combination of input curve, start connector and end connector maps to multiple section element, or when underlying parent is invalid.

License requirements: gateway ("UG GATEWAY")

Created in NX6.0.2

Parameters:

pointSpecifyingCurve - The point should lie on the curve that is to be removed.

tolerance - Tolerance for specifying point on curve.

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

removeMultipleElements

void removeMultipleElements(ICurve[] wfs,
                            NXObject[] startConnectors,
                            NXObject[] endConnectors,
                            boolean[] isCombinationsResultIntoOnlyOneCurvePerCombination,
                            Point3d[] pointsOnCurvesToBeRemoved,
                            Point[] points,
                            Section.Mode featureMode)
                     throws NXException,
                            RemoteException

Removes multiple section elements.
This method should be used to remove the multiple section elements from section when elements to be removed contains points, and some or all curves that can not be uniquely mapped with wireframe , start connector and end connector. For Such curves point laying on the curve should be specified

License requirements: gateway ("UG GATEWAY")

Created in NX6.0.2

Parameters:

wfs - The elements (curves/edges) that construct the section.

startConnectors - The element that is connected to the curve/edge near its start point.

endConnectors - The element that is connected to the curve/edge near its end point.

isCombinationsResultIntoOnlyOneCurvePerCombination - Whether the combination of input curve/edge, Start Connector end Connector produces unique combination (i.e. they map to single section element) or not.

pointsOnCurvesToBeRemoved - If Combination can not define curve to be deselected uniquely, then point which lies on the curve to be removed should be provided, otherwise point must be given as (0, 0, 0) for corresponding combination

points - The points that are part of section and to be removed from the section.

featureMode - Feature create or edit mode.

Throws:

NXException

RemoteException

cloneSection

Section cloneSection()
              throws NXException,
                     RemoteException

Clone section.
License requirements: None.

Created in NX7.0.0

Returns:

the cloned section

Throws:

NXException

RemoteException

prepareMappingData

void prepareMappingData()
                 throws NXException,
                        RemoteException

Prepares Mapping Data
This method should be used to create mapping data if mapping is to be done

License requirements: gateway ("UG GATEWAY")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

cleanMappingData

void cleanMappingData()
               throws NXException,
                      RemoteException

Cleans Mapping Data
This method should be used to clean mapping data after mapping is done

License requirements: gateway ("UG GATEWAY")
.
Created in NX7.5.0

Throws:

NXException

RemoteException

getAllowedEntityTypes

Section.AllowTypes getAllowedEntityTypes()
                                  throws NXException,
                                         RemoteException

Get the Allowed Entity Types.
Works only for UF_SC_CURVE_dumb_data_s and UF_SC_CURVE_feature_data_s

License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Returns:

allowed entity types

Throws:

NXException

RemoteException

setAllowedEntityTypes

void setAllowedEntityTypes(Section.AllowTypes allowedEntityTypes)
                    throws NXException,
                           RemoteException

Set the Allowed Entity Types.
Works only for UF_SC_CURVE_dumb_data_s and UF_SC_CURVE_feature_data_s

License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Parameters:

allowedEntityTypes - Allowed entity types.

Throws:

NXException

RemoteException

mapSectionElements

void mapSectionElements(NXObject oldWf,
                        NXObject newWf)
                 throws NXException,
                        RemoteException

Maps old section curves to new section curves
This method should be used to map old section curves to new section curves when some or all curves from section are removed and some or all new curves are added.

To find old section curves see documentation for getOldOutputCurves() and to find current section curves see documentation for getOutputCurves()

License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Parameters:

oldWf - The old section curve which was removed and hence needs to be mapped.

newWf - The new section curve that would be mapped to the old section curve.

Throws:

NXException

RemoteException

getOutputCurves

NXObject[] getOutputCurves()
                    throws NXException,
                           RemoteException

Gives the output curves of the section.
This method returns an array of existing section curves. They are created internally and are different from the parent curves used to build the section. These curves should not be modified or deleted, doing so may result in part corruption and session may become unstable.

License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Throws:

NXException

RemoteException

getOldOutputCurves

NXObject[] getOldOutputCurves()
                       throws NXException,
                              RemoteException

Gives the old output curves of the section.
This method returns an array of old section curves. They were created internally and are different from the parent curves used to build the section. These curves should not be modified or deleted, doing so may result in part corruption and session may become unstable.

License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Throws:

NXException

RemoteException

deselectPortion

void deselectPortion(Point3d seedPoint,
                     NXObject startLimit,
                     NXObject endLimit,
                     Section.DeselectOption deselectionType)
              throws NXException,
                     RemoteException

Deselects Portion of the section depending on the option provided.
This method should be used to deselect portion of the section.

License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Parameters:

seedPoint - The seed point of deselection

startLimit - The element that is connected to the curve/edge near its start point.

endLimit - The element that is connected to the curve/edge near its end point.

deselectionType - The deselection type

Throws:

NXException

RemoteException

addChainBetweenIntersectionPoints

void addChainBetweenIntersectionPoints(SelectionIntentRule[] rules,
                                       NXObject startConnector,
                                       Point3d startIntersectionPoint,
                                       NXObject endConnector,
                                       Point3d endIntersectionPoint,
                                       NXObject seed,
                                       Point3d helpPoint,
                                       Section.Mode featureMode,
                                       boolean chainWithinFeature)
                                throws NXException,
                                       RemoteException

Adds a chain between given two intersection points to the section.
License requirements: gateway ("UG GATEWAY")

Created in NX7.5.0

Parameters:

rules - Selection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.

startConnector - It represents the start of the portion of the chain (or single entity) that is used. If "startConnector" is null, then the start point of the chained entity along its "natural" direction is used. It can be point, curve or edge

startIntersectionPoint - The point where the start connector intersects with the chain.

endConnector - Represents the end of the portion of the chain (or single entity) that is used. It can be point, curve or edge

endIntersectionPoint - The point where the end connector intersects with the chain.

seed - Seed curve, edge or face

helpPoint - The point which is used to determine which portion of the chain to use for creating section.

featureMode - Feature create or edit mode.

chainWithinFeature - True if chaining and discovery of intersection limits is to be restricted to the feature of the seed. This is effective only when the seed belongs to a curve feature.

Throws:

NXException

RemoteException

skipSorting

void skipSorting(boolean skipSorting)
          throws NXException,
                 RemoteException

Sets the option to skip sorting the section loops or not.
This method should be used rare scenarios. In normal situation this method should never be used. If sort option is set to true then it should be set to false after required operation is done. If sort option is set to true then section loops are not sorted and output will not be in order.

License requirements: gateway ("UG GATEWAY")

Created in NX8.0.0

Parameters:

skipSorting - True to skip sorting of section loops else false

Throws:

NXException

RemoteException

evaluateAndAskOutputEntities

NXObject[] evaluateAndAskOutputEntities()
                                 throws NXException,
                                        RemoteException

Recalculates section collection.
This is JA API for recalculating the section collection and to get the section collection after recalculation.

License requirements: gateway ("UG GATEWAY")

Created in NX9.0.0

Throws:

NXException

RemoteException

getMultiComponent

boolean getMultiComponent()
                   throws NXException,
                          RemoteException

Gets the option set on Section for collection from multiple components.
A multi-component Section can have collection from multiple components i.e., multiple parts or multiple instances of same part or both.

License requirements: None.

Created in NX9.0.0

Returns:

Multi-component option set on Section

Throws:

NXException

RemoteException

setMultiComponent

void setMultiComponent()
                throws NXException,
                       RemoteException

Sets the true option on Section for collection from multiple components.
A multi-component Section can have collection from multiple components i.e., multiple parts or multiple instances of same part or both. This method should be used only if such collection is desired. Error will be raised while setting this option on Section in following conditions: (1) Inter-part option is already set on Section.

License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

getNonFeatureMode

boolean getNonFeatureMode()
                   throws NXException,
                          RemoteException

Gets the option set on Section for collection in non-feature mode.
A Section in non-feature mode does not reference the feature data of the part from which the collection is done.

License requirements: None.

Created in NX9.0.0

Returns:

Non-feature mode set on Section

Throws:

NXException

RemoteException

setNonFeatureMode

void setNonFeatureMode()
                throws NXException,
                       RemoteException

Sets the true option on Section for collection in non-feature mode.
A Section in non-feature mode does not reference the feature data of the part from which the collection is done. The option should be set on an empty Section only. For a non-empty Section, setting this option will raise error in following conditions: (1) Section is referencing feature data and non-feature mode is set true. (2) Section is not referencing feature data and non-feature mode is set false.

License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setAllowRefCrvs

void setAllowRefCrvs(boolean allowRefCrvs)
              throws NXException,
                     RemoteException

Sets to the section whether to allow reference curves or not.
This is JA API for setting to the section whether to allow reference curves or not.

License requirements: None.

Created in NX10.0.0

Parameters:

allowRefCrvs -

Throws:

NXException

RemoteException