Data Structures

struct  A3DFRMFeatureTypeData
 Structure describes the feature type. More...
 

Enumerations

enum  EA3DFRMEnumDataType {
  kA3DFRMEnumDataType_None = 0,
  kA3DFRMEnumDataType_CAD,
  kA3DFRMEnumDataType_Mode,
  kA3DFRMEnumDataType_Depth,
  kA3DFRMEnumDataType_Pattern,
  kA3DFRMEnumDataType_HoleShape,
  kA3DFRMEnumDataType_DepthLevel,
  kA3DFRMEnumDataType_RevolveAngle,
  kA3DFRMEnumDataType_Chamfer,
  kA3DFRMEnumDataType_Fillet,
  kA3DFRMEnumDataType_FilletLength,
  kA3DFRMEnumDataType_FilletConic,
  kA3DFRMEnumDataType_LengthMode,
  kA3DFRMEnumDataType_PatternMaster,
  kA3DFRMEnumDataType_ReferenceMaster
}
 Feature type enum. More...
 
enum  EA3DFRMEnumValue_CadType {
  kA3DFRMEnumValue_CadType_None = 0,
  kA3DFRMEnumValue_CadType_Sketch,
  kA3DFRMEnumValue_CadType_Plane,
  kA3DFRMEnumValue_CadType_Point,
  kA3DFRMEnumValue_CadType_CoordinateSystem,
  kA3DFRMEnumValue_CadType_Direction,
  kA3DFRMEnumValue_CadType_Curve,
  kA3DFRMEnumValue_CadType_Analysis,
  kA3DFRMEnumValue_CadType_ImportedSolid,
  kA3DFRMEnumValue_CadType_Extrusion,
  kA3DFRMEnumValue_CadType_Revolution,
  kA3DFRMEnumValue_CadType_Surface,
  kA3DFRMEnumValue_CadType_Block,
  kA3DFRMEnumValue_CadType_Sphere,
  kA3DFRMEnumValue_CadType_Cone,
  kA3DFRMEnumValue_CadType_Cylinder,
  kA3DFRMEnumValue_CadType_Torus,
  kA3DFRMEnumValue_CadType_Dome,
  kA3DFRMEnumValue_CadType_Helix,
  kA3DFRMEnumValue_CadType_TruncatedPrism,
  kA3DFRMEnumValue_CadType_Hole,
  kA3DFRMEnumValue_CadType_Chamfer,
  kA3DFRMEnumValue_CadType_Blend,
  kA3DFRMEnumValue_CadType_Fillet,
  kA3DFRMEnumValue_CadType_Groove,
  kA3DFRMEnumValue_CadType_Pocket,
  kA3DFRMEnumValue_CadType_Sweep,
  kA3DFRMEnumValue_CadType_Pipe,
  kA3DFRMEnumValue_CadType_Group,
  kA3DFRMEnumValue_CadType_Mirror,
  kA3DFRMEnumValue_CadType_Pattern,
  kA3DFRMEnumValue_CadType_GroupPattern,
  kA3DFRMEnumValue_CadType_Instance,
  kA3DFRMEnumValue_CadType_Package,
  kA3DFRMEnumValue_CadType_Shell,
  kA3DFRMEnumValue_CadType_Trim,
  kA3DFRMEnumValue_CadType_Split,
  kA3DFRMEnumValue_CadType_Sew,
  kA3DFRMEnumValue_CadType_Rib,
  kA3DFRMEnumValue_CadType_Draft,
  kA3DFRMEnumValue_CadType_Hollow,
  kA3DFRMEnumValue_CadType_Quilt,
  kA3DFRMEnumValue_CadType_LocalPush,
  kA3DFRMEnumValue_CadType_BooleanOperation,
  kA3DFRMEnumValue_CadType_Intersect,
  kA3DFRMEnumValue_CadType_CutOut,
  kA3DFRMEnumValue_CadType_Merge,
  kA3DFRMEnumValue_CadType_Translate,
  kA3DFRMEnumValue_CadType_Rotate,
  kA3DFRMEnumValue_CadType_Scale,
  kA3DFRMEnumValue_CadType_Offset,
  kA3DFRMEnumValue_CadType_Transformation,
  kA3DFRMEnumValue_CadType_Thread,
  kA3DFRMEnumValue_CadType_Cosmetic,
  kA3DFRMEnumValue_CadType_Material,
  kA3DFRMEnumValue_CadType_Thickness,
  kA3DFRMEnumValue_CadType_RemoveFace,
  kA3DFRMEnumValue_CadType_UserDefined,
  kA3DFRMEnumValue_CadType_Member,
  kA3DFRMEnumValue_CadType_Symmetry
}
 Enumerate the possible types of cad type.
