Represents a sketch
Use the NXOpen::SketchCollection class to create a sketch. More...

Inheritance diagram for NXOpen::Sketch:

Classes
struct	ConstraintGeometry
	Used by the create geometric constraint methods to indicate what geometry the constraint should be applied to. More...

struct	ConstraintGeometryHelp
	Used by several constraint creation methods that need a help point or parameter to indicate how to create the constraint. More...

struct	CopyObjectData
	This structure represents a map between the original object to be copied and the corresponding copied object. More...

struct	DimensionGeometry
	Used in the dimension creation methods to indicate what geometry to create the dimension on. More...

Public Types
enum	AddEllipseOption { AddEllipseOptionTreatAsEllipse, AddEllipseOptionTreatAsConic }
	Used by NXOpen::Sketch::AddGeometry to determine whether to treat an ellipse as an ellipse or generic conic when adding the curve to a sketch. More...

enum	AlternateSolutionOption { AlternateSolutionOptionFalse, AlternateSolutionOptionTrue }
	Indicates whether the alternate solution should be used instead of the regular solution. More...

enum	AssocType { AssocTypeNone, AssocTypeStartPoint, AssocTypeEndPoint, AssocTypeArcCenter, AssocTypeTangency, AssocTypeCurvePoint, AssocTypeAnchorPoint, AssocTypeMidpoint }
	Used in NXOpen::Sketch::DimensionGeometry to indicate what type of geometry to use. More...

enum	AutoDimensioningRule { AutoDimensioningRuleSymmetric = 1, AutoDimensioningRuleAdjacentAngle, AutoDimensioningRuleLength, AutoDimensioningRuleHorizontalVertical, AutoDimensioningRuleReferenceAxes }
	Type of Auto Dimensioning rules. More...

enum	ConstraintClass { ConstraintClassNotConstraint, ConstraintClassAny, ConstraintClassGeometric, ConstraintClassDimension }
	Represents the class of the constraint. More...

enum	ConstraintGeometryHelpType { ConstraintGeometryHelpTypePoint, ConstraintGeometryHelpTypeParameter }
	Used in ConstraintHelp to indicate what type of help it is. More...

enum	ConstraintPointType { ConstraintPointTypeNone, ConstraintPointTypeStartVertex, ConstraintPointTypeEndVertex, ConstraintPointTypeArcCenter, ConstraintPointTypeSplineDefiningPoint, ConstraintPointTypeAnchor, ConstraintPointTypeSplinePole, ConstraintPointTypeMidVertex }
	Used in ConstraintGeometry to indicate what type of point, if any, the geometry is. More...

enum	ConstraintType { ConstraintTypeNoCon, ConstraintTypeFixed, ConstraintTypeHorizontal, ConstraintTypeVertical, ConstraintTypeParallel, ConstraintTypePerpendicular, ConstraintTypeCollinear, ConstraintTypeEqualLength, ConstraintTypeEqualRadius, ConstraintTypeConstantLength, ConstraintTypeConstantAngle, ConstraintTypeCoincident, ConstraintTypeConcentric, ConstraintTypeMirror, ConstraintTypePointOnCurve, ConstraintTypeMidpoint, ConstraintTypeTangent, ConstraintTypeRadiusDim, ConstraintTypeDiameterDim, ConstraintTypeHorizontalDim, ConstraintTypeVerticalDim, ConstraintTypeParallelDim, ConstraintTypePerpendicularDim, ConstraintTypeAngularDim, ConstraintTypeReservedCon1, ConstraintTypeReservedCon2, ConstraintTypeReservedCon3, ConstraintTypeReservedCon4, ConstraintTypeReservedCon5, ConstraintTypeReservedCon6, ConstraintTypePointOnString, ConstraintTypeSlope, ConstraintTypeUniformScaled, ConstraintTypeNonUniformScaled, ConstraintTypeAssocTrim, ConstraintTypeAssocOffset, ConstraintTypePerimeterDim, ConstraintTypeOffset, ConstraintTypeNormal, ConstraintTypePointOnLoop, ConstraintTypeRecipeTrim, ConstraintTypePattern, ConstraintTypeMinorAngularDim, ConstraintTypeMajorAngularDim, ConstraintTypeLastConType }
	Represents the type of constraint. More...

enum	CreateDimensionOption { CreateDimensionOptionFalse, CreateDimensionOptionTrue }
	Used in fillet to indicate whether a radius dimension should be created by the fillet. More...

enum	CreateInferConstraintSetting { CreateInferConstraintSettingOn, CreateInferConstraintSettingOff }
	Indicates if the infer constraints will be created or not. More...

enum	DeleteThirdCurveOption { DeleteThirdCurveOptionFalse, DeleteThirdCurveOptionTrue }
	Indicates whether the 3rd curve should be deleted when doing a 3 curve fillet. More...

enum	DimensionOption { DimensionOptionCreateAsDriving, DimensionOptionCreateAsReference, DimensionOptionCreateAsAutomatic }
	Used by NXOpen::Sketch::CreateDimension , NXOpen::Sketch::CreateRadialDimension NXOpen::Sketch::CreateDiameterDimension and NXOpen::Sketch::CreatePerimeterDimension to determine whether to create driving or reference dimension. More...

enum	InferConstraintsOption { InferConstraintsOptionInferNoConstraints, InferConstraintsOptionInferCoincidentConstraints }
	Used when adding a point or curve to a sketch. More...

enum	PlaneOption { PlaneOptionInferred, PlaneOptionExistingPlane, PlaneOptionNewPlane, PlaneOptionNewCsys }
	Specifies the plane type used for a Sketch. More...

enum	Status { StatusUnknown, StatusNotEvaluated, StatusUnderConstrained, StatusWellConstrained, StatusOverConstrained, StatusInconsistentlyConstrained }
	Represents the status of the sketch. More...

enum	TrimInputOption { TrimInputOptionFalse, TrimInputOptionTrue }
	Indicates whether the input curves should be trimmed when doing a fillet. More...

enum	UpdateLevel { UpdateLevelSketchOnly, UpdateLevelModel }
	Used to indicate how much the updating should occur. More...

enum	ViewReorient { ViewReorientFalse, ViewReorientTrue }
	Used to indicate whether to reorient the view when the sketch is activated. More...

Public Types inherited from NXOpen::DisplayableObject
enum	ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	specifies the object font for objects such as lines Created in NX3.0.0. More...

enum	ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	specifies object width for objects such as lines and text Created in NX3.0.0. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
void	Activate (NXOpen::Sketch::ViewReorient orientView)
	Activates the sketch Created in NX3.0.0. More...

void	AddGeometry (NXOpen::DisplayableObject *crv, NXOpen::Sketch::InferConstraintsOption inferCoincidentConstraints)
	Adds a curve or point to the sketch Created in NX3.0.0. More...

void	AddGeometry (NXOpen::DisplayableObject *crv)
	Adds a curve or point to the sketch. More...

void	AddGeometry (NXOpen::Curve *crv, NXOpen::Sketch::InferConstraintsOption inferCoincidentConstraints, NXOpen::Sketch::AddEllipseOption ellipseOption)
	Adds a curve or point to a sketch. More...

void	AddGeometry (NXOpen::Sketch::InferConstraintsOption inferCoincidentConstraints, NXOpen::Sketch::AddEllipseOption ellipseOption, const std::vector< NXOpen::SmartObject * > &curvesOrPoints)
	Adds an array of curves or points to a sketch. More...

NXOpen::ISurface *	AttachPlane ()
	Returns the plane that the sketch is attached to Created in NX3.0.0. More...

std::vector < NXOpen::SketchConstraint * >	AutoConstrain (double linearTolerance, double angularTolerance, bool allowRemoteConstraints, const std::vector< NXOpen::SmartObject * > &geometries, const std::vector< NXOpen::Sketch::ConstraintType > &autoconstraintTypes)
	Creates Automatic Constraints on input set of geometries. More...

void	BreakAssociativity (const std::vector< NXOpen::NXObject * > &sketchGeoms)
	Breaks associativity of recipe geometry (projected or intersection curves and points) in the sketch, making the curves regular sketch geometry. More...

void	ConvertToNx10Spline (NXOpen::Spline *spline)
	Convert the legacy splines to new NX10 splines. More...

std::vector< NXOpen::NXObject * >	CopyObjects (const std::vector< NXOpen::NXObject * > &inputObjects)
	Creates copies of input objects and constraints between these objects. More...

void	CopyObjectsWithDimensionOutput (const std::vector< NXOpen::NXObject * > &inputObjects, std::vector< NXOpen::NXObject * > &outputObjects, std::vector< NXOpen::NXObject * > &outputDims)
	Creates copies of input objects and constraints between these objects. More...

std::vector < NXOpen::Sketch::CopyObjectData >	CopyObjectsWithTracking (const std::vector< NXOpen::DisplayableObject * > &inputObjects)
	Creates copies of input objects and constraints between these objects. More...

NXOpen::SketchGeometricConstraint *	CreateCoincidentConstraint (const NXOpen::Sketch::ConstraintGeometry &geom1, const NXOpen::Sketch::ConstraintGeometry &geom2)
	Creates a coincident constraint. More...

NXOpen::SketchGeometricConstraint *	CreateCollinearConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates a collinear constraint. More...

NXOpen::SketchGeometricConstraint *	CreateConcentricConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates a concentric constraint. More...

NXOpen::SketchGeometricConstraint *	CreateConstantAngleConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom)
	Creates a constant angle constraint. More...

NXOpen::SketchGeometricConstraint *	CreateConstantLengthConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom)
	Creates a constant length constraint. More...

NXOpen::SketchDimensionalConstraint *	CreateDiameterDimension (const NXOpen::Sketch::DimensionGeometry &dimObject1, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression)
	Creates a diameter dimension constraint. More...

NXOpen::SketchDimensionalConstraint *	CreateDiameterDimension (const NXOpen::Sketch::DimensionGeometry &dimObject1, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression, NXOpen::Sketch::DimensionOption refDim)
	Creates a diameter dimension constraint. More...

