Data Structures

struct  A3DMarkupRoughnessData
 Markup roughness. More...
 

Enumerations

enum  EA3DMDRoughnessContactArea {
  KA3DRoughnessContactSurfTexture = 1,
  KA3DRoughnessContactSurfTextAndAllSrfAround = 2,
  KA3DRoughnessContactBasic = 3,
  KA3DRoughnessContactSrfAround = 4
}
 Enumerator that describes rough contact area type. More...
 
enum  EA3DMDRoughnessMode {
  KA3DRoughnessMode_None = 0,
  KA3DRoughnessModeM = 1,
  KA3DRoughnessModeC = 2,
  KA3DRoughnessModeR = 3,
  KA3DRoughnessModeP = 4,
  KA3DRoughnessModeX = 5,
  KA3DRoughnessModePARA = 6,
  KA3DRoughnessModePERP = 7
}
 Enumerator that describes the direction of lay. More...
 
enum  EA3DMDRoughnessType {
  KA3DRoughnessTypeBasic = 1,
  KA3DRoughnessTypeMachining_Required = 2,
  KA3DRoughnessTypeMachining_Prohibited = 3
}
 Enumerator that describes the roughness type. More...
 

Functions

A3DStatus A3DMarkupRoughnessGet (const A3DMarkupRoughness *pMarkupRoughness, A3DMarkupRoughnessData *pData)
 Populates the A3DMarkupRoughnessData structure. More...
 

Detailed Description

Version
4.0

Enumeration Type Documentation

Enumerator that describes rough contact area type.

Enumerator
KA3DRoughnessContactSurfTexture 

Surface texture.

KA3DRoughnessContactSurfTextAndAllSrfAround 

Surface texture and all surfaces around.

KA3DRoughnessContactBasic 

Basic contact.

KA3DRoughnessContactSrfAround 

All surfaces around.

Enumerator that describes the direction of lay.

Enumerator
KA3DRoughnessMode_None 

No specified lay.

KA3DRoughnessModeM 

Lay multi directional.

KA3DRoughnessModeC 

Lay approximately circular.

KA3DRoughnessModeR 

Lay approximately radial.

KA3DRoughnessModeP 

Lay particulate, non-directional, or protuberant.

KA3DRoughnessModeX 

Lay angular in both directions.

KA3DRoughnessModePARA 

Lay approximately parallel to the line representing the surface.

KA3DRoughnessModePERP 

Lay approximately perpendicular to the line representing the surface.

Enumerator that describes the roughness type.

Enumerator
KA3DRoughnessTypeBasic 

Basic surface texture.

KA3DRoughnessTypeMachining_Required 

Material removal by machining is required.

KA3DRoughnessTypeMachining_Prohibited 

Material removal by machining is prohibited.

Function Documentation

A3DStatus A3DMarkupRoughnessGet ( const A3DMarkupRoughness pMarkupRoughness,
A3DMarkupRoughnessData pData 
)

Populates the A3DMarkupRoughnessData structure.

Version
4.0
Parameters
[in]pMarkupRoughnessInput A3DMarkupRoughness data structure.
[out]pDataOutput A3DMarkupRoughnessData to be populated.
Returns
A3D_INITIALIZE_NOT_CALLED
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_ENTITY_NULL
A3D_INVALID_ENTITY_TYPE
A3D_SUCCESS