Accesses constraint entities. More...

Modules

 Constraint Linked Item
 

Data Structures

struct  A3DAsmConstraintData
 Assembly Constraint structure. More...
 

Enumerations

enum  EA3DConstraintLinkType {
  kA3DConstraintLink_None = 0,
  kA3DConstraintLink_Axis,
  kA3DConstraintLink_Center
}
 Constraint link type enum. More...
 
enum  EA3DConstraintStatus {
  kA3DConstraintStatus_OK = 0,
  kA3DConstraintStatus_Disabled,
  kA3DConstraintStatus_Error
}
 Constraint status enum. More...
 
enum  EA3DConstraintType {
  kA3DConstraintType_None = 0,
  kA3DConstraintType_Set,
  kA3DConstraintType_Fix,
  kA3DConstraintType_FixTogether,
  kA3DConstraintType_Contact,
  kA3DConstraintType_Distance,
  kA3DConstraintType_Angle,
  kA3DConstraintType_Perpendicular,
  kA3DConstraintType_Parallel
}
 Constraint link type enum. More...
 
enum  EA3DContactType {
  kA3DContactType_None = 0,
  kA3DContactType_Unknown,
  kA3DContactType_Surface,
  kA3DContactType_Annular,
  kA3DContactType_Line,
  kA3DContactType_Point
}
 Contact type enum. More...
 

Functions

A3DStatus A3DAsmConstraintGet (const A3DAsmConstraint *pConstraint, A3DAsmConstraintData *pData)
 Populates the A3DAsmConstraintData structure. More...
 

Detailed Description

Accesses constraint entities.

Enumeration Type Documentation

◆ EA3DConstraintLinkType

Constraint link type enum.

Version
14.0 details
Enumerator
kA3DConstraintLink_None 

No type specified.

kA3DConstraintLink_Axis 

The constraint is applied using the Axis corresponding to the linked face (e.g. cylinder axis or cone axis).

kA3DConstraintLink_Center 

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

◆ EA3DConstraintType

Constraint link type enum.

Version
14.0 details
Enumerator
kA3DConstraintType_None 

No type specified.

kA3DConstraintType_Set 

Constraint Set: contains other constraints.

kA3DConstraintType_Fix 

Fix an element so it can't be moved.

kA3DConstraintType_FixTogether 

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

kA3DConstraintType_Contact 

Constrain two elements so that they are in contact of each others. Type of contact is specified in additional data.

kA3DConstraintType_Distance 

Reserved for future use. Specify a distance between two elements.

kA3DConstraintType_Angle 

Reserved for future use. Specify an angle between two elements.

kA3DConstraintType_Perpendicular 

Reserved for future use. Constrain two elements as Perpendicular to each other.

kA3DConstraintType_Parallel 

Reserved for future use. Constrain two elements as Parallel to each other.

◆ EA3DContactType

Contact type enum.

Version
14.0 details
Enumerator
kA3DContactType_None 

No type specified.

kA3DContactType_Unknown 

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

kA3DContactType_Surface 

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

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.

kA3DContactType_Line 

The contact between two elements can be reduced to a line (e.g. a cylinder on a plane).

kA3DContactType_Point 

The contact between two elements can be reduced to a point (e.g. a sphere on a plane).

◆ EA3DConstraintStatus

Constraint status enum.

Version
14.0 details
Enumerator
kA3DConstraintStatus_OK 

Default status.

kA3DConstraintStatus_Disabled 

Disabled by the user.

kA3DConstraintStatus_Error 

In error.

Function Documentation

◆ A3DAsmConstraintGet()

A3DStatus A3DAsmConstraintGet ( const A3DAsmConstraint pConstraint,
A3DAsmConstraintData pData 
)

Populates the A3DAsmConstraintData structure.

Version
14.0
Returns
A3D_SUCCESS in case of success or an error code
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