NXOpen::SketchDimensionalConstraint *	CreateDimension (NXOpen::Sketch::ConstraintType dimType, const NXOpen::Sketch::DimensionGeometry &dimObject1, const NXOpen::Sketch::DimensionGeometry &dimObject2, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression)
	Creates a dimension between two geometric objects. More...

NXOpen::SketchDimensionalConstraint *	CreateDimension (NXOpen::Sketch::ConstraintType dimType, const NXOpen::Sketch::DimensionGeometry &dimObject1, const NXOpen::Sketch::DimensionGeometry &dimObject2, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression, NXOpen::Sketch::DimensionOption refDim)
	Creates a dimension between two geometric objects. More...

NXOpen::SketchGeometricConstraint *	CreateEqualLengthConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates an equal length constraint. More...

NXOpen::SketchGeometricConstraint *	CreateEqualRadiusConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates an equal radius constraint. More...

NXOpen::SketchGeometricConstraint *	CreateFixedConstraint (const NXOpen::Sketch::ConstraintGeometry &geom)
	Creates a fixed constraint. More...

std::vector < NXOpen::SketchGeometricConstraint * >	CreateFullyFixedConstraints (const NXOpen::Sketch::ConstraintGeometry &geom)
	Creates enough fixed constraints on the curve and all of its vertices such that the geometry is fully fixed without any redundant fixed constraints. More...

NXOpen::SketchGeometricConstraint *	CreateHorizontalConstraint (const NXOpen::Sketch::ConstraintGeometry &geom)
	Creates a horizontal constraint. More...

NXOpen::Sketch::CreateInferConstraintSetting	CreateInferConstraintsSetting ()
	Returns the toggle that controls the creation of infer constraints in sketch Created in NX4.0.0. More...

NXOpen::SketchGeometricConstraint *	CreateMidpointConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates a midpoint constraint. More...

NXOpen::SketchGeometricConstraint *	CreateNonUniformScaledConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom)
	Creates a non-uniform scale constraint. More...

NXOpen::SketchGeometricConstraint *	CreateNormalConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometryHelp &geom1Help, const NXOpen::Sketch::ConstraintGeometry &conGeom2, const NXOpen::Sketch::ConstraintGeometryHelp &geom2Help)
	Creates a normal constraint. More...

NXOpen::SketchGeometricConstraint *	CreateParallelConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates a parallel constraint. More...

NXOpen::SketchDimensionalConstraint *	CreatePerimeterDimension (const std::vector< NXOpen::Curve * > &curves, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression)
	Creates a perimeter dimension constraint. More...

NXOpen::SketchGeometricConstraint *	CreatePerpendicularConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates a perpendicular constraint. More...

NXOpen::SketchHelpedGeometricConstraint *	CreatePointOnCurveConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2, const NXOpen::Sketch::ConstraintGeometryHelp &help)
	Creates a point on curve constraint. More...

NXOpen::SketchHelpedGeometricConstraint *	CreatePointOnStringConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const std::vector< NXOpen::Curve * > &curvesInString, const NXOpen::Sketch::ConstraintGeometryHelp &helpData, int curveWhichHelpParamAppliesTo)
	Creates a point on string constraint. More...

NXOpen::SketchHelpedGeometricConstraint *	CreatePointOnStringConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, NXOpen::Curve *curveInString, const NXOpen::Sketch::ConstraintGeometryHelp &helpData)
	Creates a point on string constraint. More...

NXOpen::SketchDimensionalConstraint *	CreateRadialDimension (const NXOpen::Sketch::DimensionGeometry &dimObject1, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression)
	Creates a radial dimension constraint. More...

NXOpen::SketchDimensionalConstraint *	CreateRadialDimension (const NXOpen::Sketch::DimensionGeometry &dimObject1, const NXOpen::Point3d &dimOrigin, NXOpen::Expression *expression, NXOpen::Sketch::DimensionOption refDim)
	Creates a radial dimension constraint. More...

NXOpen::SketchGeometricConstraint *	CreateSlopeConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom1, const NXOpen::Sketch::ConstraintGeometry &conGeom2)
	Creates a slope constraint. More...

NXOpen::SketchTangentConstraint *	CreateTangentConstraint (const NXOpen::Sketch::ConstraintGeometry &geom1, const NXOpen::Sketch::ConstraintGeometryHelp &geom1Help, const NXOpen::Sketch::ConstraintGeometry &geom2, const NXOpen::Sketch::ConstraintGeometryHelp &geom2Help)
	Creates a tangent constraint. More...

NXOpen::SketchGeometricConstraint *	CreateUniformScaledConstraint (const NXOpen::Sketch::ConstraintGeometry &conGeom)
	Creates a uniform scale constraint. More...

NXOpen::SketchGeometricConstraint *	CreateVerticalConstraint (const NXOpen::Sketch::ConstraintGeometry &geom)
	Creates a vertical constraint. More...

void	Deactivate (NXOpen::Sketch::ViewReorient orientView, NXOpen::Sketch::UpdateLevel updateLevel)
	Deactivates the sketch Created in NX3.0.0. More...

void	DeleteConstraintsOnGeometries (const std::vector< NXOpen::NXObject * > &objects)
	Deletes all geometric constraints associated with the object and all of its vertices. More...

void	DeleteConstraintsOnGeometries (const std::vector< NXOpen::Sketch::ConstraintGeometry > &objects)
	Deletes all geometric constraints associated with the object and all of its vertices. More...

void	DeleteConstraintsOnGeometries (NXOpen::Sketch::ConstraintClass conClass, const std::vector< NXOpen::Sketch::ConstraintGeometry > &objects)
	Deletes constraints associated with the input sketch geometry and vertices according to the constraint class, e.g.,. More...

NXOpen::ErrorList *	DeleteObjects (const std::vector< NXOpen::NXObject * > &objects)
	Deletes objects from the sketch. More...

bool	DOFDisplay ()
	Returns a flag indicating whether the degree of freedom arrows are currently being displayed Created in NX3.0.0. More...

void	EditSplineDefiningPoints (NXOpen::Spline *spline, const std::vector< double > &points)
	Changes the locations of the defining points of a spline. More...

void	EditSplinePoles (NXOpen::Spline *spline, const std::vector< double > &poles)
	Changes the locations of the control poles of a spline. More...

NXOpen::Features::Feature *	Feature ()
	Returns the feature associated with this sketch Created in NX3.0.0. More...

std::vector< NXOpen::Arc * >	Fillet (NXOpen::Curve curve1, NXOpen::Curve curve2, const NXOpen::Point3d &helpPoint1, const NXOpen::Point3d &helpPoint2, double radius, NXOpen::Sketch::TrimInputOption doTrim, NXOpen::Sketch::CreateDimensionOption createRadiusDim, NXOpen::Sketch::AlternateSolutionOption alternateSolution, std::vector< NXOpen::SketchConstraint * > &constraints)
	Fillets curves and creates appropriate constraints. More...

std::vector< NXOpen::Arc * >	Fillet (NXOpen::Curve curve1, NXOpen::Curve curve2, const NXOpen::Point3d &helpPoint1, const NXOpen::Point3d &helpPoint2, const NXOpen::Point3d &pointOnArc, double radius, NXOpen::Sketch::TrimInputOption doTrim, NXOpen::Sketch::CreateDimensionOption createRadiusDim, NXOpen::Sketch::AlternateSolutionOption alternateSolution, std::vector< NXOpen::SketchConstraint * > &constraints)
	Fillets curves and creates appropriate constraints. More...

std::vector< NXOpen::Arc * >	Fillet (NXOpen::Curve curve1, NXOpen::Curve curve2, NXOpen::Curve curve3, const NXOpen::Point3d &helpPoint1, const NXOpen::Point3d &helpPoint2, const NXOpen::Point3d &helpPoint3, double radius, NXOpen::Sketch::TrimInputOption doTrim, NXOpen::Sketch::DeleteThirdCurveOption doDelete, NXOpen::Sketch::CreateDimensionOption createRadiusDim, NXOpen::Sketch::AlternateSolutionOption alternateSolution, std::vector< NXOpen::SketchConstraint > &constraints)
	Fillets curves and creates appropriate constraints. More...

std::vector< NXOpen::Arc * >	Fillet (NXOpen::Curve curve1, NXOpen::Curve curve2, NXOpen::Curve curve3, const NXOpen::Point3d &helpPoint1, const NXOpen::Point3d &helpPoint2, const NXOpen::Point3d &helpPoint3, const NXOpen::Point3d &pointOnArc, double radius, NXOpen::Sketch::TrimInputOption doTrim, NXOpen::Sketch::DeleteThirdCurveOption doDelete, NXOpen::Sketch::CreateDimensionOption createRadiusDim, NXOpen::Sketch::AlternateSolutionOption alternateSolution, std::vector< NXOpen::SketchConstraint > &constraints)
	Fillets curves and creates appropriate constraints. More...

void	FlipNormal ()
	Flips the outward normal vector of the sketch Created in NX3.0.0. More...

void	FlipReferenceDirection ()
	Flips the reference direction of the sketch Created in NX3.0.0. More...

std::vector < NXOpen::SketchConstraint * >	GetAllConstraintsOfType (NXOpen::Sketch::ConstraintClass conClass, NXOpen::Sketch::ConstraintType conType)
	Gets all constraints in the sketch of a particular type. More...

std::vector< NXOpen::Expression * >	GetAllExpressions ()
	Returns all the expressions in the sketch. More...

std::vector< NXOpen::NXObject * >	GetAllGeometry ()
	Returns all the curves and points in the sketch. More...

std::vector < NXOpen::SketchConstraint * >	GetConstraintsForGeometry (NXOpen::SmartObject *geometry, NXOpen::Sketch::ConstraintClass conClass)
	Gets all the constraints associated with a particular geometric item. More...