More...
 
enum  EA3DFRMEnumValue_FilletLengthType {
  kA3DFRMEnumValue_FilletLengthType_None = 0,
  kA3DFRMEnumValue_FilletLengthType_Circular,
  kA3DFRMEnumValue_FilletLengthType_Conic,
  kA3DFRMEnumValue_FilletLengthType_Conic_Asymmetric,
  kA3DFRMEnumValue_FilletLengthType_Continue,
  kA3DFRMEnumValue_FilletLengthType_Continue_Asymmetric,
  kA3DFRMEnumValue_FilletLengthType_Curvature,
  kA3DFRMEnumValue_FilletLengthType_Curvature_Asymmetric
}
 Enumerate the possible types of fillet length types
More...
 
enum  EA3DFRMEnumValue_LengthModeType {
  kA3DFRMEnumValue_LengthModeType_None = 0,
  kA3DFRMEnumValue_LengthModeType_ByValue,
  kA3DFRMEnumValue_LengthModeType_Parameter,
  kA3DFRMEnumValue_LengthModeType_Reference
}
 Enumerate the possible types of length mode types
More...
 
enum  EA3DFRMEnumValue_ReferenceMaster {
  kA3DFRMEnumValue_ReferenceMaster_None = 0,
  kA3DFRMEnumValue_ReferenceMaster_Features,
  kA3DFRMEnumValue_ReferenceMaster_CurrentBody,
  kA3DFRMEnumValue_ReferenceMaster_Geometries
}
 Enumerate the possible master type. More...
 
enum  EA3DFRMEnumValue_RevolveAngleType {
  kA3DFRMEnumValue_RevolveAngleType_None = 0,
  kA3DFRMEnumValue_RevolveAngleType_Variable,
  kA3DFRMEnumValue_RevolveAngleType_Variable_Symmetric,
  kA3DFRMEnumValue_RevolveAngleType_Reference,
  kA3DFRMEnumValue_RevolveAngleType_Next
}
 Enumerate the possible types of revolve angle types
This can be used to specify Angle for a Feature Revolution. More...
 
enum  EA3DFRMFamily {
  kA3DFamily_None = 0,
  kA3DFamily_Root,
  kA3DFamily_Information,
  kA3DFamily_Type,
  kA3DFamily_FeatureDefinition,
  kA3DFamily_DoubleData,
  kA3DFamily_IntegerData,
  kA3DFamily_StringData,
  kA3DFamily_Value,
  kA3DFamily_Definition,
  kA3DFamily_Definition_Hole,
  kA3DFamily_Definition_Pattern
}
 Feature family type enum. More...
 
enum  EA3DFRMStatus {
  kA3DFRMStatus_Success = 0,
  kA3DFRMStatus_Failed,
  kA3DFRMStatus_NotYetImplemented
}
 Feature status enum. More...
 

Functions

A3DStatus A3DFRMFeatureGetTypeAsString (const A3DFRMFeature *pFeature, A3DUTF8Char **ppcFeatureType)
 Get the string associated to the feature type. More...
 

Detailed Description

Enumeration Type Documentation

◆ EA3DFRMEnumDataType

Feature type enum.

Version
10.2

#Mechanism for value interpretation feature with type kA3DFamily_Type/kA3DFRMEnumDataType_CAD has m_eDataType::m_eDataType set at kA3DFRMDataEnum, and the function A3DFRMEnumDataGet will return integer values to interpret of values in EA3DFRMEnumValue_CadType enum.

Enumerator
kA3DFRMEnumDataType_None 

Not defined

kA3DFRMEnumDataType_CAD 

EA3DFRMEnumValue_CadType

kA3DFRMEnumDataType_Mode 

EA3DFRMEnumValue_ModeType

kA3DFRMEnumDataType_Depth 

EA3DFRMEnumValue_DepthType

kA3DFRMEnumDataType_Pattern 

EA3DFRMEnumValue_Pattern

kA3DFRMEnumDataType_HoleShape 

EA3DFRMEnumValue_Hole

kA3DFRMEnumDataType_DepthLevel 

EA3DFRMEnumValue_DepthLevel

kA3DFRMEnumDataType_RevolveAngle 

EA3DFRMEnumValue_RevolveAngleType

kA3DFRMEnumDataType_Chamfer 

EA3DFRMEnumValue_ChamferType

