NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::GeometricConstraintData Class Reference

Represents Geometric Constraint Data class. More...

Inheritance diagram for NXOpen::Features::GeometricConstraintData:
NXOpen::TaggedObject

List of all members.

Public Types

enum  AutoConstraintType { AutoConstraintTypeNone, AutoConstraintTypeTangent, AutoConstraintTypeCurvature, AutoConstraintTypeCurvatureDerivative }
 Automatic constraint types. More...
enum  ParameterDirection { ParameterDirectionIso, ParameterDirectionSection, ParameterDirectionNormal, ParameterDirectionPerpendicular }
 Parameter direction to be used for creation of the constraint at a point which is attached to an object, for example a curve or a face. More...

Public Member Functions

NXOpen::Features::GeometricConstraintData::ParameterDirection AutomaticConstraintDirection ()
 Returns the automatic constraint direction type.
NXOpen::Features::GeometricConstraintData::AutoConstraintType AutomaticConstraintType ()
 Returns the automatic constraint type
Created in NX5.0.0.
bool CanInferConstraintFromAttachmentParent ()
 Returns the flag indicating if a constraint can be inferred from the parent of the attachment object of the point.
NXOpen::OffsetCurvature ()
 Returns the curvature.
NXOpen::OffsetCurvatureDerivative ()
 Returns the curvature derivative.
bool HasSymmetricModelingConstraint ()
 Returns the flag indicating if tangent direction is used for creating symmetric modeling constraint.
NXOpen::PointPoint ()
 Returns the point.
void SetAutomaticConstraintDirection (NXOpen::Features::GeometricConstraintData::ParameterDirection autoConstraintDirection)
 Sets the automatic constraint direction type.
void SetAutomaticConstraintType (NXOpen::Features::GeometricConstraintData::AutoConstraintType autoConstraintType)
 Sets the automatic constraint type
Created in NX5.0.0.
void SetCanInferConstraintFromAttachmentParent (bool canInferConstraintFromAttachmentParent)
 Sets the flag indicating if a constraint can be inferred from the parent of the attachment object of the point.
void SetCurvature (NXOpen::Offset *curvature)
 Sets the curvature.
void SetCurvatureDerivative (NXOpen::Offset *curvatureDerivative)
 Sets the curvature derivative.
void SetHasSymmetricModelingConstraint (bool symmetric)
 Sets the flag indicating if tangent direction is used for creating symmetric modeling constraint.
void SetPoint (NXOpen::Point *point)
 Sets the point.
void SetTangentDirection (NXOpen::Direction *tangentDirection)
 Sets the tangent direction.
void SetTangentMagnitude (NXOpen::Scalar *tangentMagnitude)
 Sets the tangent magnitude.
NXOpen::DirectionTangentDirection ()
 Returns the tangent direction.
NXOpen::ScalarTangentMagnitude ()
 Returns the tangent magnitude.

Detailed Description

Represents Geometric Constraint Data class.


This class acts as a container of various types of geometric constraints such as position(G0), tangent(G1), tangent magnitude, curvature(G2) and curvature derivative(G3). An array of objects of this class may be used to create a curve. Not all features support all types of constraints. For details of the supported types by a feature, refer to feature documentation. Position is a minimum required element of GeometricConstraintData.


GeometricConstraintData can be specified as automatic or fixed type.


Automatic type -

When a point (G0) is attached to an object such as curve or a face, constraint types such as tangent, curvature or curvature derivative can be automatically inferred from the attached object. In this case the tangent direction is determined by some scheme decided by the feature. To specify automatic type Features::GeometricConstraintData::AutoConstraintType and Features::GeometricConstraintData::ParameterDirection are necessary.


Fixed type -

To specify GeometricConstraintData as a fixed type, the actual objects representing different types of constraints such as Direction for tangent, Scalar for tangent magnitude or Offset for curvature or curvature derivative are specified.

To create a new instance of this class, use Features::GeometricConstraintDataManager::CreateGeometricConstraintData

Created in NX5.0.0.


Member Enumeration Documentation

Automatic constraint types.

Enumerator:
AutoConstraintTypeNone 

No automatic constraint.

AutoConstraintTypeTangent 

Tangent(G1)

AutoConstraintTypeCurvature 

Curvature(G2)

AutoConstraintTypeCurvatureDerivative 

Curvature derivative(G3)

Parameter direction to be used for creation of the constraint at a point which is attached to an object, for example a curve or a face.

Enumerator:
ParameterDirectionIso 

Iso parameter.

ParameterDirectionSection 

General section if point is attached to face.

ParameterDirectionNormal 

Normal.

ParameterDirectionPerpendicular 

Perpendicular to curve on face or edge.


Member Function Documentation

Returns the automatic constraint direction type.

For a constraint on a face it is necessary to specify parameter direction.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the automatic constraint type
Created in NX5.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the flag indicating if a constraint can be inferred from the parent of the attachment object of the point.

E.g. if point is attached to an edge or a curve on face, then infer constraint from the face of the edge or the curve.
Created in NX8.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the curvature.

Used only when automatic constraint type is none.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the curvature derivative.

Used only when automatic constraint type is none
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the flag indicating if tangent direction is used for creating symmetric modeling constraint.

If true, only tangent direction object is used for constraint evaluation.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the point.

Point is the minimum required data to create a constraint.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Sets the automatic constraint direction type.

For a constraint on a face it is necessary to specify parameter direction.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
autoConstraintDirectionauto constraint direction

Sets the automatic constraint type
Created in NX5.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
autoConstraintTypeauto constraint type
void NXOpen::Features::GeometricConstraintData::SetCanInferConstraintFromAttachmentParent ( bool  canInferConstraintFromAttachmentParent)

Sets the flag indicating if a constraint can be inferred from the parent of the attachment object of the point.

E.g. if point is attached to an edge or a curve on face, then infer constraint from the face of the edge or the curve.
Created in NX8.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
canInferConstraintFromAttachmentParentcaninferconstraintfromattachmentparent

Sets the curvature.

Used only when automatic constraint type is none.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
curvaturecurvature

Sets the curvature derivative.

Used only when automatic constraint type is none
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
curvatureDerivativecurvature derivative

Sets the flag indicating if tangent direction is used for creating symmetric modeling constraint.

If true, only tangent direction object is used for constraint evaluation.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
symmetricsymmetric

Sets the point.

Point is the minimum required data to create a constraint.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
pointpoint

Sets the tangent direction.

Used only when automatic constraint type is none.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
tangentDirectiontangent direction

Sets the tangent magnitude.

Used only when automatic constraint type is none.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters:
tangentMagnitudetangent magnitude

Returns the tangent direction.

Used only when automatic constraint type is none.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the tangent magnitude.

Used only when automatic constraint type is none.
Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")


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