NXOpen::Vector3d	GetReferenceDirection (NXOpen::IReferenceAxis *referenceAxis, NXOpen::AxisOrientation referenceAxisOrientation, NXOpen::Sense *referenceAxisSense)
	Gets the reference direction of the sketch. More...

NXOpen::Sketch::Status	GetStatus (int *dofNeeded)
	Gets the status of the sketch and the number of degrees of freedom that remain in the sketch. More...

void	HideDimensions (const std::vector< NXOpen::DisplayableObject * > &inputObjects)
	Blanks dimensions in the active sketch associated with the input sketch geometry. More...

void	HideDimensions ()
	Blanks all the dimensions of input sketch Created in NX6.0.1. More...

void	HideDimensions (const std::vector< NXOpen::Sketch::ConstraintGeometry > &objects)
	Blanks dimensions in the active sketch associated with the input sketch geometry. More...

bool	IsActive ()
	Returns true if the sketch is active Created in NX3.0.0. More...

bool	IsDraftingSketch ()
	Returns true if drafting sketch Created in NX6.0.0. More...

bool	IsInternal ()
	Returns true if the sketch is internal. More...

void	LocalUpdate ()
	Update the sketch and not the sketch children. More...

void	MakeDatumsExternal ()
	Makes the internal sketch placement face and directional reference datums external. More...

void	MakeDatumsExternal2 ()
	Makes the internal sketch placement face and directional reference datums external. More...

void	MakeDatumsInternal ()
	Makes the sketch placement face and directional reference internal to the sketch if they are both datums referenced only by the sketch. More...

void	ManageConstraintsAfterEdit (const std::vector< NXOpen::NXObject * > &sketchGeoms, bool preserveComplexConstraints)
	Deletes or adjusts constraints of the input geometry that are incompatible after geometry edit. More...

NXOpen::NXMatrix *	Orientation ()
	Returns the orientation matrix of the local coordinate system of the sketch Created in NX3.0.0. More...

NXOpen::Point3d	Origin ()
	Returns the location of the origin of the local coordinate system for the sketch Created in NX3.0.0. More...

NXOpen::Preferences::SketchPreferences *	Preferences ()
	Contains preferences for the sketch Created in NX3.0.0. More...

void	Reattach (NXOpen::ISurface attachmentPlane, NXOpen::IReferenceAxis referenceAxis, const NXOpen::Vector3d &referenceDirection, NXOpen::AxisOrientation referenceAxisOrientation, NXOpen::Sense referenceAxisSense, NXOpen::PlaneNormalOrientation normalOrientation, const NXOpen::Point3d &localCoordinateSystemOrigin)
	Reattaches a sketch. More...

void	RemoveRedundantVertices (const std::vector< NXOpen::NXObject * > &geoms)
	Remove redundant vertices of the given sketch geometry Created in NX11.0.0. More...

void	RunAutoDimension ()
	Run auto dimensioning. More...

void	Scale (double scaleFactor)
	Scale the sketch entities by the given scale factor. More...

void	SetCreateInferConstraintsSetting (NXOpen::Sketch::CreateInferConstraintSetting createInferCon)
	Sets the toggle that controls the creation of infer constraints in sketch Created in NX4.0.0. More...

void	SetDOFDisplay (bool displayDof)
	Sets a flag indicating whether the degree of freedom arrows are currently being displayed Created in NX3.0.0. More...

void	SetReferenceDirection (NXOpen::IReferenceAxis *referenceAxis, const NXOpen::Vector3d &referenceDirection, NXOpen::AxisOrientation referenceAxisOrientation, NXOpen::Sense referenceAxisSense)
	Sets the reference direction of the sketch. More...

void	SetUpdateScope (NXOpen::Sketch::UpdateLevel updateScope)
	Sets the current update scope. More...

void	ShowDimensions (const std::vector< NXOpen::DisplayableObject * > &inputObjects)
	Unblanks dimensions in the active sketch associated with the input sketch geometry Created in NX4.0.0. More...

void	ShowDimensions ()
	Unblanks all the dimensions of input sketch Created in NX6.0.1. More...

void	ShowDimensions (const std::vector< NXOpen::Sketch::ConstraintGeometry > &objects)
	Unblanks dimensions in the active sketch associated with the input sketch geometry. More...

void	Update ()
	Updates the sketch Created in NX3.0.0. More...

void	Update (const std::vector< NXOpen::NXObject * > &geoms)
	Updates the given set of geometries in the sketch Created in NX4.0.0. More...

void	UpdateConstraintDisplay ()
	Updates the constraint display without updating the sketch Created in NX3.0.0. More...

void	UpdateConstraintDisplay (const std::vector< NXOpen::SmartObject * > &geoms)
	Updates the constraint display of given set of geoms without updating the sketch Created in NX4.0.0. More...

void	UpdateDimensionDisplay ()
	Updates the dimension display without updating the sketch Created in NX4.0.0. More...

void	UpdateDimensionDisplay (const std::vector< NXOpen::SmartObject * > &geoms)
	Updates the dimension display of given set of geoms without updating the sketch Created in NX4.0.0. More...

void	UpdateDimensionDisplay (const std::vector< NXOpen::NXObject * > &dims)
	Updates the dimension display of given set of dims without updating the sketch Created in NX4.0.0. More...

void	UpdateGeometryDisplay ()
	Updates the geometry display without updating the sketch Created in NX4.0.0. More...

void	UpdateGeometryDisplay (const std::vector< NXOpen::SmartObject * > &geoms)
	Updates the geometry display of given set of geoms without updating the sketch Created in NX4.0.0. More...

NXOpen::Sketch::UpdateLevel	UpdateScope ()
	Returns the current update scope. More...

NXOpen::View *	View ()
	Returns the view corresponding to sketch Created in NX6.0.0. More...

Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object. More...

int	Color ()
	Returns the color of the object. More...

void	Highlight ()
	Highlights the object. More...

bool	IsBlanked ()
	Returns the blank status of this object. More...

int	Layer ()
	Returns the layer that the object is in. More...

NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object. More...

NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object. More...

NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name. More...

void	RedisplayObject ()
	Redisplays the object in all views. More...

void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...

void	SetColor (int color)
	Sets the color of the object. More...

void	SetLayer (int layer)
	Sets the layer that the object is in. More...

void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object. More...

void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object. More...

void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name. More...

void	Unblank ()
	Unblanks the object. More...

void	Unhighlight ()
	Unhighlights the object. More...

Public Member Functions inherited from NXOpen::NXObject
NXOpen::AttributeIterator *	CreateAttributeIterator ()
	Create an attribute iterator. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