kA3DFRMEnumDataType_Fillet 

EA3DFRMEnumValue_FilletType

kA3DFRMEnumDataType_FilletLength 

EA3DFRMEnumValue_FilletLengthType

kA3DFRMEnumDataType_FilletConic 

EA3DFRMEnumValue_FilletConicType

kA3DFRMEnumDataType_LengthMode 

EA3DFRMEnumValue_LengthModeType

kA3DFRMEnumDataType_PatternMaster 

EA3DFRMEnumValue_PatternMaster

kA3DFRMEnumDataType_ReferenceMaster 

EA3DFRMEnumValue_ReferenceMaster

◆ EA3DFRMFamily

Feature family type enum.

Version
10.2
Enumerator
kA3DFamily_None 
kA3DFamily_Root 

see EA3DFRMRoot for possible subtypes

kA3DFamily_Information 

not used

kA3DFamily_Type 

see EA3DFRMEnumDataType for possible subtypes

kA3DFamily_FeatureDefinition 

see EA3DFRMFeatureDefinitionType for possible subtypes

kA3DFamily_DoubleData 

see EA3DFRMDoubleDataType for possible subtypes

kA3DFamily_IntegerData 

see EA3DFRMIntegerDataType for possible subtypes

kA3DFamily_StringData 

see EA3DFRMStringDataType for possible subtypes

kA3DFamily_Value 

see EA3DFRMValueType for possible subtypes

kA3DFamily_Definition 

see for possible subtypes

kA3DFamily_Definition_Hole 

see for possible subtypes

kA3DFamily_Definition_Pattern 

see EA3DFRMDefinitionPatternType for possible subtypes

◆ EA3DFRMStatus

Feature status enum.

Version
10.2
Enumerator
kA3DFRMStatus_Success 

No error

kA3DFRMStatus_Failed 

Error in reading process

kA3DFRMStatus_NotYetImplemented 

Limitation

◆ EA3DFRMEnumValue_CadType

Enumerate the possible types of cad type.

Version
10.2
Enumerator
kA3DFRMEnumValue_CadType_None 

No type specified

kA3DFRMEnumValue_CadType_Sketch 

Sketch

kA3DFRMEnumValue_CadType_Plane 

Plane

kA3DFRMEnumValue_CadType_Point 

Point

kA3DFRMEnumValue_CadType_CoordinateSystem 

CoordinateSystem

kA3DFRMEnumValue_CadType_Direction 

Direction

kA3DFRMEnumValue_CadType_Curve 

Curve

kA3DFRMEnumValue_CadType_Analysis 

Analysis

kA3DFRMEnumValue_CadType_ImportedSolid 

ImportedSolid

kA3DFRMEnumValue_CadType_Extrusion 

Extrude

kA3DFRMEnumValue_CadType_Revolution 

Revolve

kA3DFRMEnumValue_CadType_Surface 

Surface

kA3DFRMEnumValue_CadType_Block 

Block

kA3DFRMEnumValue_CadType_Sphere 

Sphere

kA3DFRMEnumValue_CadType_Cone 

Cone

kA3DFRMEnumValue_CadType_Cylinder 

Cylinder

kA3DFRMEnumValue_CadType_Torus 

Torus

kA3DFRMEnumValue_CadType_Dome 

Dome

kA3DFRMEnumValue_CadType_Helix 

Helix

kA3DFRMEnumValue_CadType_TruncatedPrism 

TruncatedPrism

kA3DFRMEnumValue_CadType_Hole 

Hole

kA3DFRMEnumValue_CadType_Chamfer 

Chamfer

kA3DFRMEnumValue_CadType_Blend 

Blend

kA3DFRMEnumValue_CadType_Fillet 

Fillet

kA3DFRMEnumValue_CadType_Groove 

Groove

kA3DFRMEnumValue_CadType_Pocket 

Pocket

kA3DFRMEnumValue_CadType_Sweep 

Sweep

kA3DFRMEnumValue_CadType_Pipe 

Pipe

kA3DFRMEnumValue_CadType_Group 

Group

kA3DFRMEnumValue_CadType_Mirror 

Mirror

kA3DFRMEnumValue_CadType_Pattern 

Pattern

kA3DFRMEnumValue_CadType_GroupPattern 

Pattern

kA3DFRMEnumValue_CadType_Instance 

Instance, see also Pattern

kA3DFRMEnumValue_CadType_Package 

Package

kA3DFRMEnumValue_CadType_Shell 

Shell

kA3DFRMEnumValue_CadType_Trim 

