Functions
Constraint Objects

Functions

nativeCode Dpoint3dmdlCons_getPoint (Dpoint3d *pPoint, Cons *pThis)
 
mdlCons_getPoint returns the (x,y) coordinates of the object's location in the

current coordinate system. More...

 
nativeCode RotMatrixP mdlCons_getRMatrix (RotMatrixP pRot, Cons *pThis)
 mdlCons_getRMatrix returns a rotation matrix describing object's current geometry. More...
 
nativeCode int mdlCons_isOperational (Cons *pThis)
 
mdlCons_isOperational determines if the specified Cons object is fully defined and

has been activated. More...

 
nativeCode void mdlCons_destroy (Cons *pThis)
 mdlCons_destroy frees any dynamic memory allocated for the Cons object. More...
 

Detailed Description

Function Documentation

nativeCode void mdlCons_destroy ( Cons pThis)

mdlCons_destroy frees any dynamic memory allocated for the Cons object.

The Cons object pointer itself is not freed.

Parameters
[in,out]pThisis the Cons object to be cleaned up. It is not usable after being destroyed.
Returns
mdlCons_destroy is of type void.
See also
mdlConsMod_destroyNodes
Remarks
Required Library: mdlbltin.lib
nativeCode Dpoint3d* mdlCons_getPoint ( Dpoint3d pPoint,
Cons pThis 
)

mdlCons_getPoint returns the (x,y) coordinates of the object's location in the

current coordinate system.

Parameters
[out]pPointis the returned (x,y,0) location of object in the current coordinate system.
[in]pThisis the object to query.
Returns
mdlCons_getPoint returns pPoint.
Remarks
In 3D, the object is assumed to lie in the current plane, so that its z- coordinate will always be zero.
If the object is a construction frame point, circle, ellipse, or B-spline cell this function will return its center point. If the object is a construction frame line, mdlCons_getPoint will return a point on the line.
If the object is a constraint which defines a point, this function returns the (x,y) location of the point so defined. If the object is any other kind of constraint, (0,0,0) is returned.
If the object is any other type, (0,0,0) is returned.
See also
mdlCons_getRMatrix
Remarks
Required Library: mdlbltin.lib
nativeCode RotMatrixP mdlCons_getRMatrix ( RotMatrixP  pRot,
Cons pThis 
)

mdlCons_getRMatrix returns a rotation matrix describing object's current geometry.

Parameters
[out]pRotis the output rotation matrix.
[in]pThisis the object to query.
Returns
mdlCons_getRMatrix returns pRot.
Remarks
If the object is a construction frame, the rotation matrix describes its orientation about the z-axis. For lines, the rotation is the direction of the line. For ellipses, the rotation is the angle of the major axis. For B-spline cells, the cell's rotation is returned. For points and circles, the rotation matrix is the identity matrix.
If the object is a a constraint which defines one or more points ((IO)Tangent, PointOn, Intersection, or Perpendicular are examples), the rotation matrix describes the normal to the curve at the point. If the object is any other kind of constraint, the matrix is the identity matrix.
If the object is any other type, the matrix is the identity matrix.
In 3D, the object is assumed to lie in the current plane, so the matrix describes only its rotation about the z-axis; the z-axis column of the matrix
See also
mdlCons_getPoint
Remarks
Required Library: mdlbltin.lib
nativeCode int mdlCons_isOperational ( Cons pThis)

mdlCons_isOperational determines if the specified Cons object is fully defined and

has been activated.

For example, an equation constraint which has not been activated, say, due to parsing errors, will not be operational. A NULL pointer is considered not operational. This function is also useful when re-creating Cons objects from data stored in an external format, to test that all references were successfully resolved.

Parameters
[out]pThisis the object to test.
Returns
mdlCons_isOperational returns true if the object is defined and activated; else false.
See also
mdlCons_destroy
Remarks
Required Library: mdlbltin.lib

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