void	DeleteUserAttributes (NXOpen::AttributeIterator *iterator, NXOpen::Update::Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator Created in NX8.0.0. More...

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index. More...

bool	GetNextUserAttribute (NXOpen::AttributeIterator iterator, NXOpen::NXObject::AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

NXString	GetPdmReferenceAttributeValue (const NXString &attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

NXString	GetPdmReferenceAttributeValue (const char *attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...

double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index. More...

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index. More...

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::AttributeIterator *iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (NXOpen::AttributeIterator *iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

bool	HasUserAttribute (NXOpen::AttributeIterator *iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator. More...

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...

virtual NXString	Name ()
	Returns the custom name of the object. More...

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...

virtual void	Print ()
	Prints a representation of this object to the system log file. More...

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute. More...

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...

virtual void	SetName (const char *name)
	Sets the custom name of the object. More...

void	SetPdmReferenceAttribute (const NXString &attributeTitle, const NXString &attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

void	SetPdmReferenceAttribute (const char attributeTitle, const char attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string. More...

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string. More...

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute. More...

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a sketch
Use the NXOpen::SketchCollection class to create a sketch.

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Sketch::AddEllipseOption

Used by NXOpen::Sketch::AddGeometry to determine whether to treat an ellipse as an ellipse or generic conic when adding the curve to a sketch.

Treating an ellipse as a conic means that the ellipse will be given an anchor point. This affects, among other things, how the ellipse behaves when it is dragged.

In order for an ellipse to be treated as a conic, its end angle minus its start angle must be less than 180 degrees.

Enumerator
AddEllipseOptionTreatAsEllipse	treat as ellipse
AddEllipseOptionTreatAsConic	treat as conic

enum NXOpen::Sketch::AlternateSolutionOption

Indicates whether the alternate solution should be used instead of the regular solution.

The alternate solution for an arc is the portion of the full circle that is left out of the regular solution. For example, if the regular solution is an arc that goes from 0 to 45 degrees, the alternate solution will be an arc with the same center and origin but that goes from 45 degrees to 360.

Enumerator
AlternateSolutionOptionFalse	Use the regular solution.
AlternateSolutionOptionTrue	Use the alternate solution.

enum NXOpen::Sketch::AssocType

Used in NXOpen::Sketch::DimensionGeometry to indicate what type of geometry to use.

Enumerator
AssocTypeNone	Use the entire geometric item, as opposed to a point.
AssocTypeStartPoint	Start point. E.g. the start point of a line
AssocTypeEndPoint	End point. E.g. the start point of a line
AssocTypeArcCenter	Center of an arc, circle, or ellipse.
AssocTypeTangency	Create the dimension tangent to the geometric item.
AssocTypeCurvePoint	A point on a spline.
AssocTypeAnchorPoint	The anchor of a conic.
AssocTypeMidpoint	The midpoint of a curve.

enum NXOpen::Sketch::AutoDimensioningRule

Type of Auto Dimensioning rules.

It should match the rule types defined in Auto Dimensioning engine. Auto Dimensioning rules affect how the dimensions are created by the Auto Dimensioner. The rules will be put in a list, the first the rule with the highest priority and the last rule with the lowest priority. The user can change the order of the rules in the list to persue the flavor of the dimensions he wants. NXOpen::Sketch::AutoDimensioningRuleSymmetric : create symmetric dimensions if the curves are symmetric NXOpen::Sketch::AutoDimensioningRuleAdjacentAngle : create angles between adjacent lines NXOpen::Sketch::AutoDimensioningRuleLength : create length dimension for lines NXOpen::Sketch::AutoDimensioningRuleHorizontalVertical : create horizontal and vertical dimensions NXOpen::Sketch::AutoDimensioningRuleReferenceAxes : create dimensions between curves and reference axes

Enumerator
AutoDimensioningRuleSymmetric	Create Symmetric Dimensions.
AutoDimensioningRuleAdjacentAngle	Create Adjacent Angles.
AutoDimensioningRuleLength	Create Length Dimension.
AutoDimensioningRuleHorizontalVertical	Create Horizontal and Vertical Dimensions.
AutoDimensioningRuleReferenceAxes	Create Dimensions to Reference Axes.

enum NXOpen::Sketch::ConstraintClass

Represents the class of the constraint.

There are two classes of constraints: geometric and dimension

Enumerator
ConstraintClassNotConstraint	not constraint
ConstraintClassAny	Used in query methods that filter by constraint class to select both types of constraints.
ConstraintClassGeometric	A non-dimension constraint.
ConstraintClassDimension	A dimensional constraint.

enum NXOpen::Sketch::ConstraintGeometryHelpType

Used in ConstraintHelp to indicate what type of help it is.

Enumerator
ConstraintGeometryHelpTypePoint	point
ConstraintGeometryHelpTypeParameter	parameter

enum NXOpen::Sketch::ConstraintPointType

Used in ConstraintGeometry to indicate what type of point, if any, the geometry is.

Enumerator
ConstraintPointTypeNone	The geometry is not a point.
ConstraintPointTypeStartVertex	Start vertex (e.g. the start point of a line)
ConstraintPointTypeEndVertex	End vertex (e.g. the end point of a line)
ConstraintPointTypeArcCenter	Center of a circle, arc, or ellipse.
ConstraintPointTypeSplineDefiningPoint	A defining point of a spline.
ConstraintPointTypeAnchor	The anchor point of a conic.
ConstraintPointTypeSplinePole	The control pole of a spline.
ConstraintPointTypeMidVertex	The mid vertex of a line or an arc.

enum NXOpen::Sketch::ConstraintType

Represents the type of constraint.

Enumerator
ConstraintTypeNoCon	Used in query methods that filter by constraint type to select any type of constraint.
ConstraintTypeFixed	fixed
ConstraintTypeHorizontal	horizontal
ConstraintTypeVertical	vertical
ConstraintTypeParallel	parallel
ConstraintTypePerpendicular	perpendicular
ConstraintTypeCollinear	collinear
ConstraintTypeEqualLength	equal length
ConstraintTypeEqualRadius	equal radius
ConstraintTypeConstantLength	constant length
ConstraintTypeConstantAngle	constant angle
ConstraintTypeCoincident	coincident
ConstraintTypeConcentric	concentric
ConstraintTypeMirror	mirror
ConstraintTypePointOnCurve	point on curve
ConstraintTypeMidpoint	midpoint
ConstraintTypeTangent	tangent
ConstraintTypeRadiusDim	radius dim
ConstraintTypeDiameterDim	diameter dim
ConstraintTypeHorizontalDim	horizontal dim
ConstraintTypeVerticalDim	vertical dim
ConstraintTypeParallelDim	parallel dim
ConstraintTypePerpendicularDim	perpendicular dim
ConstraintTypeAngularDim	system will decide if it is major or minor
ConstraintTypeReservedCon1	Do not use.
ConstraintTypeReservedCon2	Do not use.
ConstraintTypeReservedCon3	Do not use.
ConstraintTypeReservedCon4	Do not use.
ConstraintTypeReservedCon5	Do not use.
ConstraintTypeReservedCon6	Do not use.
ConstraintTypePointOnString	point on string
ConstraintTypeSlope	slope
ConstraintTypeUniformScaled	uniform scaled
ConstraintTypeNonUniformScaled	non uniform scaled
ConstraintTypeAssocTrim	Limited support.
ConstraintTypeAssocOffset	Limited support.
ConstraintTypePerimeterDim	perimeter dim
ConstraintTypeOffset	offset
ConstraintTypeNormal	normal
ConstraintTypePointOnLoop	point on loop
ConstraintTypeRecipeTrim	recipe trim
ConstraintTypePattern	pattern
ConstraintTypeMinorAngularDim	minor angular dim
ConstraintTypeMajorAngularDim	major angular dim
ConstraintTypeLastConType	The last constraint type indicator; NOT to be used.

enum NXOpen::Sketch::CreateDimensionOption

Used in fillet to indicate whether a radius dimension should be created by the fillet.

Enumerator
CreateDimensionOptionFalse	Do not create a radius dimension.
CreateDimensionOptionTrue	Create a radius dimension.

enum NXOpen::Sketch::CreateInferConstraintSetting

Indicates if the infer constraints will be created or not.

Enumerator
CreateInferConstraintSettingOn	Create infer constraints.
CreateInferConstraintSettingOff	Dont create infer constraints.

enum NXOpen::Sketch::DeleteThirdCurveOption

Indicates whether the 3rd curve should be deleted when doing a 3 curve fillet.

Enumerator
DeleteThirdCurveOptionFalse	Do not delete the 3rd curve.
DeleteThirdCurveOptionTrue	Delete the 3rd curve.

enum NXOpen::Sketch::DimensionOption

Used by NXOpen::Sketch::CreateDimension , NXOpen::Sketch::CreateRadialDimension NXOpen::Sketch::CreateDiameterDimension and NXOpen::Sketch::CreatePerimeterDimension to determine whether to create driving or reference dimension.

Enumerator
DimensionOptionCreateAsDriving	Create dimension as driving.
DimensionOptionCreateAsReference	Create dimension as reference.
DimensionOptionCreateAsAutomatic	Create dimension as automatic.

enum NXOpen::Sketch::InferConstraintsOption

Used when adding a point or curve to a sketch.

Specifies whether to infer coincident constraints between the geometry that already exists in the sketch and the geometry being added to the sketch. If you choose to infer constraints, coincident constraints will be created if an end point of the geometry being added is at the same location (within system tolerance) as another end point in the sketch.

Enumerator
InferConstraintsOptionInferNoConstraints	Do not infer constraints.
InferConstraintsOptionInferCoincidentConstraints	Infer constraints.

enum NXOpen::Sketch::PlaneOption

Specifies the plane type used for a Sketch.

Enumerator
PlaneOptionInferred	Use inferred plane.
PlaneOptionExistingPlane	Use existing plane.
PlaneOptionNewPlane	Use new plane.
PlaneOptionNewCsys	Use new CSYS.

enum NXOpen::Sketch::Status

Represents the status of the sketch.

Enumerator
StatusUnknown	unknown
StatusNotEvaluated	not evaluated
StatusUnderConstrained	More constraints are needed to fully constrain the sketch.
StatusWellConstrained	The sketch is fully constrained.
StatusOverConstrained	The sketch has more constraints than is needed.
StatusInconsistentlyConstrained	The sketch has conflicting constraints.

enum NXOpen::Sketch::TrimInputOption

Indicates whether the input curves should be trimmed when doing a fillet.

Enumerator
TrimInputOptionFalse	Do not trim the input curves.
TrimInputOptionTrue	Trim the input curves.

enum NXOpen::Sketch::UpdateLevel

Used to indicate how much the updating should occur.

Enumerator
UpdateLevelSketchOnly	Only update the sketch.
UpdateLevelModel	Update the full model and the sketch.

enum NXOpen::Sketch::ViewReorient

Used to indicate whether to reorient the view when the sketch is activated.

Enumerator
ViewReorientFalse	Do not reorient view to sketch.
ViewReorientTrue	Reorient view to sketch.

Member Function Documentation

void NXOpen::Sketch::Activate ( NXOpen::Sketch::ViewReorient orientView )

Activates the sketch
Created in NX3.0.0.

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

Parameters

orientView Indicates whether to orient the view to the sketch during activation

void NXOpen::Sketch::AddGeometry	(	NXOpen::DisplayableObject *	crv,
		NXOpen::Sketch::InferConstraintsOption	inferCoincidentConstraints
	)

Adds a curve or point to the sketch
Created in NX3.0.0.

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

Parameters

crv	Must be a curve or point
inferCoincidentConstraints	Whether to automatically create coincident constraints when adding the geometry. If this flag is true and there exists another curve or point in the sketch that has a vertex that is at the same location (within system tolerance) as one of the vertices for crv, a coincident constraint will be created

void NXOpen::Sketch::AddGeometry ( NXOpen::DisplayableObject * crv )

Adds a curve or point to the sketch.

Infers coincident constraints with other geometry in the sketch
Created in NX3.0.0.

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

Parameters

crv	Must be a curve or point

void NXOpen::Sketch::AddGeometry	(	NXOpen::Curve *	crv,
		NXOpen::Sketch::InferConstraintsOption	inferCoincidentConstraints,
		NXOpen::Sketch::AddEllipseOption	ellipseOption
	)

Adds a curve or point to a sketch.

Created in NX3.0.0.

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

Parameters

crv	Must be a curve or point
inferCoincidentConstraints	Whether to automatically create coincident constraints when adding the geometry. If this flag is true and there exists another curve or point in the sketch that has a vertex that is at the same location (within system tolerance) as one of the vertices for crv, a coincident constraint will be created
ellipseOption	If you are adding an ellipse to the sketch, this parameter indicates whether the ellipse should be treated as an ellipse or general conic. If you are not adding an ellipse, the option is ignored. See the documentation for NXOpen::Sketch::AddEllipseOption for more details. The default value is NXOpen::Sketch::AddEllipseOptionTreatAsEllipse . In order to treat an ellipse as a conic, its end angle minus its start angle must be less than 180 degrees.

void NXOpen::Sketch::AddGeometry	(	NXOpen::Sketch::InferConstraintsOption	inferCoincidentConstraints,
		NXOpen::Sketch::AddEllipseOption	ellipseOption,
		const std::vector< NXOpen::SmartObject * > &	curvesOrPoints
	)

Adds an array of curves or points to a sketch.

Created in NX6.0.1.

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

Parameters

inferCoincidentConstraints	Whether to automatically create coincident constraints when adding the geometry. If this flag is true and there exists another curve or point in the sketch that has a vertex that is at the same location (within system tolerance) as one of the vertices for crv, a coincident constraint will be created
ellipseOption	If you are adding an ellipse to the sketch, this parameter indicates whether the ellipse should be treated as an ellipse or general conic. If you are not adding an ellipse, the option is ignored. See the documentation for NXOpen::Sketch::AddEllipseOption for more details. The default value is NXOpen::Sketch::AddEllipseOptionTreatAsEllipse . In order to treat an ellipse as a conic, its end angle minus its start angle must be less than 180 degrees.
curvesOrPoints	Must be a curve or point

NXOpen::ISurface* NXOpen::Sketch::AttachPlane ( )

Returns the plane that the sketch is attached to
Created in NX3.0.0.

License requirements : None

std::vector<NXOpen::SketchConstraint *> NXOpen::Sketch::AutoConstrain	(	double	linearTolerance,
		double	angularTolerance,
		bool	allowRemoteConstraints,
		const std::vector< NXOpen::SmartObject * > &	geometries,
		const std::vector< NXOpen::Sketch::ConstraintType > &	autoconstraintTypes
	)

Creates Automatic Constraints on input set of geometries.

Returns: Array of deduced constraints
Created in NX4.0.0.

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

Parameters

linearTolerance	Capture Distance
angularTolerance	Capture Angle
allowRemoteConstraints	Allow remote constraints
geometries	Array of geometries
autoconstraintTypes	Constraint type array

void NXOpen::Sketch::BreakAssociativity ( const std::vector< NXOpen::NXObject * > & sketchGeoms )

Breaks associativity of recipe geometry (projected or intersection curves and points) in the sketch, making the curves regular sketch geometry.

Any non-recipe geometry is ignored. Call this before sketch update.
Created in NX11.0.0.

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

Parameters

sketchGeoms Recipe geometry in the active sketch

void NXOpen::Sketch::ConvertToNx10Spline ( NXOpen::Spline * spline )

Convert the legacy splines to new NX10 splines.

The input spline will be upgraded to NX10 spline. No new splines will be created to replace the input spline.
Created in NX10.0.0.

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

Parameters

spline spline

std::vector<NXOpen::NXObject *> NXOpen::Sketch::CopyObjects ( const std::vector< NXOpen::NXObject * > & inputObjects )

Creates copies of input objects and constraints between these objects.

Returns: Copies of objects
Created in NX4.0.0.

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

Parameters

inputObjects Objects to be copied

void NXOpen::Sketch::CopyObjectsWithDimensionOutput	(	const std::vector< NXOpen::NXObject * > &	inputObjects,
		std::vector< NXOpen::NXObject * > &	outputObjects,
		std::vector< NXOpen::NXObject * > &	outputDims
	)

Creates copies of input objects and constraints between these objects.

This function is same as NXOpen::Sketch::CopyObjects except that it returns an array of newly created dimensions
Created in NX6.0.0.

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

Parameters

inputObjects	Objects to be copied
outputObjects	Copies of objects
outputDims	Copies of dims

std::vector<NXOpen::Sketch::CopyObjectData> NXOpen::Sketch::CopyObjectsWithTracking ( const std::vector< NXOpen::DisplayableObject * > & inputObjects )

Creates copies of input objects and constraints between these objects.

Sketch dimensions are copied only if explicitly included in the input_objects array.

Returns: Map between the original input object and the corresponding copied object
Created in NX7.5.0.

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

Parameters

inputObjects Objects to be copied

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateCoincidentConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	geom1,
		const NXOpen::Sketch::ConstraintGeometry &	geom2
	)

Creates a coincident constraint.

Returns: The coincident constraint
Created in NX3.0.0.

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

Parameters

geom1	Must be a vertex
geom2	Must be a vertex

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateCollinearConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates a collinear constraint.

One of the input constraint geometries must be a line.

Returns: The collinear constraint
Created in NX3.0.0.

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

Parameters

conGeom1	Must be a line, linear edge, datum axis, or datum plane
conGeom2	Must be a line, linear edge, datum axis, or datum plane

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateConcentricConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates a concentric constraint.

One of the input constraint geometries must be a curve.

Returns: The concentric constraint
Created in NX3.0.0.

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

Parameters

conGeom1	Must be an arc or ellipse or edge shaped as an arc or ellipse
conGeom2	Must be an arc or ellipse or edge shaped as an arc or ellipse

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateConstantAngleConstraint ( const NXOpen::Sketch::ConstraintGeometry & conGeom )

Creates a constant angle constraint.

Returns: The constant angle constraint
Created in NX3.0.0.

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

Parameters

conGeom Must be a line

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateConstantLengthConstraint ( const NXOpen::Sketch::ConstraintGeometry & conGeom )

Creates a constant length constraint.

Returns: The constant length constraint
Created in NX3.0.0.

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

Parameters

conGeom Must be a line

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreateDiameterDimension	(	const NXOpen::Sketch::DimensionGeometry &	dimObject1,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression
	)

Creates a diameter dimension constraint.

Returns: The diametral dimension constraint
Created in NX3.0.0.

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

Parameters

dimObject1	Should be an arc
dimOrigin	The location where the dimension should be placed
expression	Defining expression for the dimension. Can be NULL

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreateDiameterDimension	(	const NXOpen::Sketch::DimensionGeometry &	dimObject1,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression,
		NXOpen::Sketch::DimensionOption	refDim
	)

Creates a diameter dimension constraint.

Accepts a flag to create the dim as driving or reference

Returns: The diametral dimension constraint
Created in NX4.0.0.

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

Parameters

dimObject1	Should be an arc
dimOrigin	The location where the dimension should be placed
expression	Defining expression for the dimension. Can be NULL
refDim	option for creating driving or reference dimension

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreateDimension	(	NXOpen::Sketch::ConstraintType	dimType,
		const NXOpen::Sketch::DimensionGeometry &	dimObject1,
		const NXOpen::Sketch::DimensionGeometry &	dimObject2,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression
	)

Creates a dimension between two geometric objects.

Do not use for radial, diameter, or perimeter dimensions. To create a radial or diameter constraint, use NXOpen::Sketch::CreateRadialDimension or NXOpen::Sketch::CreateDiameterDimension . To create a perimeter dimension, use NXOpen::Sketch::CreatePerimeterDimension

Returns: The dimensional constraint
Created in NX3.0.0.

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

Parameters

dimType	Must be one of the dimension types and should not be a radial, diametral, or perimeter dimension
dimObject1	First input geometry
dimObject2	Second input geometry
dimOrigin	The location where the dimension should be placed
expression	Defining expression for the dimension. Can be NULL

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreateDimension	(	NXOpen::Sketch::ConstraintType	dimType,
		const NXOpen::Sketch::DimensionGeometry &	dimObject1,
		const NXOpen::Sketch::DimensionGeometry &	dimObject2,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression,
		NXOpen::Sketch::DimensionOption	refDim
	)

Creates a dimension between two geometric objects.

Do not use for radial, diameter, or perimeter dimensions. To create a radial or diameter constraint, use NXOpen::Sketch::CreateRadialDimension or NXOpen::Sketch::CreateDiameterDimension . To create a perimeter dimension, use NXOpen::Sketch::CreatePerimeterDimension . This function takes in an argument to create the dimension as driving or reference.

Returns: The dimensional constraint
Created in NX4.0.0.

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

Parameters

dimType	Must be one of the dimension types and should not be a radial, diametral, or perimeter dimension
dimObject1	First input geometry
dimObject2	Second input geometry
dimOrigin	The location where the dimension should be placed
expression	Defining expression for the dimension. Can be NULL
refDim	option for creating driving or reference dimension

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateEqualLengthConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates an equal length constraint.

One of the input constraint geometries must be a line.

Returns: The equal length constraint
Created in NX3.0.0.

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

Parameters

conGeom1	Must be a line or linear edge
conGeom2	Must be a line or linear edge

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateEqualRadiusConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates an equal radius constraint.

One of the input constraint geometries must be a curve.

Returns: The equal radius constraint
Created in NX3.0.0.

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

Parameters

conGeom1	Must be an arc or edge shaped as an arc
conGeom2	Must be an arc or edge shaped as an arc

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateFixedConstraint ( const NXOpen::Sketch::ConstraintGeometry & geom )

Creates a fixed constraint.

Returns: The fixed constraint
Created in NX3.0.0.

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

Parameters

geom	Can be any curve, point, or vertex in the sketch

std::vector<NXOpen::SketchGeometricConstraint *> NXOpen::Sketch::CreateFullyFixedConstraints ( const NXOpen::Sketch::ConstraintGeometry & geom )

Creates enough fixed constraints on the curve and all of its vertices such that the geometry is fully fixed without any redundant fixed constraints.

Returns: The fixed constraints
Created in NX5.0.0.

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

Parameters

geom	Can be any curve, point, or vertex in the sketch

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateHorizontalConstraint ( const NXOpen::Sketch::ConstraintGeometry & geom )

Creates a horizontal constraint.

Returns: The horizontal constraint
Created in NX3.0.0.

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

Parameters

geom	Must be a line

NXOpen::Sketch::CreateInferConstraintSetting NXOpen::Sketch::CreateInferConstraintsSetting ( )

Returns the toggle that controls the creation of infer constraints in sketch
Created in NX4.0.0.

License requirements : None

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateMidpointConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates a midpoint constraint.

One of the input constraint geometries must be a vertex and the other must be a curve or edge.

Returns: The midpoint constraint
Created in NX3.0.0.

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

Parameters

conGeom1	con geom1
conGeom2	con geom2

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateNonUniformScaledConstraint ( const NXOpen::Sketch::ConstraintGeometry & conGeom )

Creates a non-uniform scale constraint.

Returns: The non-uniform scale constraint
Created in NX3.0.0.

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

Parameters

conGeom Must be a spline

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateNormalConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometryHelp &	geom1Help,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2,
		const NXOpen::Sketch::ConstraintGeometryHelp &	geom2Help
	)

Creates a normal constraint.

A normal constraint can be created between any two curve/edge type except between two linear objects. For linear objects, create a perpendicular constraint

Returns: The normal constraint
Created in NX3.0.0.

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

Parameters

conGeom1	First input geometry for the constraint
geom1Help	Help data for first geom
conGeom2	Second input geometry for the constraint
geom2Help	Help data for second geom

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateParallelConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates a parallel constraint.

A parallel constraint can only be created between one of the following pairs: (line, line or linear edge), (line, datum axis or datum plane), (line or linear edge, ellipse), (line, ellipse or elliptical edge), (ellipse, ellipse or elliptical edge).

Returns: The parallel constraint
Created in NX3.0.0.

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

Parameters

conGeom1	First input geometry for the constraint
conGeom2	Second input geometry for the constraint

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreatePerimeterDimension	(	const std::vector< NXOpen::Curve * > &	curves,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression
	)

Creates a perimeter dimension constraint.

Returns: The perimeter dimensional constraint
Created in NX3.0.0.

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

Parameters

curves	The curves that form the perimeter
dimOrigin	Not currently used
expression	Defining expression for the dimension. Can be NULL

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreatePerpendicularConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates a perpendicular constraint.

A perpendicular constraint can only be created between one of the following pairs: (line, line or linear edge), (line, datum axis or datum plane), (line or linear edge, ellipse), (line, ellipse or elliptical edge), (ellipse, ellipse or elliptical edge).

Returns: The perpendicular constraint
Created in NX3.0.0.

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

Parameters

conGeom1	First input geometry for the constraint
conGeom2	Second input geometry for the constraint

NXOpen::SketchHelpedGeometricConstraint* NXOpen::Sketch::CreatePointOnCurveConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2,
		const NXOpen::Sketch::ConstraintGeometryHelp &	help
	)

Creates a point on curve constraint.

One of the input geometries must be a vertex and the other must be a curve, edge, datum axis, or datum plane.

Returns: The point on curve constraint
Created in NX3.0.0.

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

Parameters

conGeom1	con geom1
conGeom2	con geom2
help	help

NXOpen::SketchHelpedGeometricConstraint* NXOpen::Sketch::CreatePointOnStringConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const std::vector< NXOpen::Curve * > &	curvesInString,
		const NXOpen::Sketch::ConstraintGeometryHelp &	helpData,
		int	curveWhichHelpParamAppliesTo
	)

Creates a point on string constraint.

Returns: The point on string constraint
Created in NX3.0.0.

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

Parameters

conGeom1	Must be a vertex
curvesInString	Must all be part of the same string. (You can create a string of curves through the UI through the Edit -> Project command.)
helpData	help data
curveWhichHelpParamAppliesTo	If helpData is a parameter, this parameter indicates which curve in the curvesInString that the help parameter applies to. Otherwise, this parameter is not used

NXOpen::SketchHelpedGeometricConstraint* NXOpen::Sketch::CreatePointOnStringConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		NXOpen::Curve *	curveInString,
		const NXOpen::Sketch::ConstraintGeometryHelp &	helpData
	)

Creates a point on string constraint.

The string is specified using a single curve in the string. The constraint is created on the entire string that curveInString belongs to.

Returns: The point on string constraint
Created in NX3.0.0.

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

Parameters

conGeom1	Must be a vertex
curveInString	A curve in the string that you want to create the constraint on. The constraint is created on the entire string that this curve belongs to. (You can create a string of curves through the UI through the Edit -> Project command.)
helpData	help data

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreateRadialDimension	(	const NXOpen::Sketch::DimensionGeometry &	dimObject1,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression
	)

Creates a radial dimension constraint.

Returns: The radial dimension constraint
Created in NX3.0.0.

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

Parameters

dimObject1	Should be an arc
dimOrigin	The location where the dimension should be placed
expression	Defining expression for the dimension. Can be NULL

NXOpen::SketchDimensionalConstraint* NXOpen::Sketch::CreateRadialDimension	(	const NXOpen::Sketch::DimensionGeometry &	dimObject1,
		const NXOpen::Point3d &	dimOrigin,
		NXOpen::Expression *	expression,
		NXOpen::Sketch::DimensionOption	refDim
	)

Creates a radial dimension constraint.

Accepts a flag to create the dimension as driving or reference

Returns: The radial dimension constraint
Created in NX4.0.0.

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

Parameters

dimObject1	Should be an arc
dimOrigin	The location where the dimension should be placed
expression	Defining expression for the dimension. Can be NULL
refDim	option for creating driving or reference dimension

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateSlopeConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	conGeom1,
		const NXOpen::Sketch::ConstraintGeometry &	conGeom2
	)

Creates a slope constraint.

One of the input constraint geometries must a spline defining point. The other must be datum axis, datum plane, or a curve or edge shaped as a line, arc, ellipse, conic, or spline.

Returns: The slope constraint
Created in NX3.0.0.

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

Parameters

conGeom1	con geom1
conGeom2	con geom2

NXOpen::SketchTangentConstraint* NXOpen::Sketch::CreateTangentConstraint	(	const NXOpen::Sketch::ConstraintGeometry &	geom1,
		const NXOpen::Sketch::ConstraintGeometryHelp &	geom1Help,
		const NXOpen::Sketch::ConstraintGeometry &	geom2,
		const NXOpen::Sketch::ConstraintGeometryHelp &	geom2Help
	)

Creates a tangent constraint.

Note: the input constraint geometries cannot both be linear.

Returns: The tangent constraint
Created in NX3.0.0.

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

Parameters

geom1	A curve, edge, or datum axis
geom1Help	geom1 help
geom2	A curve, edge, or datum axis
geom2Help	geom2 help

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateUniformScaledConstraint ( const NXOpen::Sketch::ConstraintGeometry & conGeom )

Creates a uniform scale constraint.

Returns: The uniform scale constraint
Created in NX3.0.0.

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

Parameters

conGeom Must be a spline

NXOpen::SketchGeometricConstraint* NXOpen::Sketch::CreateVerticalConstraint ( const NXOpen::Sketch::ConstraintGeometry & geom )

Creates a vertical constraint.

Returns: The vertical constraint
Created in NX3.0.0.

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

Parameters

geom	Must be a line

void NXOpen::Sketch::Deactivate	(	NXOpen::Sketch::ViewReorient	orientView,
		NXOpen::Sketch::UpdateLevel	updateLevel
	)

Deactivates the sketch
Created in NX3.0.0.

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

Parameters

orientView	Indicates whether to orient the view to the model during deactivation
updateLevel	Indicates whether just the sketch should be updated or the entire model

void NXOpen::Sketch::DeleteConstraintsOnGeometries ( const std::vector< NXOpen::NXObject * > & objects )

Deletes all geometric constraints associated with the object and all of its vertices.

Converts all the driving dimensions associated with the object and its vertices to reference dimensions.
Created in NX4.0.0.

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

Parameters

objects Objects whose constraints needs to be deleted

void NXOpen::Sketch::DeleteConstraintsOnGeometries ( const std::vector< NXOpen::Sketch::ConstraintGeometry > & objects )

Deletes all geometric constraints associated with the object and all of its vertices.

Converts all the driving dimensions associated with the object and its vertices to reference dimensions. The user can pass in a vertex to do the same on just the supplied vertex.
Created in NX8.5.0.

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

Parameters

objects Objects whose constraints needs to be deleted

void NXOpen::Sketch::DeleteConstraintsOnGeometries	(	NXOpen::Sketch::ConstraintClass	conClass,
		const std::vector< NXOpen::Sketch::ConstraintGeometry > &	objects
	)

Deletes constraints associated with the input sketch geometry and vertices according to the constraint class, e.g.,.

NXOpen::Sketch::ConstraintClassAny will remove all geometric constraints and convert driving dimensions to reference dimensions.
NXOpen::Sketch::ConstraintClassGeometric will remove all geometric constraints.
NXOpen::Sketch::ConstraintClassDimension will remove all dimensions and not convert them to reference.
NXOpen::Sketch::ConstraintClassNotConstraint will not remove any geometric constraints and dimensions.

Created in NX11.0.0.

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

Parameters

conClass	Use NXOpen::Sketch::ConstraintClassAny if you do not want to filter by constraint class
objects	Objects whose constraints needs to be deleted

NXOpen::ErrorList* NXOpen::Sketch::DeleteObjects ( const std::vector< NXOpen::NXObject * > & objects )

Deletes objects from the sketch.

Returns: List of errors encountered during the delete
Created in NX3.0.0.

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

Parameters

objects Objects to be deleted

bool NXOpen::Sketch::DOFDisplay ( )

Returns a flag indicating whether the degree of freedom arrows are currently being displayed
Created in NX3.0.0.

License requirements : None

void NXOpen::Sketch::EditSplineDefiningPoints	(	NXOpen::Spline *	spline,
		const std::vector< double > &	points
	)

Changes the locations of the defining points of a spline.

The length of point array should be enough to cover existing defining points. You cannot add/remove points nor change knot sequence via this call.
Created in NX10.0.0.

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

Parameters

spline	spline
points	point locations. Size is three times the number of points.

void NXOpen::Sketch::EditSplinePoles	(	NXOpen::Spline *	spline,
		const std::vector< double > &	poles
	)

Changes the locations of the control poles of a spline.

The length of poles array should be enough to cover existing poles. You cannot add/remove poles nor change knot sequence via this call. The order of data in poles array is x, y, z, weight. You can edit any or all of these four values via this function.
Created in NX10.0.0.

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

Parameters

spline	spline
poles	pole locations. Size is four times the number of poles.

NXOpen::Features::Feature* NXOpen::Sketch::Feature ( )

Returns the feature associated with this sketch
Created in NX3.0.0.

License requirements : None

std::vector<NXOpen::Arc *> NXOpen::Sketch::Fillet	(	NXOpen::Curve *	curve1,
		NXOpen::Curve *	curve2,
		const NXOpen::Point3d &	helpPoint1,
		const NXOpen::Point3d &	helpPoint2,
		double	radius,
		NXOpen::Sketch::TrimInputOption	doTrim,
		NXOpen::Sketch::CreateDimensionOption	createRadiusDim,
		NXOpen::Sketch::AlternateSolutionOption	alternateSolution,
		std::vector< NXOpen::SketchConstraint * > &	constraints
	)

Fillets curves and creates appropriate constraints.

If the input curves have mirror constraints, the fillet is also performed on the mirror curves.

Returns: The fillet arcs that are created. If the input curves do not have any mirror constraints, the number of fillet arcs will always be one. If the input curves have mirror constraints, fillets will be created on the mirrored curves, and all the fillet arcs that were created are returned
Created in NX3.0.0.

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

Parameters

curve1	First curve for the fillet
curve2	Second curve for the fillet
helpPoint1	Should be a point on the first curve. Indicates where the fillet should be created
helpPoint2	Should be a point on the second curve. Indicates where the fillet should be created
radius	Radius of the fillet
doTrim	Indicates whether the input curves should get trimmed by the fillet
createRadiusDim	Indicates whether a radius dimension should be created
alternateSolution	Indicates whether the alternate solution should be used instead of the regular solution. The alternate solution for an arc is the portion of the full circle that is left out of the regular solution.
constraints	The constraints that were created by the fillet. If the input curves get trimmed, coincident and tangent constraints are created. If the input curves do not get trimmed, point on curve and tangent constraints are created.

std::vector<NXOpen::Arc *> NXOpen::Sketch::Fillet	(	NXOpen::Curve *	curve1,
		NXOpen::Curve *	curve2,
		const NXOpen::Point3d &	helpPoint1,
		const NXOpen::Point3d &	helpPoint2,
		const NXOpen::Point3d &	pointOnArc,
		double	radius,
		NXOpen::Sketch::TrimInputOption	doTrim,
		NXOpen::Sketch::CreateDimensionOption	createRadiusDim,
		NXOpen::Sketch::AlternateSolutionOption	alternateSolution,
		std::vector< NXOpen::SketchConstraint * > &	constraints
	)

Fillets curves and creates appropriate constraints.

If the input curves have mirror constraints, the fillet is also performed on the mirror curves.

Returns: The fillet arcs that are created. If the input curves do not have any mirror constraints, the number of fillet arcs will always be one. If the input curves have mirror constraints, fillets will be created on the mirrored curves, and all the fillet arcs that were created are returned
Created in NX7.5.0.

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

Parameters

curve1	First curve for the fillet
curve2	Second curve for the fillet
helpPoint1	Should be a point on the first curve. Indicates where the fillet should be created
helpPoint2	Should be a point on the second curve. Indicates where the fillet should be created
pointOnArc	Point on fillet arc
radius	Radius of the fillet
doTrim	Indicates whether the input curves should get trimmed by the fillet
createRadiusDim	Indicates whether a radius dimension should be created
alternateSolution	Indicates whether the alternate solution should be used instead of the regular solution. The alternate solution for an arc is the portion of the full circle that is left out of the regular solution.
constraints	The constraints that were created by the fillet. If the input curves get trimmed, coincident and tangent constraints are created. If the input curves do not get trimmed, point on curve and tangent constraints are created.

std::vector<NXOpen::Arc *> NXOpen::Sketch::Fillet	(	NXOpen::Curve *	curve1,
		NXOpen::Curve *	curve2,
		NXOpen::Curve *	curve3,
		const NXOpen::Point3d &	helpPoint1,
		const NXOpen::Point3d &	helpPoint2,
		const NXOpen::Point3d &	helpPoint3,
		double	radius,
		NXOpen::Sketch::TrimInputOption	doTrim,
		NXOpen::Sketch::DeleteThirdCurveOption	doDelete,
		NXOpen::Sketch::CreateDimensionOption	createRadiusDim,
		NXOpen::Sketch::AlternateSolutionOption	alternateSolution,
		std::vector< NXOpen::SketchConstraint * > &	constraints
	)

Fillets curves and creates appropriate constraints.

If the input curves have mirror constraints, the fillet is also performed on the mirror curves.

Returns: The fillet arcs that are created. If the input curves do not have any mirror constraints, the number of fillet arcs will always be one. If the input curves have mirror constraints, fillets will be created on the mirrored curves, and all the fillet arcs that were created are returned
Created in NX3.0.0.

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

Parameters

curve1	First curve for the fillet
curve2	Second curve for the fillet
curve3	Third curve for the fillet
helpPoint1	Should be a point on the first curve. Indicates where the fillet should be created
helpPoint2	Should be a point on the second curve. Indicates where the fillet should be created
helpPoint3	Should be a point on the third curve. Indicates where the fillet should be created
radius	Radius of the fillet
doTrim	Indicates whether the input curves should get trimmed by the fillet
doDelete	Indicates whether the third curve should be deleted
createRadiusDim	Indicates whether a radius dimension should be created
alternateSolution	Indicates whether the alternate solution should be used instead of the regular solution. The alternate solution for an arc is the portion of the full circle that is left out of the regular solution.
constraints	The constraints that were created by the fillet. If the input curves get trimmed, coincident and tangent constraints are created. If the input curves do not get trimmed, point on curve and tangent constraints are created.

std::vector<NXOpen::Arc *> NXOpen::Sketch::Fillet	(	NXOpen::Curve *	curve1,
		NXOpen::Curve *	curve2,
		NXOpen::Curve *	curve3,
		const NXOpen::Point3d &	helpPoint1,
		const NXOpen::Point3d &	helpPoint2,
		const NXOpen::Point3d &	helpPoint3,
		const NXOpen::Point3d &	pointOnArc,
		double	radius,
		NXOpen::Sketch::TrimInputOption	doTrim,
		NXOpen::Sketch::DeleteThirdCurveOption	doDelete,
		NXOpen::Sketch::CreateDimensionOption	createRadiusDim,
		NXOpen::Sketch::AlternateSolutionOption	alternateSolution,
		std::vector< NXOpen::SketchConstraint * > &	constraints
	)

Fillets curves and creates appropriate constraints.

If the input curves have mirror constraints, the fillet is also performed on the mirror curves.

Returns: The fillet arcs that are created. If the input curves do not have any mirror constraints, the number of fillet arcs will always be one. If the input curves have mirror constraints, fillets will be created on the mirrored curves, and all the fillet arcs that were created are returned
Created in NX7.5.0.

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

Parameters

curve1	First curve for the fillet
curve2	Second curve for the fillet
curve3	Third curve for the fillet
helpPoint1	Should be a point on the first curve. Indicates where the fillet should be created
helpPoint2	Should be a point on the second curve. Indicates where the fillet should be created
helpPoint3	Should be a point on the third curve. Indicates where the fillet should be created
pointOnArc	Point on fillet arc
radius	Radius of the fillet
doTrim	Indicates whether the input curves should get trimmed by the fillet
doDelete	Indicates whether the third curve should be deleted
createRadiusDim	Indicates whether a radius dimension should be created
alternateSolution	Indicates whether the alternate solution should be used instead of the regular solution. The alternate solution for an arc is the portion of the full circle that is left out of the regular solution.
constraints	The constraints that were created by the fillet. If the input curves get trimmed, coincident and tangent constraints are created. If the input curves do not get trimmed, point on curve and tangent constraints are created.

void NXOpen::Sketch::FlipNormal ( )

Flips the outward normal vector of the sketch
Created in NX3.0.0.

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

void NXOpen::Sketch::FlipReferenceDirection ( )

Flips the reference direction of the sketch
Created in NX3.0.0.

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

std::vector<NXOpen::SketchConstraint *> NXOpen::Sketch::GetAllConstraintsOfType	(	NXOpen::Sketch::ConstraintClass	conClass,
		NXOpen::Sketch::ConstraintType	conType
	)

Gets all constraints in the sketch of a particular type.

Returns: All the constraints in the sketch of the specified type
Created in NX3.0.0.

License requirements : None

Parameters

conClass	Optional filter. Use NXOpen::Sketch::ConstraintClassAny if you do not want to filter by constraint class
conType	Optional filter. Use NXOpen::Sketch::ConstraintTypeNoCon if you do not want to filter by constraint type

std::vector<NXOpen::Expression *> NXOpen::Sketch::GetAllExpressions ( )

Returns all the expressions in the sketch.

Returns: All the expressions in the sketch
Created in NX3.0.0.

License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::Sketch::GetAllGeometry ( )

Returns all the curves and points in the sketch.

Returns: All the curves and points in the sketch
Created in NX3.0.0.

License requirements : None

std::vector<NXOpen::SketchConstraint *> NXOpen::Sketch::GetConstraintsForGeometry	(	NXOpen::SmartObject *	geometry,
		NXOpen::Sketch::ConstraintClass	conClass
	)

Gets all the constraints associated with a particular geometric item.

Returns: All the constraints associated with the geometry that is input
Created in NX3.0.0.

License requirements : None

Parameters

geometry	Must be a curve or point
conClass	Optional filter. Use NXOpen::Sketch::ConstraintClassAny if you do not want to filter by constraint class

NXOpen::Vector3d NXOpen::Sketch::GetReferenceDirection	(	NXOpen::IReferenceAxis **	referenceAxis,
		NXOpen::AxisOrientation *	referenceAxisOrientation,
		NXOpen::Sense *	referenceAxisSense
	)

Gets the reference direction of the sketch.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

referenceAxis	An edge, datum axis, datum plane, or face that the sketch uses as a reference. May be NULL.
referenceAxisOrientation	Indicates whether the reference axis is horizontal or vertical
referenceAxisSense	If reference axis is an edge or datum axis, this parameter indicates whether the reference axis is in the same direction as the edge or datum axis or in the opposite direction. If reference axis is not an edge or datum axis, this parameter is not used.

NXOpen::Sketch::Status NXOpen::Sketch::GetStatus ( int * dofNeeded )

Gets the status of the sketch and the number of degrees of freedom that remain in the sketch.

The status of the sketch indicates whether the sketch is fully constrained or under, over, or inconsistently constrained.

Returns: The sketch's status, which indicates how well constrained the sketch is
Created in NX3.0.0.

License requirements : None

Parameters

dofNeeded The number of degrees of freedom left in the sketch

void NXOpen::Sketch::HideDimensions ( const std::vector< NXOpen::DisplayableObject * > & inputObjects )

Blanks dimensions in the active sketch associated with the input sketch geometry.

Created in NX4.0.0.

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

Parameters

inputObjects Geometry and groups in active sketch

void NXOpen::Sketch::HideDimensions ( )

Blanks all the dimensions of input sketch
Created in NX6.0.1.

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

void NXOpen::Sketch::HideDimensions ( const std::vector< NXOpen::Sketch::ConstraintGeometry > & objects )

Blanks dimensions in the active sketch associated with the input sketch geometry.

This function can accept vertices
Created in NX8.5.0.

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

Parameters

objects Geometry and vertices in active sketch

bool NXOpen::Sketch::IsActive ( )

Returns true if the sketch is active
Created in NX3.0.0.

License requirements : None

bool NXOpen::Sketch::IsDraftingSketch ( )

Returns true if drafting sketch
Created in NX6.0.0.

License requirements : None

bool NXOpen::Sketch::IsInternal ( )

Returns true if the sketch is internal.

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")

void NXOpen::Sketch::LocalUpdate ( )

Update the sketch and not the sketch children.

If a different sketch is active the SKETCH_NOT_INITIALIZED error will return. The function works even if the sketch is not active.
Created in NX3.0.0.

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

void NXOpen::Sketch::MakeDatumsExternal ( )

Makes the internal sketch placement face and directional reference datums external.

Deprecated:: Deprecated in NX11.0.0. Please use NXOpen::Sketch::MakeDatumsExternal2 instead.

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")

void NXOpen::Sketch::MakeDatumsExternal2 ( )

Makes the internal sketch placement face and directional reference datums external.

It should be called only when the internal datum is not a datum CSYS or is not a PlaneAxisPoint type of datum CSYS.
Created in NX11.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")

void NXOpen::Sketch::MakeDatumsInternal ( )

Makes the sketch placement face and directional reference internal to the sketch if they are both datums referenced only by the sketch.

Deprecated:: Deprecated in NX11.0.0. None.

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR geometric_tol ("GDT")

void NXOpen::Sketch::ManageConstraintsAfterEdit	(	const std::vector< NXOpen::NXObject * > &	sketchGeoms,
		bool	preserveComplexConstraints
	)

Deletes or adjusts constraints of the input geometry that are incompatible after geometry edit.

Call this before sketch update
Created in NX11.0.0.

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

Parameters

sketchGeoms	sketchgeoms
preserveComplexConstraints	Complex constraints are Pattern, Mirror and Offset

NXOpen::NXMatrix* NXOpen::Sketch::Orientation ( )

Returns the orientation matrix of the local coordinate system of the sketch
Created in NX3.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Sketch::Origin ( )

Returns the location of the origin of the local coordinate system for the sketch
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::SketchPreferences* NXOpen::Sketch::Preferences ( )

Contains preferences for the sketch
Created in NX3.0.0.

void NXOpen::Sketch::Reattach	(	NXOpen::ISurface *	attachmentPlane,
		NXOpen::IReferenceAxis *	referenceAxis,
		const NXOpen::Vector3d &	referenceDirection,
		NXOpen::AxisOrientation	referenceAxisOrientation,
		NXOpen::Sense	referenceAxisSense,
		NXOpen::PlaneNormalOrientation	normalOrientation,
		const NXOpen::Point3d &	localCoordinateSystemOrigin
	)

Reattaches a sketch.

For documentation for the parameters for this method, see the documentation for NXOpen::SketchCollection::CreateSketch

Deprecated:: Deprecated in NX11.0.0. Use NXOpen::SketchInPlaceBuilder instead.

Created in NX3.0.0.

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

Parameters

attachmentPlane	attachment plane
referenceAxis	reference axis
referenceDirection	reference direction
referenceAxisOrientation	reference axis orientation
referenceAxisSense	reference axis sense
normalOrientation	normal orientation
localCoordinateSystemOrigin	Origin of the sketch's local coordinate system

void NXOpen::Sketch::RemoveRedundantVertices ( const std::vector< NXOpen::NXObject * > & geoms )

Remove redundant vertices of the given sketch geometry
Created in NX11.0.0.

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

Parameters

geoms Array of geometries

void NXOpen::Sketch::RunAutoDimension ( )

Run auto dimensioning.

Created in NX7.5.0.

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

void NXOpen::Sketch::Scale ( double scaleFactor )

Scale the sketch entities by the given scale factor.

The sketch cannot be scaled if there are recipe curves or external constraints/dimensions or constraints/dimensions that controls the size of one or more geometries in the sketch. The sketch can have at most one non-angular driving dimension and that dimension must have its expression value scaled by the scale factor.
Created in NX11.0.0.

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

Parameters

scaleFactor the scaleFactor must be gerater than zero

void NXOpen::Sketch::SetCreateInferConstraintsSetting ( NXOpen::Sketch::CreateInferConstraintSetting createInferCon )

Sets the toggle that controls the creation of infer constraints in sketch
Created in NX4.0.0.

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

Parameters

createInferCon create infer con

void NXOpen::Sketch::SetDOFDisplay ( bool displayDof )

Sets a flag indicating whether the degree of freedom arrows are currently being displayed
Created in NX3.0.0.

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

Parameters

displayDof display dof

void NXOpen::Sketch::SetReferenceDirection	(	NXOpen::IReferenceAxis *	referenceAxis,
		const NXOpen::Vector3d &	referenceDirection,
		NXOpen::AxisOrientation	referenceAxisOrientation,
		NXOpen::Sense	referenceAxisSense
	)

Sets the reference direction of the sketch.

For documentation for the parameters for this method, see the documentation for NXOpen::SketchCollection::CreateSketch .

Created in NX3.0.0.

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

Parameters

referenceAxis	reference axis
referenceDirection	reference direction
referenceAxisOrientation	reference axis orientation
referenceAxisSense	reference axis sense

void NXOpen::Sketch::SetUpdateScope ( NXOpen::Sketch::UpdateLevel updateScope )

Sets the current update scope.

Used in Direct Sketch to control update
Created in NX8.0.0.

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

Parameters

updateScope update scope

void NXOpen::Sketch::ShowDimensions ( const std::vector< NXOpen::DisplayableObject * > & inputObjects )

Unblanks dimensions in the active sketch associated with the input sketch geometry
Created in NX4.0.0.

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

Parameters

inputObjects Geometry and groups in active sketch

void NXOpen::Sketch::ShowDimensions ( )

Unblanks all the dimensions of input sketch
Created in NX6.0.1.

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

void NXOpen::Sketch::ShowDimensions ( const std::vector< NXOpen::Sketch::ConstraintGeometry > & objects )

Unblanks dimensions in the active sketch associated with the input sketch geometry.

This function can accept vertices.
Created in NX8.5.0.

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

Parameters

objects Geometry and vertices in active sketch

void NXOpen::Sketch::Update ( )

Updates the sketch
Created in NX3.0.0.

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

void NXOpen::Sketch::Update ( const std::vector< NXOpen::NXObject * > & geoms )

Updates the given set of geometries in the sketch
Created in NX4.0.0.

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

Parameters

geoms Geoms that need to be updated

void NXOpen::Sketch::UpdateConstraintDisplay ( )

Updates the constraint display without updating the sketch
Created in NX3.0.0.

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

void NXOpen::Sketch::UpdateConstraintDisplay ( const std::vector< NXOpen::SmartObject * > & geoms )

Updates the constraint display of given set of geoms without updating the sketch
Created in NX4.0.0.

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

Parameters

geoms Geoms for which cons must be re-displayed

void NXOpen::Sketch::UpdateDimensionDisplay ( )

Updates the dimension display without updating the sketch
Created in NX4.0.0.

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

void NXOpen::Sketch::UpdateDimensionDisplay ( const std::vector< NXOpen::SmartObject * > & geoms )

Updates the dimension display of given set of geoms without updating the sketch
Created in NX4.0.0.

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

Parameters

geoms Geoms for which cons must be re-displayed

void NXOpen::Sketch::UpdateDimensionDisplay ( const std::vector< NXOpen::NXObject * > & dims )

Updates the dimension display of given set of dims without updating the sketch
Created in NX4.0.0.

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

Parameters

dims	Dims for which cons must be re-displayed

void NXOpen::Sketch::UpdateGeometryDisplay ( )

Updates the geometry display without updating the sketch
Created in NX4.0.0.

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

void NXOpen::Sketch::UpdateGeometryDisplay ( const std::vector< NXOpen::SmartObject * > & geoms )

Updates the geometry display of given set of geoms without updating the sketch
Created in NX4.0.0.

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

Parameters

geoms Geoms for which cons must be re-displayed

NXOpen::Sketch::UpdateLevel NXOpen::Sketch::UpdateScope ( )

Returns the current update scope.

Used in Direct Sketch to control update
Created in NX8.0.0.

License requirements : None

NXOpen::View* NXOpen::Sketch::View ( )

Returns the view corresponding to sketch
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Sketch.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation