NX Open C++ Reference Guide
|
Represents a collection of smart NXOpen::Point . More...
Classes | |
class | iterator |
Iterator for accessing the contents of the collection. More... | |
Public Types | |
enum | AlongCurveOption { AlongCurveOptionDistance, AlongCurveOptionPercent } |
Describes whether the input Scalar to the NXOpen::PointCollection::CreatePoint method is either an absolute distance or a relative percentage. More... | |
enum | PointOnCurveLocationOption { PointOnCurveLocationOptionParameter, PointOnCurveLocationOptionPercentParameter, PointOnCurveLocationOptionArcLength, PointOnCurveLocationOptionPercentArcLength } |
Describes whether the input Scalar to the NXOpen::PointCollection::CreatePoint method is a relative percentage parameter or an absolute arc length or a relative percentage arc length. More... | |
Represents a collection of smart NXOpen::Point .
Iterating this collection only returns live uncondemned objects contained in the owning part of the collection. Note that NXOpen::Point is a smart object and many smart objects are condemned as they only exist to support other objects and are not displayed.
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX3.0.0.
Describes whether the input Scalar to the NXOpen::PointCollection::CreatePoint method is either an absolute distance or a relative percentage.
Enumerator | |
---|---|
AlongCurveOptionDistance |
Scalar is an absolute distance. |
AlongCurveOptionPercent |
Scalar is a relative percentage. |
Describes whether the input Scalar to the NXOpen::PointCollection::CreatePoint method is a relative percentage parameter or an absolute arc length or a relative percentage arc length.
iterator NXOpen::PointCollection::begin | ( | ) |
Returns an iterator addressing the first element.
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | const NXOpen::Point3d & | coordinates | ) |
Creates a NXOpen::Point without parameters.
coordinates | Coordinates of a Point |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::Offset * | offset, |
NXOpen::Point * | offsetPoint, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point using a NXOpen::Point and an NXOpen::Offset .
offset | offset |
offsetPoint | Offsetting from this Point |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IParameterizedSurface * | face, |
NXOpen::Scalar * | scalarU, | ||
NXOpen::Scalar * | scalarV, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point on a Surface or NXOpen::Face via U-V NXOpen::Scalar for the surface.
face | face |
scalarU | U parameter |
scalarV | V parameter |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::View * | view, |
NXOpen::IBaseCurve * | edgeCurve1, | ||
NXOpen::IBaseCurve * | edgeCurve2, | ||
const NXOpen::Point3d & | helpPt, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point on the intersection of two NXOpen::Curve and/or NXOpen::Edge in a View.
view | view |
edgeCurve1 | Edge or Curve |
edgeCurve2 | Edge or Curve |
helpPt | Help Point for curve 1 |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::Scalar * | scalarT, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point on a NXOpen::Curve or NXOpen::Edge and NXOpen::Scalar representing the T parameter.
edgeCurve | Edge or Curve |
scalarT | T parameter |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::Scalar * | scalarT, | ||
NXOpen::PointCollection::PointOnCurveLocationOption | locationOption, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point on a NXOpen::Curve or NXOpen::Edge and NXOpen::Scalar representing the Percent parameter or Arc Length or Percent Arc Length.
edgeCurve | Edge or Curve |
scalarT | scalar value |
locationOption | Specify whether the input Scalar is Arc Length or Percent Arc Length or Percent Parameter |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::Scalar * | scalarT, | ||
NXOpen::SmartObject::UpdateOption | updateOption, | ||
bool | useReverseParameter | ||
) |
Creates a NXOpen::Point on a NXOpen::Curve or NXOpen::Edge and NXOpen::Scalar representing the T parameter.
edgeCurve | Edge or Curve |
scalarT | T parameter |
updateOption | update option |
useReverseParameter | usereverseparameter |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::Point * | pointOffset, | ||
NXOpen::Scalar * | distancePercent, | ||
NXOpen::PointCollection::AlongCurveOption | option, | ||
NXOpen::Sense | sense, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point along a NXOpen::Curve or NXOpen::Edge using a NXOpen::Point , and a NXOpen::Scalar representing the T parameter along the NXOpen::Curve .
This NXOpen::Point is derived by finding the closest NXOpen::Point on the given curve to the given NXOpen::Point and then offsetting this Point along the given NXOpen::Curve by the arc length defined by T via absolute distance or relative percent.
edgeCurve | Edge or Curve |
pointOffset | Offset from this Point |
distancePercent | Distance or Percentage |
option | Specify whether the input Scalar is distance/percentage |
sense | forward/reverse along the Edge or Curve |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::Scalar * | scalarX, |
NXOpen::Scalar * | scalarY, | ||
NXOpen::Scalar * | scalarZ, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point via three NXOpen::Scalar .
scalarX | X location |
scalarY | Y location |
scalarZ | Z location |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::Point * | pointExtract, |
NXOpen::Xform * | xform, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point via an existing NXOpen::Point using an optional NXOpen::Xform .
pointExtract | Point to be extracted |
xform | optional Xform |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::Scalar * | angle, | ||
NXOpen::Xform * | xform, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at an angle along an NXOpen::IBaseCurve .
edgeCurve | edge curve |
angle | angle in radians |
xform | optional Xform |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point via the center of an NXOpen::Edge or NXOpen::Curve .
edgeCurve | edge curve |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | curve1, |
NXOpen::IBaseCurve * | curve2, | ||
NXOpen::Point * | helpPt1, | ||
NXOpen::Point * | helpPt2, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the intersection of two Edges or Curves.
curve1 | First Edge or Curve in intersection |
curve2 | Second Edge or Curve in intersection |
helpPt1 | Optional help Point for curve 1 |
helpPt2 | Optional help Point for curve 2 |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | curve1, |
NXOpen::IBaseCurve * | curve2, | ||
const NXOpen::Point3d & | startPoint, | ||
NXOpen::View * | view, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the apparent intersection of two Edges or Curves in a view.
curve1 | First Edge or Curve in intersection |
curve2 | Second Edge or Curve in intersection |
startPoint | Start point of the intersection |
view | View in which to project the intersection |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IParameterizedSurface * | face, |
NXOpen::IBaseCurve * | curve, | ||
NXOpen::Point * | helpPt1, | ||
NXOpen::Point * | helpPt2, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the intersection of a NXOpen::IParameterizedSurface and NXOpen::IBaseCurve .
face | face |
curve | Curve in intersection |
helpPt1 | Optional help Point for face |
helpPt2 | Optional help Point for curve |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBasePlane * | plane, |
NXOpen::IBaseCurve * | curve, | ||
NXOpen::Point * | helpPt1, | ||
NXOpen::Point * | helpPt2, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the intersection of a NXOpen::IBasePlane and NXOpen::IBaseCurve .
plane | Plane or DatumPlane in intersection |
curve | Curve or Edge in intersection |
helpPt1 | Optional help Point for face |
helpPt2 | Optional help Point for curve |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IParameterizedSurface * | sphericalFace, |
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the center of a spherical face.
sphericalFace | spherical face |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::Routing::IRoutePosition * | routePosition, |
NXOpen::Xform * | xform, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the given NXOpen::Routing::IRoutePosition .
routePosition | route position |
xform | optional NXOpen::Xform |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::CartesianCoordinateSystem * | csys, |
NXOpen::Scalar * | scalarX, | ||
NXOpen::Scalar * | scalarY, | ||
NXOpen::Scalar * | scalarZ, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point via NXOpen::CartesianCoordinateSystem and three NXOpen::Scalar .
csys | Cartesian Coordinate System |
scalarX | X location |
scalarY | Y location |
scalarZ | Z location |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::Point * | point1, |
NXOpen::Point * | point2, | ||
NXOpen::Scalar * | distancePercentage, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point between two points using a NXOpen::Scalar that represents a percentage of the distance between the points.
The distance is measured from the first point to the second point. There is no limit on the percentage so the point can be outside the area between the two points.
point1 | point1 |
point2 | point2 |
distancePercentage | distance percentage |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::Expression * | exp, |
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point via an NXOpen::Expression .
exp | EXP Point |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::CAE::CAEFace * | face, |
NXOpen::Point * | projectedPoint, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a point by projecting onto a face.
face | the face to project to |
projectedPoint | the point to project onto the face |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::ScCollector * | faces, |
NXOpen::IBaseCurve * | curve, | ||
NXOpen::Point * | helpPt1, | ||
NXOpen::Point * | helpPt2, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the intersection of a connected set of faces and NXOpen::IBaseCurve .
faces | Collector object to represent connected set of faces |
curve | Curve in intersection |
helpPt1 | Optional help Point for face |
helpPt2 | Optional help Point for curve |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::SmartObject::UpdateOption | updateOption, |
NXOpen::Annotations::Annotation * | annotation, | ||
NXOpen::Scalar * | t, | ||
int | side, | ||
int | block, | ||
bool | attachFcfToDim | ||
) |
Creates a NXOpen::Point on a NXOpen::Annotations::Annotation and NXOpen::Scalar representing the T parameter.
updateOption | update option |
annotation | annotation |
t | t |
side | side |
block | block |
attachFcfToDim | attach fcf to dim |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | splarc, |
NXOpen::View * | view | ||
) |
Creates a NXOpen::Point at the center of a splarc.
splarc | splarc |
view | view |
NXOpen::Point* NXOpen::PointCollection::CreatePoint | ( | NXOpen::IBaseCurve * | edgeCurve, |
NXOpen::Scalar * | scalarT, | ||
NXOpen::PointCollection::PointOnCurveLocationOption | locationOption, | ||
NXOpen::Point * | specifiedPoint, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point on a NXOpen::Curve or NXOpen::Edge and NXOpen::Scalar representing the Location option and Location Reference.
edgeCurve | Edge or Curve |
scalarT | scalar value |
locationOption | Specify whether the input Scalar is Arc Length or Percent Arc Length or Percent Parameter |
specifiedPoint | Specify the Point for the Location Reference type 'Specified Point'. If NULL then Location Reference type is 'Start of Curve' |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreatePointOnPortExtractAlign | ( | NXOpen::SmartObject::UpdateOption | updateOption, |
NXOpen::Routing::Port * | port, | ||
NXOpen::Scalar * | distance | ||
) |
Creates a NXOpen::Point at a NXOpen::Routing::Port .
The NXOpen::Routing::Port will be extraced into the work part if necessary. If the NXOpen::Routing::Port has already been extracted, the existing extract will be used. If extraction is not required, the input NXOpen::Routing::Port will be used.
updateOption | update option |
port | NXOpen::Routing::Port |
distance | Scalar Distance |
NXOpen::Point* NXOpen::PointCollection::CreatePointOnSectionCG | ( | NXOpen::SmartObject::UpdateOption | updateOption, |
NXOpen::TaggedObject * | face | ||
) |
Creates a NXOpen::Point on the center of gravity of the sketch for a given sheet metal feature face in history free mode.
Supports Dimple, Bead, Louver, Drawn Cutout and Normal Cutout. A Null object will be returned if an inapproriate face is passed as an argument.
updateOption | Update option of smart object |
face | the feature face to associate the point with |
NXOpen::Point* NXOpen::PointCollection::CreatePointOnSurfaceAxis | ( | NXOpen::TaggedObject * | face, |
NXOpen::Scalar * | parameter, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a parameterised point on the center line axis of the given face.
face | RM Face |
parameter | RM Scalar |
updateOption | Update option of smart object |
NXOpen::Point* NXOpen::PointCollection::CreatePointSplarc | ( | NXOpen::IBaseCurve * | splarc, |
NXOpen::View * | view | ||
) |
Creates a Point draft smart point for splines as arcs.
splarc | Spline Arc |
view | View |
NXOpen::Point* NXOpen::PointCollection::CreatePointSplineDefiningPoint | ( | NXOpen::IBaseCurve * | splineCurve, |
int | definingPointIndex, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at a spline defining point.
splineCurve | Spline |
definingPointIndex | index of Spline Defining Point |
updateOption | updateoption |
NXOpen::Point* NXOpen::PointCollection::CreatePointSplinePole | ( | NXOpen::IBaseCurve * | splineCurve, |
int | poleIndex, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at a spline pole.
splineCurve | Spline |
poleIndex | index of Spline Pole |
updateOption | updateoption |
NXOpen::Point* NXOpen::PointCollection::CreateQuadrantPoint | ( | NXOpen::IBaseCurve * | curveOrEdge, |
int | quadrant, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a quadrant point.
curveOrEdge | Must be circular or elliptical |
quadrant | 0 to 3 |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreateStockOffsetPoint | ( | NXOpen::Point * | basePoint, |
NXOpen::Direction * | offsetDirr, | ||
const NXString & | offsetExpression, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a Routing "Stock Offset" point.
This stock offset point offsets itself from the input base point along the specified direction. The input expression determines the distance between the base point and the offset point. The input expression may reference the variable "MAX_PATH_STOCK_DIA" which is replaced by the current maximum diameter of stock applied to Routing segments that refer to the offset point.
basePoint | Base point to offset from. |
offsetDirr | Direction to offset along. |
offsetExpression | Offset value expression. |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreateStockOffsetPoint | ( | NXOpen::Point * | basePoint, |
NXOpen::Direction * | offsetDirr, | ||
const char * | offsetExpression, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a Routing "Stock Offset" point.
This stock offset point offsets itself from the input base point along the specified direction. The input expression determines the distance between the base point and the offset point. The input expression may reference the variable "MAX_PATH_STOCK_DIA" which is replaced by the current maximum diameter of stock applied to Routing segments that refer to the offset point.
basePoint | Base point to offset from. |
offsetDirr | Direction to offset along. |
offsetExpression | Offset value expression. |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::CreateVirtualIntersectionPoint | ( | NXOpen::IBaseCurve * | curve1, |
NXOpen::IBaseCurve * | curve2, | ||
NXOpen::Point * | helpPt1, | ||
NXOpen::Point * | helpPt2, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Creates a NXOpen::Point at the virtual intersection of two linear Edges or Curves.
curve1 | First Edge or Curve in virtual intersection |
curve2 | Second Edge or Curve in virtual intersection |
helpPt1 | Optional help Point for curve 1 |
helpPt2 | Optional help Point for curve 2 |
updateOption | update option |
void NXOpen::PointCollection::DeletePoint | ( | NXOpen::Point * | point | ) |
Deletes a NXOpen::Point by adding the point to the delete list and then updating the delete list without performing a general update.
Created in NX7.5.0.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") OR cam_base ("CAM BASE")
point | Point to be deleted |
NXOpen::Point* NXOpen::PointCollection::EditStockOffsetPoint | ( | NXOpen::Point * | basePoint, |
NXOpen::Direction * | offsetDirr, | ||
const NXString & | offsetExpression, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Edits an existing Routing "Stock Offset" point with new information.
This stock offset point offsets itself from the input base point along the specified direction. The input expression determines the distance between the base point and the offset point. The input expression may reference the variable "MAX_PATH_STOCK_DIA" which is replaced by the current maximum diameter of stock applied to Routing segments that refer to the offset point.
basePoint | Base point to offset from. |
offsetDirr | Direction to offset along. |
offsetExpression | Offset value expression. |
updateOption | update option |
NXOpen::Point* NXOpen::PointCollection::EditStockOffsetPoint | ( | NXOpen::Point * | basePoint, |
NXOpen::Direction * | offsetDirr, | ||
const char * | offsetExpression, | ||
NXOpen::SmartObject::UpdateOption | updateOption | ||
) |
Edits an existing Routing "Stock Offset" point with new information.
This stock offset point offsets itself from the input base point along the specified direction. The input expression determines the distance between the base point and the offset point. The input expression may reference the variable "MAX_PATH_STOCK_DIA" which is replaced by the current maximum diameter of stock applied to Routing segments that refer to the offset point.
basePoint | Base point to offset from. |
offsetDirr | Direction to offset along. |
offsetExpression | Offset value expression. |
updateOption | update option |
iterator NXOpen::PointCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
NXOpen::Point* NXOpen::PointCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the NXOpen::Point with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier | Identifier of the Point you want |
NXOpen::Point* NXOpen::PointCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the NXOpen::Point with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier | Identifier of the Point you want |
void NXOpen::PointCollection::RemoveParameters | ( | NXOpen::Point * | point | ) |
Removes the parameters from an associative NXOpen::Point .
Created in NX7.5.0.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") OR cam_base ("CAM BASE")
point | Point from which parameters will be removed |
tag_t NXOpen::PointCollection::Tag | ( | ) | const |
Returns the tag of this object.