NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::SketchCollection Class Reference

Represents a collection of sketches
To obtain an instance of this class, refer to Part

Created in NX3.0.0. More...

Inheritance diagram for NXOpen::SketchCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element.
NXOpen::SketchAutoConstrainBuilderCreateAutoConstrainBuilder ()
 Creates a SketchAutoConstrainBuilder.
NXOpen::SketchAutoDimensionBuilderCreateAutoDimensionBuilder ()
 Creates a SketchAutoDimensionBuilder.
NXOpen::ConvertToFromReferenceBuilderCreateConvertToFromReferenceBuilder ()
 Creates a ConvertToFromReferenceBuilder.
NXOpen::SketchCornerBuilderCreateCornerBuilder ()
 Creates a SketchCornerBuilder.
NXOpen::SketchDimensionBuilderCreateDimensionBuilder (NXOpen::SketchDimensionalConstraint *constraint)
 Creates a SketchDimensionBuilder.
NXOpen::SketchEditDefiningSectionBuilderCreateEditDefiningSectionBuilder ()
 Creates a SketchEditDefiningSectionBuilder.
NXOpen::InferredConstraintsBuilderCreateInferredConstraintsBuilder ()
 Creates a InferredConstraintsBuilder.
NXOpen::SketchIntersectionCurveBuilderCreateIntersectionCurveBuilder (NXOpen::SketchIntersectionCurve *operation)
 Creates the builder for intersection curve.
NXOpen::SketchIntersectionPointBuilderCreateIntersectionPointBuilder (NXOpen::SketchIntersectionPoint *operation)
 Creates the builder for intersection point.
NXOpen::SketchMakeSymmetricBuilderCreateMakeSymmetricBuilder ()
 Creates a SketchMakeSymmetricBuilder.
NXOpen::SketchInPlaceBuilderCreateNewSketchInPlaceBuilder (NXOpen::Sketch *operation)
 Creates a SketchInPlaceBuilder.
NXOpen::SketchProjectBuilderCreateProjectBuilder (NXOpen::Features::Feature *operation)
 Creates a SketchProjectBuilder.
NXOpen::SketchQuickExtendBuilderCreateQuickExtendBuilder ()
 Creates a SketchQuickExtendBuilder.
NXOpen::SketchQuickTrimBuilderCreateQuickTrimBuilder ()
 Creates a SketchQuickTrimBuilder.
NXOpen::SketchCreateSketch (const NXString &name, NXOpen::ISurface *attachmentPlane, NXOpen::IReferenceAxis *referenceAxis, const NXOpen::Vector3d &referenceDirection, NXOpen::AxisOrientation referenceAxisOrientation, NXOpen::Sense referenceAxisSense, NXOpen::PlaneNormalOrientation normalOrientation)
 Creates a sketch.
NXOpen::SketchCreateSketch (const NXString &name, NXOpen::ISurface *attachmentPlane, NXOpen::IReferenceAxis *referenceAxis, const NXOpen::Vector3d &referenceDirection, NXOpen::AxisOrientation referenceAxisOrientation, NXOpen::Sense referenceAxisSense, NXOpen::PlaneNormalOrientation normalOrientation, NXOpen::NXObject *view)
 Creates a sketch.
NXOpen::SketchAlongPathBuilderCreateSketchAlongPathBuilder (NXOpen::Sketch *operation)
 Creates a SketchAlongPathBuilder.
NXOpen::SketchAssociativeTrimBuilderCreateSketchAssociativeTrimBuilder (NXOpen::SketchAssociativeTrim *trimCon)
 Creates a SketchAssociativeTrimBuilder.
NXOpen::SketchChamferBuilderCreateSketchChamferBuilder ()
 Creates a SketchChamferBuilder.
NXOpen::SketchConicBuilderCreateSketchConicBuilder (NXOpen::NXObject *conic)
 Creates a SketchConicBuilder.
NXOpen::SketchEllipseBuilderCreateSketchEllipseBuilder (NXOpen::NXObject *ellipse)
 Creates a SketchEllipseBuilder.
NXOpen::SketchInDraftingBuilderCreateSketchInDraftingBuilder ()
 Creates a SketchInDraftingBuilder.
NXOpen::SketchInPlaceBuilderCreateSketchInPlaceBuilder (NXOpen::Sketch *operation)
 Creates a SketchInPlaceBuilder.
