NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::SketchConstraintBuilder Class Reference

Represents a NXOpen::SketchConstraint builder
To create a new instance of this class, use NXOpen::SketchCollection::CreateConstraintBuilder

Created in NX8.5.0. More...

Inheritance diagram for NXOpen::SketchConstraintBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Constraint {
  ConstraintCoincident, ConstraintPointOnCurve, ConstraintTangent, ConstraintParallel,
  ConstraintPerpendicular, ConstraintHorizontal, ConstraintVertical, ConstraintHorizontalAlignment,
  ConstraintVerticalAlignment, ConstraintMidpoint, ConstraintCollinear, ConstraintConcentric,
  ConstraintEqualLength, ConstraintEqualRadius, ConstraintSymmetric, ConstraintFixed,
  ConstraintFullyFixed, ConstraintConstantAngle, ConstraintConstantLength, ConstraintPointOnString,
  ConstraintTangentToString, ConstraintPerpendicularToString, ConstraintNonUniformScale, ConstraintUniformScale,
  ConstraintSlopeOfCurve
}
 the types of the constraint More...
 

Public Member Functions

NXOpen::SelectNXObjectCenterline ()
 Returns the centerline for a symmetric constraint type
Created in NX8.5.0. More...
 
NXOpen::SketchConstraintBuilder::Constraint ConstraintType ()
 Returns the constraint type
Created in NX8.5.0. More...
 
NXOpen::SelectNXObjectListGeometryToConstrain ()
 Returns the geometries to be constrained
Created in NX8.5.0. More...
 
NXOpen::SelectNXObjectGeometryToConstrainTo ()
 Returns the secondary geometries to be constrained
Created in NX8.5.0. More...
 
bool MakeReference ()
 Returns the flag specifying whether or not to make the centerline reference geometry
Created in NX8.5.0. More...
 
void SetConstraintType (NXOpen::SketchConstraintBuilder::Constraint constraintType)
 Sets the constraint type
Created in NX8.5.0. More...
 
void SetMakeReference (bool makeReference)
 Sets the flag specifying whether or not to make the centerline reference geometry
Created in NX8.5.0. More...
 
void SetUpdateSketchAtCommit (bool updateSketch)
 Sets the flag specifying whether or not to update the sketch during the builder commit. More...
 
bool UpdateSketchAtCommit ()
 Returns the flag specifying whether or not to update the sketch during the builder commit. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::SketchConstraint builder
To create a new instance of this class, use NXOpen::SketchCollection::CreateConstraintBuilder

Created in NX8.5.0.


Member Enumeration Documentation

the types of the constraint

Enumerator
ConstraintCoincident 

coincident

ConstraintPointOnCurve 

point on curve

ConstraintTangent 

tangent

ConstraintParallel 

parallel

ConstraintPerpendicular 

perpendicular

ConstraintHorizontal 

horizontal

ConstraintVertical 

vertical

ConstraintHorizontalAlignment 

horizontal alignment

ConstraintVerticalAlignment 

vertical alignment

ConstraintMidpoint 

midpoint

ConstraintCollinear 

collinear

ConstraintConcentric 

concentric

ConstraintEqualLength 

equal length

ConstraintEqualRadius 

equal radius

ConstraintSymmetric 

symmetric

ConstraintFixed 

fixed

ConstraintFullyFixed 

fully fixed

ConstraintConstantAngle 

constant angle

ConstraintConstantLength 

constant length

ConstraintPointOnString 

point on string

ConstraintTangentToString 

tangent to string

ConstraintPerpendicularToString 

perpendicular to string

ConstraintNonUniformScale 

non uniform scale

ConstraintUniformScale 

uniform scale

ConstraintSlopeOfCurve 

slope of curve

Member Function Documentation

NXOpen::SelectNXObject* NXOpen::SketchConstraintBuilder::Centerline ( )

Returns the centerline for a symmetric constraint type
Created in NX8.5.0.



License requirements : None

NXOpen::SketchConstraintBuilder::Constraint NXOpen::SketchConstraintBuilder::ConstraintType ( )

Returns the constraint type
Created in NX8.5.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::SketchConstraintBuilder::GeometryToConstrain ( )

Returns the geometries to be constrained
Created in NX8.5.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::SketchConstraintBuilder::GeometryToConstrainTo ( )

Returns the secondary geometries to be constrained
Created in NX8.5.0.



License requirements : None

bool NXOpen::SketchConstraintBuilder::MakeReference ( )

Returns the flag specifying whether or not to make the centerline reference geometry
Created in NX8.5.0.



License requirements : None

void NXOpen::SketchConstraintBuilder::SetConstraintType ( NXOpen::SketchConstraintBuilder::Constraint  constraintType)

Sets the constraint type
Created in NX8.5.0.



License requirements : None

Parameters
constraintTypeconstrainttype
void NXOpen::SketchConstraintBuilder::SetMakeReference ( bool  makeReference)

Sets the flag specifying whether or not to make the centerline reference geometry
Created in NX8.5.0.



License requirements : None

Parameters
makeReferencemakereference
void NXOpen::SketchConstraintBuilder::SetUpdateSketchAtCommit ( bool  updateSketch)

Sets the flag specifying whether or not to update the sketch during the builder commit.

The default value is true. If the value is set to false, the sketch will not update during the builder commit.
Created in NX11.0.0.

License requirements : None

Parameters
updateSketchupdatesketch
bool NXOpen::SketchConstraintBuilder::UpdateSketchAtCommit ( )

Returns the flag specifying whether or not to update the sketch during the builder commit.

The default value is true. If the value is set to false, the sketch will not update during the builder commit.
Created in NX11.0.0.

License requirements : None


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