Functions
Construction Frames

Functions

nativeCode ConsFramemdlConsFrame_createPoint (ConsFrame *pThis, DPoint3dP p)
 
mdlConsFrame_createPoint defines a construction frame point whose attributes are

CONS_POINT_X and CONS_POINT_Y. More...

 
nativeCode ConsFramemdlConsFrame_createLine (ConsFrame *pThis, DPoint3dP p1, DPoint3dP p2)
 mdlConsFrame_createLine defines a construction line. More...
 
nativeCode ConsFramemdlConsFrame_createEllipse (ConsFrame *pThis, DPoint3dP c, double r, double r2, double zr)
 mdlConsFrame_createEllipse defines a construction ellipse. More...
 
nativeCode ConsFramemdlConsFrame_createCircle (ConsFrame *pThis, DPoint3dP c, double r)
 mdlConsFrame_createCircle defines a construction circle. More...
 
nativeCode ConsFramemdlConsFrame_createBspline (ConsFrame *pThis, MSBsplineCurve *pCurve)
 
The mdlConsFrame_createBspline function defines a B-spline Construction Frame

object for use in constraint solving. More...

 
nativeCode ConsFramemdlConsFrame_createBsplineCell (ConsFrame *pThis, MSBsplineCurve *pCurve, Dpoint3d *pCenter, double angle)
 
The mdlConsFrame_createBsplineCell function defines a B-spline cell

Construction Frame object for use in constraint solving. More...

 
nativeCode int mdlConsFrame_isUnderDetermined (ConsFrame *pThis)
 
 mdlConsFrame_isUnderDetermined queries if any of the frame's geometric

attributes are not fully determined by constraints. More...

 

Detailed Description

Function Documentation

nativeCode ConsFrame* mdlConsFrame_createBspline ( ConsFrame pThis,
MSBsplineCurve pCurve 
)

The mdlConsFrame_createBspline function defines a B-spline Construction Frame

object for use in constraint solving.

The B-spline's geometry, defined by pCurve, is assumed to be invariant, so this frame has no solver attribute variables at all. You may, nevertheless, change the poles of the B-spline curve on the fly.

Parameters
[out]pThisis the storage to fill out with the B-spline Construction Frame definition data.
[in]pCurveshould point to a fully defined B-spline curve definition data structure, such as would be returned by mdlBspline_convertToCurve.
Returns
mdlConsFrame_createBspline returns the construction B-spline in this.
Remarks
The pCurve pointer is stored in the B-spline frame object and must not be freed.
mdlCons_destroy will free the curve when you destroy the B-spline frame object.
See also
mdlConsFrame_createBsplineCell
Remarks
Required Library: mdlbltin.lib
nativeCode ConsFrame* mdlConsFrame_createBsplineCell ( ConsFrame pThis,
MSBsplineCurve pCurve,
Dpoint3d pCenter,
double  angle 
)

The mdlConsFrame_createBsplineCell function defines a B-spline cell

Construction Frame object for use in constraint solving.

The B-spline's intrinsic geometry is assumed to be fixed (although you may change poles of the B-spline curve on the fly), but the B-spline as a whole can translate and rotate. A B-spline cell would be useful for modeling a cam, for example.

Parameters
[out]pThisis the storage to fill out with the B-spline cell Construction Frame definition data.
[in]pCurveshould point to a fully defined B-spline curve definition data structure, such as would be returned by mdlBspline_convertToCurve.
[in]pCenteris the initial location of the B-spline cell construction frame object.
[in]angleis the initial (planar) rotation of the B-spline cell construction frame object, in radians.
Returns
mdlConsFrame_createBsplineCell returns the construction B-spline Cell in this.
Remarks
B-spline cell attribute variables are CONS_BSPLINE_X, CONS_BSPLINE_Y, and CONS_BSPLINE_ANGLE.
The pCurve pointer is stored in the B-spline cell frame object and must not be freed
See also
mdlConsFrame_createBspline
Remarks
Required Library: mdlbltin.lib
nativeCode ConsFrame* mdlConsFrame_createCircle ( ConsFrame pThis,
DPoint3dP  c,
double  r 
)

