public interface Section extends DisplayableObject
SectionCollection.createSection(double, double, double)
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) |
DisplayableObject.ObjectFont, DisplayableObject.ObjectWidth
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData
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") . |
SectionData[] |
getSectionData(boolean withOccurrenceInfo)
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.
|
blank, color, highlight, isBlanked, layer, lineFont, lineWidth, nameLocation, redisplayObject, removeViewDependency, setColor, setLayer, setLineFont, setLineWidth, setNameLocation, unblank, unhighlight
createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
void setChainingTolerance(double chainingTolerance) throws NXException, RemoteException
chainingTolerance
- chaining toleranceNXException
RemoteException
void setDistanceTolerance(double distanceTolerance) throws NXException, RemoteException
distanceTolerance
- distance toleranceNXException
RemoteException
void setAngleTolerance(double angleTolerance) throws NXException, RemoteException
angleTolerance
- angle toleranceNXException
RemoteException
double chainingTolerance() throws NXException, RemoteException
NXException
RemoteException
double distanceTolerance() throws NXException, RemoteException
NXException
RemoteException
double angleTolerance() throws NXException, RemoteException
NXException
RemoteException
void addToSection(SelectionIntentRule[] rules, NXObject seed, NXObject startConnector, NXObject endConnector, Point3d helpPoint, Section.Mode featureMode) throws NXException, RemoteException
rules
- Selection intent rules. To create selection intent rules see
documentation of ScRuleFactory
for more details.seed
- Seed curve, edge or facestartConnector
- 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 edgeendConnector
- It represents the end of the portion of the chain (or single entity) that is used.
It can be point, curve or edgehelpPoint
- 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.NXException
RemoteException
void addToSection(SelectionIntentRule[] rules, NXObject seed, NXObject startConnector, NXObject endConnector, Point3d helpPoint, Section.Mode featureMode, boolean chainWithinFeature) throws NXException, RemoteException
rules
- Selection intent rules. To create selection intent rules see
documentation of ScRuleFactory
for more details.seed
- Seed curve, edge or facestartConnector
- 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 edgeendConnector
- It represents the end of the portion of the chain (or single entity) that is used.
It can be point, curve or edgehelpPoint
- 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.NXException
RemoteException
void removeRules(SelectionIntentRule[] rules, NXObject startConnector, NXObject endConnector, Section.Mode featureMode) throws NXException, RemoteException
getSectionData()
and
SectionData.getRules()
for more details.
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 edgeendConnector
- It represents the end of the portion of
the chain (or single entity) that is used.
It can be be point, curve or edgefeatureMode
- Feature create or edit modeNXException
RemoteException
void removeSingleSectionElement(ICurve sectionElement, NXObject startConnector, NXObject endConnector, Section.Mode featureMode) throws NXException, RemoteException
getSectionData()
and
SectionData.getSectionElementsData()
for more details.
sectionElement
- The element that constructs the sectionstartConnector
- The element that is connected to the
section_element near its start_pointendConnector
- The element that is connected to the
section_element near its end_pointfeatureMode
- Feature create or edit modeNXException
RemoteException
void removeSingleSectionElement(Point sectionElement, Section.Mode featureMode) throws NXException, RemoteException
getSectionData()
and
SectionData.getSectionElementsData()
for more details.
sectionElement
- The point that constructs the sectionfeatureMode
- Feature create or edit modeNXException
RemoteException
void removeRules(ICurve sectionElement, NXObject startConnector, NXObject endConnector, Section.Mode featureMode) throws NXException, RemoteException
getSectionData()
and
SectionData.getSectionElementsData()
for more details.
sectionElement
- The element that constructs the sectionstartConnector
- The element that is connected to the
section_element near its start_pointendConnector
- The element that is connected to the
section_element near its end_pointfeatureMode
- Feature create or edit mode.NXException
RemoteException
void removeUnderlyingChain(Point3d pointSpecifyingChain, double tolerance, Section.Mode featureMode) throws NXException, RemoteException
removeRules(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.Section.Mode)
when
the part containing the section element is not loaded.
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.NXException
RemoteException
void setStartAndDirection(ICurve startElement, Point3d startPoint, Vector3d direction) throws NXException, RemoteException
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.NXException
RemoteException
Section.StartAndDirectionData getStartAndDirection() throws NXException, RemoteException
NXException
RemoteException
Section.StartAndDirectionOfLoopData getStartAndDirectionOfLoop(int index) throws NXException, RemoteException
index
- The index of the loop of the section for which start point
and direction are being queried.NXException
RemoteException
SectionData[] getSectionData() throws NXException, RemoteException
NXException
RemoteException
void destroy() throws NXException, RemoteException
NXException
RemoteException
void reverseDirection() throws NXException, RemoteException
NXException
RemoteException
void reverseDirectionOfLoop(int index) throws NXException, RemoteException
index
- The index of the loop of the section that is to be reversed.NXException
RemoteException
void setStartCurveOfClosedLoop(int index, Point3d pointOnStartCurve) throws NXException, RemoteException
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.NXException
RemoteException
void reverseDirectionOfClosedLoop(int index) throws NXException, RemoteException
index
- Index of the closed loop for which the direction is to be reversed.NXException
RemoteException
void addSmartPoint(Point smartPt, double tol) throws NXException, RemoteException
ScRuleFactory.createRuleCurveDumb(nxopen.Curve[])
followed by addToSection(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.NXObject, nxopen.Point3d, nxopen.Section.Mode)
instead.
ScRuleFactory.createRuleCurveDumb(nxopen.Curve[])
and addToSection(nxopen.SelectionIntentRule[], nxopen.NXObject, nxopen.NXObject, nxopen.NXObject, nxopen.Point3d, nxopen.Section.Mode)
instead.
smartPt
- Smart point tobe added into section.tol
- Tolerance.
NXException
RemoteException
void allowSelfIntersection(boolean allowSelfIntersection) throws NXException, RemoteException
allowSelfIntersection
- True if self-intersecting section is allowed else falseNXException
RemoteException
void clear() throws NXException, RemoteException
NXException
RemoteException
int getLoopIndex(NXObject sectionElement) throws NXException, RemoteException
sectionElement
- an element that constructs the sectionNXException
RemoteException
int getLoopIndex(Point3d pointSpecifyingLoop, double tolerance) throws NXException, RemoteException
pointSpecifyingLoop
- a point lying on the loop for which
the loop index is being queriedtolerance
- Tolerance for specifying point on loop.NXException
RemoteException
void alignDirectionOfLoop(Point3d point, Vector3d direction) throws NXException, RemoteException
point
- Any point on a the desired loop.direction
- Desired tangent direction of the loop at the point.NXException
RemoteException
void setInterpart(boolean interpart) throws NXException, RemoteException
interpart
- True to set section interpartNXException
RemoteException
void removeMultipleCurves(ICurve[] wfs, NXObject[] startConnector, NXObject[] endConnector, Section.Mode featureMode) throws NXException, RemoteException
removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode)
instead.
removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode)
instead.
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.
NXException
RemoteException
void removeMultiplePoints(Point[] points, Section.Mode featureMode) throws NXException, RemoteException
removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode)
instead.
removeMultipleElements(nxopen.ICurve[], nxopen.NXObject[], nxopen.NXObject[], boolean[], nxopen.Point3d[], nxopen.Point[], nxopen.Section.Mode)
instead.
points
- The points that construct the section.featureMode
- Feature create or edit mode.
NXException
RemoteException
void removeUnderlyingCurve(Point3d pointSpecifyingCurve, double tolerance, Section.Mode featureMode) throws NXException, RemoteException
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.
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.NXException
RemoteException
void removeMultipleElements(ICurve[] wfs, NXObject[] startConnectors, NXObject[] endConnectors, boolean[] isCombinationsResultIntoOnlyOneCurvePerCombination, Point3d[] pointsOnCurvesToBeRemoved, Point[] points, Section.Mode featureMode) throws NXException, RemoteException
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 combinationpoints
- The points that are part of section and to be removed from the section.featureMode
- Feature create or edit mode.NXException
RemoteException
Section cloneSection() throws NXException, RemoteException
NXException
RemoteException
void prepareMappingData() throws NXException, RemoteException
NXException
RemoteException
void cleanMappingData() throws NXException, RemoteException
NXException
RemoteException
Section.AllowTypes getAllowedEntityTypes() throws NXException, RemoteException
NXException
RemoteException
void setAllowedEntityTypes(Section.AllowTypes allowedEntityTypes) throws NXException, RemoteException
allowedEntityTypes
- Allowed entity types.NXException
RemoteException
void mapSectionElements(NXObject oldWf, NXObject newWf) throws NXException, RemoteException
getOldOutputCurves()
and to find current section curves see documentation for
getOutputCurves()
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.NXException
RemoteException
NXObject[] getOutputCurves() throws NXException, RemoteException
NXException
RemoteException
NXObject[] getOldOutputCurves() throws NXException, RemoteException
NXException
RemoteException
void deselectPortion(Point3d seedPoint, NXObject startLimit, NXObject endLimit, Section.DeselectOption deselectionType) throws NXException, RemoteException
seedPoint
- The seed point of deselectionstartLimit
- 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 typeNXException
RemoteException
void addChainBetweenIntersectionPoints(SelectionIntentRule[] rules, NXObject startConnector, Point3d startIntersectionPoint, NXObject endConnector, Point3d endIntersectionPoint, NXObject seed, Point3d helpPoint, Section.Mode featureMode, boolean chainWithinFeature) throws NXException, RemoteException
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 edgestartIntersectionPoint
- 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 edgeendIntersectionPoint
- The point where the end connector intersects with the chain.seed
- Seed curve, edge or facehelpPoint
- 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.NXException
RemoteException
void skipSorting(boolean skipSorting) throws NXException, RemoteException
skipSorting
- True to skip sorting of section loops else falseNXException
RemoteException
NXObject[] evaluateAndAskOutputEntities() throws NXException, RemoteException
NXException
RemoteException
boolean getMultiComponent() throws NXException, RemoteException
NXException
RemoteException
void setMultiComponent() throws NXException, RemoteException
NXException
RemoteException
boolean getNonFeatureMode() throws NXException, RemoteException
NXException
RemoteException
void setNonFeatureMode() throws NXException, RemoteException
NXException
RemoteException
void setAllowRefCrvs(boolean allowRefCrvs) throws NXException, RemoteException
allowRefCrvs
- NXException
RemoteException
SectionData[] getSectionData(boolean withOccurrenceInfo) throws NXException, RemoteException
withOccurrenceInfo
- True to get occurrence instead of proto informationNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.