Roughness

Detailed Description

group a3d_markuproughness

Version
4.0

Type Documentation

enum EA3DMDRoughnessType

Enumerator that describes the roughness type.

Values:

enumerator KA3DRoughnessTypeBasic

Basic surface texture.

enumerator KA3DRoughnessTypeMachining_Required

Material removal by machining is required.

enumerator KA3DRoughnessTypeMachining_Prohibited

Material removal by machining is prohibited.

enum EA3DMDRoughnessContactArea

Enumerator that describes rough contact area type.

Values:

enumerator KA3DRoughnessContactSurfTexture

Surface texture.

enumerator KA3DRoughnessContactSurfTextAndAllSrfAround

Surface texture and all surfaces around.

enumerator KA3DRoughnessContactBasic

Basic contact.

enumerator KA3DRoughnessContactSrfAround

All surfaces around.

enum EA3DMDRoughnessMode

Enumerator that describes the direction of lay.

Values:

enumerator KA3DRoughnessMode_None

No specified lay.

enumerator KA3DRoughnessModeM

Lay multi directional.

enumerator KA3DRoughnessModeC

Lay approximately circular.

enumerator KA3DRoughnessModeR

Lay approximately radial.

enumerator KA3DRoughnessModeP

Lay particulate, non-directional, or protuberant.

enumerator KA3DRoughnessModeX

Lay angular in both directions.

enumerator KA3DRoughnessModePARA

Lay approximately parallel to the line representing the surface.

enumerator KA3DRoughnessModePERP

Lay approximately perpendicular to the line representing the surface.

Function Documentation

A3DStatus A3DMarkupRoughnessCreate(const A3DMarkupRoughnessData *pData, A3DMarkupRoughness **ppMarkupRoughness)

Creates the A3DMarkupRoughness from A3DMarkupRoughnessData structure.

Version
4.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS on success, or an error code on failure
A3DStatus A3DMarkupRoughnessGet(const A3DMarkupRoughness *pMarkupRoughness, A3DMarkupRoughnessData *pData)

Populates the A3DMarkupRoughnessData structure.

Version
4.0

Parameters:
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