NXOpen::SketchMirrorBuilderCreateSketchMirrorBuilder ()
 Creates a SketchMirrorBuilder.
NXOpen::SketchMirrorPatternBuilderCreateSketchMirrorPatternBuilder (NXOpen::SketchPattern *con)
 Creates a SketchMirrorPatternBuilder.
NXOpen::SketchOffsetBuilderCreateSketchOffsetBuilder (NXOpen::SketchOffset *offCon)
 Creates a SketchOffsetBuilder .
NXOpen::SketchPasteBuilderCreateSketchPasteBuilder (const std::vector< NXOpen::Sketch * > &sketches)
 Creates a SketchPasteBuilder.
NXOpen::SketchPatternBuilderCreateSketchPatternBuilder (NXOpen::SketchPattern *con)
 Creates a SketchPatternBuilder.
NXOpen::SketchPolygonBuilderCreateSketchPolygonBuilder (NXOpen::SketchPolygon *polygonconstraint)
 Creates a SketchPolygonBuilder.
NXOpen::Features::TrimCurveBuilderCreateTrimCurveBuilder (NXOpen::Spline *spline)
 Creates a Features::TrimCurveBuilder.
iterator end ()
 Returns an iterator addressing one past the last element.
NXOpen::SketchFindObject (const NXString &name)
 Finds the Sketch with the given name.
NXOpen::SketchGetOwningSketch (NXOpen::SmartObject *geometry)
 Returns the sketch that owns the specified geometry.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents a collection of sketches
To obtain an instance of this class, refer to Part

Created in NX3.0.0.



Member Function Documentation

Returns an iterator addressing the first element.

Creates a SketchAutoConstrainBuilder.

Returns:
Sketch Auto-Constrain Builder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchAutoDimensionBuilder.

Returns:
Sketch Auto-Dimension Builder object
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a ConvertToFromReferenceBuilder.

Returns:
Sketch ConvertToFromReferenceBuilder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchCornerBuilder.

Returns:
CornerBuilder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchDimensionBuilder.

Returns:
DimensionBuilder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
constraintThe sketch dimensional constraint to be edited.

Creates a SketchEditDefiningSectionBuilder.

Returns:
Edit Defining Section Builder object
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Creates a InferredConstraintsBuilder.

Returns:
InferredConstraintsBuilder object
Created in NX5.0.0.

License requirements : None

Creates the builder for intersection curve.

Returns:

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
operationoperation

Creates the builder for intersection point.

Returns:

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
operationoperation

Creates a SketchMakeSymmetricBuilder.

Returns:
MakeSymmetricBuilder object
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchInPlaceBuilder.

Returns:
SketchInPlaceBuilder object
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
operationThe Sketch to reattach or NULL to create a new one

Creates a SketchProjectBuilder.

Returns:
ProjectBuilder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
operationThe feature for the SketchProjectBuilder to be edited, if NULL then create a new one

Creates a SketchQuickExtendBuilder.

Returns:
Sketch Quick-Extend Builder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchQuickTrimBuilder.

Returns:
Sketch QuickTrim Builder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
NXOpen::Sketch* NXOpen::SketchCollection::CreateSketch ( const NXString name,
NXOpen::ISurface attachmentPlane,
NXOpen::IReferenceAxis referenceAxis,
const NXOpen::Vector3d referenceDirection,
NXOpen::AxisOrientation  referenceAxisOrientation,
NXOpen::Sense  referenceAxisSense,
NXOpen::PlaneNormalOrientation  normalOrientation 
)

Creates a sketch.

Returns:
the new sketch
Deprecated:
Deprecated in NX7.5.3. Use SketchInPlaceBuilder instead.


Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
nameName of the sketch. The name will be converted to upper case. If this is an empty string or NULL, a name will be provided by the system.
attachmentPlaneA face or datum plane that the sketch will be attached to. Must be planar.
referenceAxisCan be a datum axis, edge, datum plane, face, or NULL. If it is an edge, the edge must be a line segment. If it is a face, the face must be a plane. If NULL, the reference_direction is used instead
referenceDirectionIf reference_axis is NULL, this parameter sets the reference direction of the sketch. In this case, this parameter must not be (0,0,0). If reference_axis is not NULL and this parameter is not (0,0,0), this parameter determines whether the reference direction should be in the same direction as reference_axis or in the opposite direction. If this parameter is (0,0,0), this parameter is not used.
referenceAxisOrientationindicates whether the reference axis is horizontal or vertical
referenceAxisSenseIgnored unless reference_direction is (0,0,0) and reference_axis is an edge or datum axis. This parameter indicates whether the reference axis should be in the same direction as reference_axis or in the opposite direction
normalOrientationwhether the sketch's Z-axis should be outward or inward
NXOpen::Sketch* NXOpen::SketchCollection::CreateSketch ( const NXString name,
NXOpen::ISurface attachmentPlane,
NXOpen::IReferenceAxis referenceAxis,
const NXOpen::Vector3d referenceDirection,
NXOpen::AxisOrientation  referenceAxisOrientation,
NXOpen::Sense  referenceAxisSense,
NXOpen::PlaneNormalOrientation  normalOrientation,
NXOpen::NXObject view 
)

