NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Positioning::ConstraintReference Class Reference

ConstraintReference for use in positioning objects in NX. More...

Inheritance diagram for NXOpen::Positioning::ConstraintReference:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  ConstraintOrder { ConstraintOrderUnknown, ConstraintOrderInside, ConstraintOrderOutside }
 Specifies the order of the constraint reference used in a Positioning::Constraint . More...
enum  GeometryType {
  GeometryTypeUnknown = -1, GeometryTypePoint, GeometryTypeLine, GeometryTypeCircle,
  GeometryTypePlane, GeometryTypeCylinder, GeometryTypeSphere, GeometryTypeSweepSurface,
  GeometryTypeParametricSurface, GeometryTypeParametricCurve, GeometryTypeSplineCurve, GeometryTypeTorus,
  GeometryTypeCone, GeometryTypeEllipse, GeometryTypeSplineSurface, GeometryTypeCoordinateSystem = 1001
}
 Specifies the type of the geometry used in a Positioning::ConstraintReference . More...
enum  HalfSpace { HalfSpaceInfer, HalfSpacePositive, HalfSpaceNegative }
 Specifies the half space value of one geometry used in a distance constraint. More...

Public Member Functions

NXOpen::Positioning::ConstraintReference::HalfSpace ConstraintReferenceHalfSpace ()
 Returns the half_space value for the constraint reference.
NXOpen::NXObjectGetGeometry ()
 Returns the geometry of the constraint reference.
NXOpen::NXObjectGetMovableObject ()
 Returns the movable object of the constraint reference.
bool GetUsePortRotate ()
 Get the flag forcing the use of the rotation vector of the referenced Routing::Port object instead of the alignment vector when solving the constraint system.
bool GetUsesGeometryAxis ()
 Returns if the constraint reference should use the axis of the geometry (for example a cylindrical face) rather than the surface.
NXOpen::Point3d HelpPoint ()
 Returns the help point of the constraint reference.
NXOpen::Positioning::ConstraintReference::ConstraintOrder Order ()
 Returns the order of the constraint reference within its constraint.
void SetConstraintReferenceHalfSpace (NXOpen::Positioning::ConstraintReference::HalfSpace halfSpace)
 Sets the half_space value for the constraint reference.
void SetFixHint (bool set)
 Set a hint to the solver to fix the movable object associated with this constraint reference.
void SetFixHintForUpdate (bool set)
 Set a hint to the solver to fix the movable object associated with this constraint reference.
void SetHelpPoint (const NXOpen::Point3d &helpPoint)
 Sets the help point of the constraint reference.
void SetUsePortRotateFlag (bool useRotate)
 Sets the flag forcing the use of the rotation vector of the referenced Routing::Port object instead of the alignment vector when solving the constraint system.
NXOpen::Positioning::ConstraintReference::GeometryType SolverGeometryType ()
 Returns the geometry type of the constraint reference used during a solve.
bool UsePortRotateFlag ()
 Returns the flag forcing the use of the rotation vector of the referenced Routing::Port object instead of the alignment vector when solving the constraint system.

Detailed Description

ConstraintReference for use in positioning objects in NX.

A ConstraintReference is used by a Constraint to determine the movable object to be positioned by the constraint and the geometry used to define the constraint.
To create an instance of this class, use NXOpen::Positioning::Constraint::CreateConstraintReference .

Created in NX4.0.0.


Member Enumeration Documentation

Specifies the order of the constraint reference used in a Positioning::Constraint .

Typically the order is set during creation, where the first constraint reference added is "outside" and the second "outside". For Bond constraints, the order is set to be "unknown" at creation.

Enumerator:
ConstraintOrderUnknown 

No order specified.

ConstraintOrderInside 

Inside.

ConstraintOrderOutside 

Outside.

Specifies the type of the geometry used in a Positioning::ConstraintReference .

The type reflects that used in a Positioning::Constraint while it is being solved and may be different from that inferred directly from NXOpen::Positioning::ConstraintReference::GetGeometry . For example we may use Positioning::ConstraintReference::GeometryTypeLine as an axis when given a cylindrical face as the geometry.

Enumerator:
GeometryTypePoint 

Point.

GeometryTypeLine 

Straight line.

GeometryTypeCircle 

Circle.

GeometryTypePlane 

Plane.

GeometryTypeCylinder 

Cylinder.

GeometryTypeSphere 

Sphere.

GeometryTypeSweepSurface 

Swept surface.

GeometryTypeParametricSurface 

Parametric surface.

GeometryTypeParametricCurve 

Parametric curve.

GeometryTypeSplineCurve 

Spline curve.

GeometryTypeTorus 

Torus.

GeometryTypeCone 

Cone.

GeometryTypeEllipse 

Ellipse.

GeometryTypeSplineSurface 

Spline surface.

Specifies the half space value of one geometry used in a distance constraint.

This is only used for surface geometries, and it determines which side of the surface the distance constraint is measured from.

Enumerator:
HalfSpaceInfer 

Allow the solver to decide the half space value, or the geometry is not a surface.

HalfSpacePositive 

Measure to the positive side of the surface.

HalfSpaceNegative 

Measure to the negative side of the surface.


Member Function Documentation

Returns the half_space value for the constraint reference.

This is only used for distance constraints.


Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the geometry of the constraint reference.

This is the geometry used in any Positioning::Constraint using this constraint reference.

Returns:
The geometry referenced by the constraint
Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the movable object of the constraint reference.

The movable object determines the object to be positioned by any Positioning::Constraint using this constraint reference.

Returns:
The object positioned by the constraint
Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Get the flag forcing the use of the rotation vector of the referenced Routing::Port object instead of the alignment vector when solving the constraint system.

Only effective when the referenced geometry is a Routing::Port object.

Returns:

Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns if the constraint reference should use the axis of the geometry (for example a cylindrical face) rather than the surface.

Returns:
If this reference is using the axis of the geometry
Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the help point of the constraint reference.


Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the order of the constraint reference within its constraint.

Note that this order is not associated with the geometry or with the alignment of the constraint. It is based on the idea that the constraint has a direction from "outside" to "inside". It does not affect the result of a solve.


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Sets the half_space value for the constraint reference.

This is only used for distance constraints.


Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
halfSpaceHalf space for constraint reference

Set a hint to the solver to fix the movable object associated with this constraint reference.

The hint is unset when "set" is false.

The hint can only have an effect when the constraint owning this constraint reference has been explicitly added to a Network .

The hint is forgotten after an update.


Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
setSet or unset the hint

Set a hint to the solver to fix the movable object associated with this constraint reference.

The hint is unset when "set" is false.

The hint is forgotten after an update.

Ensures that the constraint that owns this reference will solve during the next call to Update::DoUpdate .


Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
setSet or unset the hint

Sets the help point of the constraint reference.


Created in NX4.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
helpPointCoordinates of point in part of constraint

Sets the flag forcing the use of the rotation vector of the referenced Routing::Port object instead of the alignment vector when solving the constraint system.

Only effective when the referenced geometry is a Routing::Port object.


Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters:
useRotateuse rotate

Returns the geometry type of the constraint reference used during a solve.


Created in NX5.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Returns the flag forcing the use of the rotation vector of the referenced Routing::Port object instead of the alignment vector when solving the constraint system.

Only effective when the referenced geometry is a Routing::Port object.


Created in NX5.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")


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