Load Module

Fields

kA3DReadGeomOnly
kA3DReadGeomAndTess
kA3DReadTessOnly
kA3DUnitPoint
kA3DUnitInch
kA3DUnitMillimeter
kA3DUnitCentimeter
kA3DUnitPicas
kA3DUnitFoot
kA3DUnitYard
kA3DUnitMeter
kA3DUnitKilometer
kA3DUnitMile
kA3DUnitMicroInch
kA3DUnitMil
kA3DUnitAngstrom
kA3DUnitNanometer
kA3DUnitMicron
kA3DUnitDecimeter
kA3DUnitDekameter
kA3DUnitHectometer
kA3DUnitGigameter
kA3DUnitAstronomical
kA3DUnitLightYear
kA3DUnitParsec
kA3DUnitUSSurveyFoot
kA3DUnitUSSurveyInch
kA3DUnitUSSurveyYard
kA3DUnitUSSurveyMile
kA3DUnitUnknown
kA3DTessLODExtraLow
kA3DTessLODLow
kA3DTessLODMedium
kA3DTessLODHigh
kA3DTessLODExtraHigh
kA3DTessLODUserDefined
deprecated_kA3DTessLODControlledPrecision
kA3DLastCreoVersionSessionColor
kA3DHExchangeSessionColor
kA3DFileVersionSessionColor
A3DProEReadConstructEntities_AsDatum
A3DProEReadConstructEntities_Yes
A3DProEReadConstructEntities_No
A3DProEFamTabAcceleratorFileOnly
A3DProEFamTabOrUseTessellation
A3DProEFamTabOrUseWireAndGeneric
kA3DStepNameFromNAUO_ID
kA3DStepNameFromNAUO_NAME
kA3DStepNameFromNAUO_DESCRIPTION
kA3DJTTessLODLow
kA3DJTTessLODMedium
kA3DJTTessLODHigh

Functions

A3DStatus A3DAsmModelFileLoadFromFile()
A3DStatus A3DAsmModelFileLoadFromPrcStream()
A3DVoid A3DRWParamsPrcReadHelperFree()
A3DStatus A3DAsmModelFileLoadFromPrcFile()
A3DStatus A3DGet3DPDFStreams()
A3DStatus A3DPDFGetStreams()

Detailed Description

group a3d_read

Loads the model file with information from the input CAD file.

Type Documentation

enum A3DEReadGeomTessMode

A3DSDKReadWrite.

ReadingMode of the model file. Set which kind of content should be read.

Version
3.0

Values:

enumerator kA3DReadGeomOnly

In this mode, Exchange will avoid reading or generating tessellation on B-rep. Faceted elements from the native file will still be imported.

enumerator kA3DReadGeomAndTess

Mixed mode: In this mode, the B-rep and faceted elements are read from the native file. Tessellation is then generated from B-rep elements.

enumerator kA3DReadTessOnly

In this mode, all faceted elements from the native file are read. If present, the native tessellation of the B-rep is read exclusively. Native tessellation is the display list integrated in the CAD file (only available for CATIA V5, Solidworks, 3DXML, and Inventor).

There are some side effects: The tessellation may be not up-to-date with the geometry, the assembly tree can be different, and hidden objects may be missed.

If an element contains only B-rep, tessellation is generated from the B-rep and subsequently the B-rep is removed to save memory.

enum A3DEUnits

Unit values used for model files.

Units in a model file are stored as a double value representing millimeters (mm).

For example, a value of

1000 mm corresponds to a meter (:ref:kA3DUnitMeter).

Below is a table showing the correspondence between units and their values in millimeters:

Name Enumerator Value (millimeters)
Angstrom (Å) kA3DUnitAngstrom 1.e-7
Astronomical (ua) kA3DUnitAstronomical 1.495978707e14
Centimeter (cm) kA3DUnitCentimeter 10.0
Decimeter (dc) kA3DUnitDecimeter 1.e2
Dekameter (dam) kA3DUnitDekameter 1.e4
Foot (ft) kA3DUnitFoot 12.0 * 25.4
Gigameter (gm) kA3DUnitGigameter 1.e12
Hectometer (hm) kA3DUnitHectometer 1.e5
Us survey inch (in) kA3DUnitInch 25.4
Kilometer (km) kA3DUnitKilometer 1000000.0
Light year (ly) kA3DUnitLightYear 9.4607304725808e18
Meter (m) kA3DUnitMeter 1000.0
Microinch (µin) kA3DUnitMicroInch 2.54e-5
Micron (µm) kA3DUnitMicron 1.e-3
Mil (mil) kA3DUnitMil 0.0254
Mile (mi) kA3DUnitMile 1760.0 * 3.0 * 12.0 * 25.4
Millimeter (mm) kA3DUnitMillimeter 1.0
Nanometer (nm) kA3DUnitNanometer 1.e-6
Parsec (pc) kA3DUnitParsec 64800.0 / PI * 1.495978707e14
Picas (pica) kA3DUnitPicas 25.4 / 6.0
Points (points) kA3DUnitPoint 25.4 / 72.0
Us survey foot (ft) kA3DUnitUSSurveyFoot 1200000.0 / 3937.0
Inch (in) kA3DUnitUSSurveyInch 100000.0 / 3937.0
Mile (mi) kA3DUnitUSSurveyMile 1760.0 * 3600000.0 / 3937.0
Us survey yard (yd) kA3DUnitUSSurveyYard 3.0 * 1200000.0 / 3937.0
Yard (yd) kA3DUnitYard 3.0 * 12.0 * 25.4

It is possible to convert a double value to an A3DEUnits with A3DUnitGetFromValue, and back to A3DDouble with A3DUnitGetFromEnum.

See also

/guide/units, A3DUnitGetFromEnum, A3DUnitGetFromValue, A3DAsmModelFileGetUnit

Version
3.0

Values:

enumerator kA3DUnitPoint

Point.

enumerator kA3DUnitInch

Inch (in).

enumerator kA3DUnitMillimeter

Millimeter (mm).

enumerator kA3DUnitCentimeter

Centimeter (cm).

enumerator kA3DUnitPicas

Picas.

enumerator kA3DUnitFoot

Foot (ft).

enumerator kA3DUnitYard

Yard (yd).

enumerator kA3DUnitMeter

Meter (m).

enumerator kA3DUnitKilometer

Kilometer (km).

enumerator kA3DUnitMile

Mile (mi).

enumerator kA3DUnitMicroInch

Micro Inch (µin).

enumerator kA3DUnitMil

Mil.

enumerator kA3DUnitAngstrom

Angstrom (Å).

enumerator kA3DUnitNanometer

Nanometer nm).

enumerator kA3DUnitMicron

Micron (µ).

enumerator kA3DUnitDecimeter

Decimeter (dc).

enumerator kA3DUnitDekameter

Dekameter (dam).

enumerator kA3DUnitHectometer

Hectometer (hm).

enumerator kA3DUnitGigameter

Gigameter (gm).

enumerator kA3DUnitAstronomical

Astronomical (ua).

enumerator kA3DUnitLightYear

Light year (ly).

enumerator kA3DUnitParsec

Parsec (pc).

enumerator kA3DUnitUSSurveyFoot

US Survey foot (ft).

enumerator kA3DUnitUSSurveyInch

US survey inch (in).

enumerator kA3DUnitUSSurveyYard

US survey yard (yd).

enumerator kA3DUnitUSSurveyMile

US survey mile (mi).

enumerator kA3DUnitUnknown

Unknown.

enum A3DETessellationLevelOfDetail

Structure to specify the level of detail of the tessellation.

See A3DRWParamsTessellationData parameters. When a level is given, the Chord Height Ratio (A3DRWParamsTessellationData::m_dChordHeightRatio) and Wireframe Chord Angle (A3DRWParamsTessellationData::m_dAngleToleranceDeg) change to preset values for the selected level.

Version
3.0

Values:

enumerator kA3DTessLODExtraLow

Extra Low level: when selected, these members are automatically defined with the following values:

enumerator kA3DTessLODLow

Low level: when selected, these members are automatically defined with the following values:

enumerator kA3DTessLODMedium

Medium level: when selected, these members are automatically defined with the following values:

enumerator kA3DTessLODHigh

High level: when selected, these members are automatically defined with the following values:

enumerator kA3DTessLODExtraHigh

Extra High level: when selected, these members are automatically defined with the following values:

enumerator kA3DTessLODUserDefined

User Defined level: when selected, these members should be defined:

enumerator deprecated_kA3DTessLODControlledPrecision

Controlled Precision level: when selected, these members should be defined:

enum A3DProESessionColorType

Used to control the default PMI color: If you load a Wildfire file and set kA3DFileVersionSessionColor to:

  • kA3DFileVersionSessionColor, the PMI with no color will be displayed in yellow;
  • kA3DLastCreoVersionSessionColor, the PMI with no color will be displayed in blue as in Creo 2 (for HOOPS Exchange 6.0);
  • kA3DHExchangeSessionColor, the PMI with no color will be displayed with the color you chose.
    Version
    6.1

Values:

enumerator kA3DLastCreoVersionSessionColor

Sets the default session color corresponding to the last version of Creo that HOOPS Exchange supports.

enumerator kA3DHExchangeSessionColor

Uses HOOPS Exchange default color.

enumerator kA3DFileVersionSessionColor

Lets the user define the color by using graphics parameters options ( A3DRWParamsPmiData::m_sDefaultColor).

enum A3DProEReadConstructEntities

Used to control the construction entities reading, entity such as sketch, curves…

Version
8.2

Values:

enumerator A3DProEReadConstructEntities_AsDatum

Read wire if A3DRwParamsGeneralData::m_bReadConstructionAndReferences if A3D_TRUE

enumerator A3DProEReadConstructEntities_Yes

Read wire

enumerator A3DProEReadConstructEntities_No

Do not read wire

enum A3DProEFamilyTables

Used to select how to read family tables.

Version
9.0

Values:

enumerator A3DProEFamTabAcceleratorFileOnly

Only use accelerator file. If there’s tessellation or a generic part, these will not be loaded, even if an accelerator file isn’t available.

enumerator A3DProEFamTabOrUseTessellation

If the accelerator file isn’t present, then search for the tessellation representation: if found, then use the tessellation. If an accelerator file or tessellation isn’t available, then nothing will be loaded.

enumerator A3DProEFamTabOrUseWireAndGeneric

If neither the accelerator file nor the tessellation representation is present, then use the generic or wire representation.

Warning

If using the generic or wire representation, be aware that the representation will not be what it should be! A generic part/wire is only a placeholder.

enum A3DEStepNameFromNAUO

Used to select which name to use from NEXT_ASSEMBLY_USAGE_OCCURRENCE as occurrence name.

See also

NAUO

Version
4.2

Values:

enumerator kA3DStepNameFromNAUO_ID

First Field of NEXT_ASSEMBLY_USAGE_OCCURRENCE.

enumerator kA3DStepNameFromNAUO_NAME

Second Field of NEXT_ASSEMBLY_USAGE_OCCURRENCE.

enumerator kA3DStepNameFromNAUO_DESCRIPTION

Third Field of NEXT_ASSEMBLY_USAGE_OCCURRENCE.

enum A3DEJTReadTessellationLevelOfDetail

JT LOD to retrieve from file.

Version
8.0

Values:

enumerator kA3DJTTessLODLow

Will load the lowest level of tessellation available in the JT file.

enumerator kA3DJTTessLODMedium

Will load an in-between level of tessellation available in the JT file.

enumerator kA3DJTTessLODHigh

Will load the highest level of tessellation available in the JT file.

Function Documentation