Trim

kA3DFRMEnumValue_CadType_Split 

Split

kA3DFRMEnumValue_CadType_Sew 

Sew

kA3DFRMEnumValue_CadType_Rib 

Rib

kA3DFRMEnumValue_CadType_Draft 

Draft

kA3DFRMEnumValue_CadType_Hollow 

Hollow

kA3DFRMEnumValue_CadType_Quilt 

Quilt

kA3DFRMEnumValue_CadType_LocalPush 

Local Push

kA3DFRMEnumValue_CadType_BooleanOperation 

Boolean Operation

kA3DFRMEnumValue_CadType_Intersect 

Intersect

kA3DFRMEnumValue_CadType_CutOut 

CutOut

kA3DFRMEnumValue_CadType_Merge 

Merge

kA3DFRMEnumValue_CadType_Translate 

Translate

kA3DFRMEnumValue_CadType_Rotate 

Rotate

kA3DFRMEnumValue_CadType_Scale 

Scale

kA3DFRMEnumValue_CadType_Offset 

Offset

kA3DFRMEnumValue_CadType_Transformation 

Transformation

kA3DFRMEnumValue_CadType_Thread 

Thread

kA3DFRMEnumValue_CadType_Cosmetic 

Cosmetic

kA3DFRMEnumValue_CadType_Material 

Material

kA3DFRMEnumValue_CadType_Thickness 

Thickness

kA3DFRMEnumValue_CadType_RemoveFace 

Remove Face

kA3DFRMEnumValue_CadType_UserDefined 

User Defined

kA3DFRMEnumValue_CadType_Member 

Member, son of an assembly. See Member

kA3DFRMEnumValue_CadType_Symmetry 

Symmetry

◆ EA3DFRMEnumValue_RevolveAngleType

Enumerate the possible types of revolve angle types
This can be used to specify Angle for a Feature Revolution.

Example of usage for a Feature Revolution:

Version
11
Enumerator
kA3DFRMEnumValue_RevolveAngleType_None 

Invalid Revolve Angle Type.

kA3DFRMEnumValue_RevolveAngleType_Variable 

Revolve angle is define with an Angle Value.

kA3DFRMEnumValue_RevolveAngleType_Variable_Symmetric 

Revolve angle is define with an Angle Value, that should be apply symmetrically on both directions.

kA3DFRMEnumValue_RevolveAngleType_Reference 

Depth is define up to the specified reference.

kA3DFRMEnumValue_RevolveAngleType_Next 

Depth is define up to the next surface encountered.

◆ EA3DFRMEnumValue_FilletLengthType

Enumerate the possible types of fillet length types

Version
11
Enumerator
kA3DFRMEnumValue_FilletLengthType_None 
kA3DFRMEnumValue_FilletLengthType_Circular 
kA3DFRMEnumValue_FilletLengthType_Conic 
kA3DFRMEnumValue_FilletLengthType_Conic_Asymmetric 
kA3DFRMEnumValue_FilletLengthType_Continue 
kA3DFRMEnumValue_FilletLengthType_Continue_Asymmetric 
kA3DFRMEnumValue_FilletLengthType_Curvature 
kA3DFRMEnumValue_FilletLengthType_Curvature_Asymmetric 

◆ EA3DFRMEnumValue_LengthModeType

Enumerate the possible types of length mode types

Version
11
Enumerator
kA3DFRMEnumValue_LengthModeType_None 
kA3DFRMEnumValue_LengthModeType_ByValue 
kA3DFRMEnumValue_LengthModeType_Parameter 
kA3DFRMEnumValue_LengthModeType_Reference 

◆ EA3DFRMEnumValue_ReferenceMaster

Enumerate the possible master type.

Version
12
Enumerator
kA3DFRMEnumValue_ReferenceMaster_None 

Invalid reference master Type.

kA3DFRMEnumValue_ReferenceMaster_Features 

The reference master is a feature list

kA3DFRMEnumValue_ReferenceMaster_CurrentBody 

The reference master is the current body

kA3DFRMEnumValue_ReferenceMaster_Geometries 

The reference master is a geometry list

Function Documentation

◆ A3DFRMFeatureGetTypeAsString()

A3DStatus A3DFRMFeatureGetTypeAsString ( const A3DFRMFeature pFeature,
A3DUTF8Char **  ppcFeatureType 
)

Get the string associated to the feature type.

Version
10.2
Parameters
pFeaturefeature pointer
ppcFeatureTypeassociated string
Returns
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_ERROR
A3D_SUCCESS.