mdlConsFrame_createCircle defines a construction circle.

Parameters
[out]pThisis the storage to fill out.
[in]cis the initial x, y location of the center of the circle.
[in]ris the initial value for the radius of the circle.
Returns
mdlConsFrame_createCircle returns the construction circle in this.
Remarks
A construction circle has attributes CONS_ELLIPSE_X, the x-coordinate of its center, CONS_ELLIPSE_Y, the y-coordinate of its center, CONS_ELLIPSE_R, its radius. (CONS_ELLIPSE_R2 and CONS_ELLIPSE_ANGLE are also defined, so that a circle is truly a special case of an ellipse).
See also
mdlConsFrame_createEllipse
Remarks
Required Library: mdlbltin.lib
nativeCode ConsFrame* mdlConsFrame_createEllipse ( ConsFrame pThis,
DPoint3dP  c,
double  r,
double  r2,
double  zr 
)

mdlConsFrame_createEllipse defines a construction ellipse.

Parameters
[out]pThisis the storage to fill out.
[in]cis the initial x, y location of the center of the ellipse.
[in]rthe initial major radius of the ellipse.
[in]r2the initial minor radius of the ellipse
[in]zris the initial rotation angle (about the z axis) of the ellipse, in radians, measured up from the x-axis.
Returns
mdlConsFrame_createEllipse returns the construction ellipse in this.
Remarks
A construction ellipse has attributes CONS_ELLIPSE_X, the x-coordinate of its center, CONS_ELLIPSE_Y, the y-coordinate of its center, CONS_ELLIPSE_R, its major radius, CONS_ELLIPSE_R2, its minor radius, and CONS_ELLIPSE_ANGLE, the rotation angle (about the current z axis) of its major axis.
See also
mdlConsFrame_createCircle
Remarks
Required Library: mdlbltin.lib
nativeCode ConsFrame* mdlConsFrame_createLine ( ConsFrame pThis,
DPoint3dP  p1,
DPoint3dP  p2 
)

mdlConsFrame_createLine defines a construction line.

A construction frame line represents an infinite line. The two input point parameters simply specify its initial slope and intercept, not its length or extent. A construction line has a direction, defined as the direction from the first input point parameter toward the second point. Line direction is important for defining constraints.

Parameters
[out]pThisis the storage to fill out.
[in]p1point which defines the line's initial geometry.
[in]p2point which defines the line's initial geometry.
Returns
mdlConsFrame_createLine returns this.
Remarks
A construction frame line's attributes are CONS_LINE_DIRECTION, its angle (in radians), and CONS_LINE_D0, the perpendicular distance from the current coordinate system origin to the line.
See also
mdlConsFrame_createPoint
Remarks
Required Library: mdlbltin.lib
nativeCode ConsFrame* mdlConsFrame_createPoint ( ConsFrame pThis,
DPoint3dP  p 
)

mdlConsFrame_createPoint defines a construction frame point whose attributes are

CONS_POINT_X and CONS_POINT_Y.

Parameters
[out]pThisis the storage to fill out.
[in]pis the point's initial location.
Returns
mdlConsFrame_createPoint returns this.
See also
mdlConsFrame_createLine
nativeCode int mdlConsFrame_isUnderDetermined ( ConsFrame pThis)

 mdlConsFrame_isUnderDetermined queries if any of the frame's geometric

attributes are not fully determined by constraints.

If any attribute is under- determined, the frame as a whole is under-determined.

Parameters
[out]pThisis the frame object to query.
Returns
mdlConsFrame_isUnderDetermined returns true if any of the frame's attributes is under-determined; false if its geometry well-determined.
See also
mdlCons_getVar mdlVar_isUnderDetermined
Remarks
Required Library: mdlbltin.lib

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.