Creates a sketch.

This function takes in an argument for the view to create the sketch in a drafting member view.

Returns:
the new sketch
Deprecated:
Deprecated in NX7.5.3. Use SketchInDraftingBuilder instead.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
nameName of the sketch. The name will be converted to upper case. If this is an empty string or NULL, a name will be provided by the system.
attachmentPlaneA face or datum plane that the sketch will be attached to. Must be planar.
referenceAxisCan be a datum axis, edge, datum plane, face, or NULL. If it is an edge, the edge must be a line segment. If it is a face, the face must be a plane. If NULL, the reference_direction is used instead
referenceDirectionIf reference_axis is NULL, this parameter sets the reference direction of the sketch. In this case, this parameter must not be (0,0,0). If reference_axis is not NULL and this parameter is not (0,0,0), this parameter determines whether the reference direction should be in the same direction as reference_axis or in the opposite direction. If this parameter is (0,0,0), this parameter is not used.
referenceAxisOrientationindicates whether the reference axis is horizontal or vertical
referenceAxisSenseIgnored unless reference_direction is (0,0,0) and reference_axis is an edge or datum axis. This parameter indicates whether the reference axis should be in the same direction as reference_axis or in the opposite direction
normalOrientationwhether the sketch's Z-axis should be outward or inward
viewView of the drafting view in which the sketch needsto be created

Creates a SketchAlongPathBuilder.

Returns:
SketchAlongPathBuilder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
operationThe Sketch to reattach or NULL to create a new one

Creates a SketchAssociativeTrimBuilder.

Returns:

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
trimConTrim constraint

Creates a SketchChamferBuilder.

Returns:
Sketch Chamfer Builder object
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchConicBuilder.

Returns:
SketchConicBuilder object
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
conicThe conic to be edited.

Creates a SketchEllipseBuilder.

Returns:
SketchEllipseBuilder object
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
ellipseThe ellipse to be edited.

Creates a SketchInDraftingBuilder.

Returns:
SketchInDraftingBuilder object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchInPlaceBuilder.

Returns:
SketchInPlaceBuilder object
Deprecated:
Deprecated in NX7.5.0.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
operationThe Sketch to reattach or NULL to create a new one

Creates a SketchMirrorBuilder.

Returns:
SketchMirrorBuilder object
Deprecated:
Deprecated in NX8.0.0. Use SketchMirrorPatternBuilder instead.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Creates a SketchMirrorPatternBuilder.

Returns:

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
conPattern constraint

Creates a SketchOffsetBuilder .

This command only supports creation of up to 200 output curves. That means number of curves in input section multiplied by the number of copies must be less than or equal to 200.

Returns:

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
offConOffset constraint

Creates a SketchPasteBuilder.

Returns:

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
sketchesSketch to be copy/paste

Creates a SketchPatternBuilder.

Returns:

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
conPattern constraint

Creates a SketchPolygonBuilder.

Returns:
SketchPolygonBuilder object
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")
Parameters:
polygonconstraintThe polygon constraint. The only acceptable value here is NULL.

Creates a Features::TrimCurveBuilder.

Returns:
Trim Curve Builder object
Deprecated:
Deprecated in NX7.5.0.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters:
splineThe trimmed curve to be edited

Returns an iterator addressing one past the last element.

Finds the Sketch with the given name.

An exception will be thrown if no object can be found with the given name.

Returns:
Sketch with this name
Created in NX3.0.0.

License requirements : None
Parameters:
nameThe name of the Sketch

Returns the sketch that owns the specified geometry.

Returns:
The sketch that owns the geometry
Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
Parameters:
geometrygeometry

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.