Constraint Module

Detailed Description

group a3d_constraint_module

Accesses constraint entities.

Type Documentation

enum EA3DConstraintLinkType

Constraint link type enum.

Version
14.0 details

Values:

enumerator kA3DConstraintLink_None

No type specified.

enumerator kA3DConstraintLink_Axis

The constraint is applied using the Axis corresponding to the linked face (e.g.

cylinder axis or cone axis).

enumerator kA3DConstraintLink_Center

The constraint is applied using the Center corresponding to the linked face (e.g.

sphere center).

enum EA3DConstraintType

Constraint link type enum.

Version
14.0 details

Values:

enumerator kA3DConstraintType_None

No type specified.

enumerator kA3DConstraintType_Set

Constraint Set: contains other constraints.

enumerator kA3DConstraintType_Fix

Fix an element so it can’t be moved.

enumerator kA3DConstraintType_FixTogether

Fix two elements together, bound so that they act as a single body.

enumerator kA3DConstraintType_Contact

Constrain two elements so that they are in contact of each others.

Type of contact is specified in additional data.

enumerator kA3DConstraintType_Distance

Reserved for future use.

Specify a distance between two elements.

enumerator kA3DConstraintType_Angle

Reserved for future use.

Specify an angle between two elements.

enumerator kA3DConstraintType_Perpendicular

Reserved for future use.

Constrain two elements as Perpendicular to each other.

enumerator kA3DConstraintType_Parallel

Reserved for future use.

Constrain two elements as Parallel to each other.

enum EA3DContactType

Contact type enum.

Version
14.0 details

Values:

enumerator kA3DContactType_None

No type specified.

enumerator kA3DContactType_Unknown

The contact type is not defined by the software and is ambiguous to determine.

enumerator kA3DContactType_Surface

The elements are in contact with a common surface (e.g.

two cubes).

enumerator kA3DContactType_Annular

The contact between two elements can be reduced to a circular shape (e.g.

a sphere in a cone, or in a cylinder with the same radius.

enumerator kA3DContactType_Line

The contact between two elements can be reduced to a line (e.g.

a cylinder on a plane).

enumerator kA3DContactType_Point

The contact between two elements can be reduced to a point (e.g.

a sphere on a plane).

enum EA3DConstraintStatus

Constraint status enum.

Version
14.0 details

Values:

enumerator kA3DConstraintStatus_OK

Default status.

enumerator kA3DConstraintStatus_Disabled

Disabled by the user.

enumerator kA3DConstraintStatus_Error

In error.

Function Documentation

A3DStatus A3DAsmConstraintGet(const A3DAsmConstraint *pConstraint, A3DAsmConstraintData *pData)

Populates the A3DAsmConstraintData structure.

Version
14.0

Return values:
  • A3D_INITIALIZE_NOT_CALLED –
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_INVALID_ENTITY_NULL –
  • A3D_INVALID_ENTITY_TYPE –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure