Hide menu
Loading...
Searching...
No Matches
cadex.Base_ReaderParameters Class Reference

A base class for most frequently used parameters of all readers. More...

Inheritance diagram for cadex.Base_ReaderParameters:
cadex.ACIS_ReaderParameters cadex.BRep_ReaderParameters cadex.CAT_ReaderParameters cadex.Collada_ReaderParameters cadex.Creo_ReaderParameters cadex.DS3DXML_ReaderParameters cadex.DWG_ReaderParameters cadex.DXF_ReaderParameters cadex.FBX_ReaderParameters cadex.GLTF_ReaderParameters cadex.IFC_ReaderParameters cadex.IGES_ReaderParameters cadex.INV_ReaderParameters cadex.JT_ReaderParameters cadex.NX_ReaderParameters cadex.OBJ_ReaderParameters cadex.PLY_ReaderParameters cadex.PRC_ReaderParameters cadex.Para_ReaderParameters cadex.Revit_ReaderParameters cadex.Rhino_ReaderParameters cadex.SLDE_ReaderParameters cadex.SLD_ReaderParameters cadex.STEP_ReaderParameters cadex.STL_ReaderParameters cadex.U3D_ReaderParameters cadex.VRML_ReaderParameters cadex.X3DPDF_ReaderParameters cadex.X3D_ReaderParameters cadex.X3MF_ReaderParameters

Public Member Functions

 Base_ReaderParameters (global::System.IntPtr cPtr, bool cMemoryOwn)
 
void Dispose ()
 
bool DelayedConversion ()
 Reserved for internal use.
 
bool ReadPMI ()
 Specifies whether Product and Manufacturing Information (PMI) should be read from the file.
 
bool SaveExternalReferencePaths ()
 Specifies whether source file path of SGE elements should be stored in its property tables.
 
void SetLengthUnit (Base_LengthUnit LengthUnit)
 Sets a unit in which to treat geometric data in file.
 
bool ReadDrawing ()
 Specifies whether a drawing should be read from the file.
 
void SetDelayedConversion (bool theDC)
 
void SetReadPMI (bool theReadPMI)
 
void SetSaveExternalReferencePaths (bool theSaveExternalReferencePaths)
 
void SetReadDrawing (bool theReadDrawing)
 

Protected Member Functions

virtual void Dispose (bool disposing)
 

Detailed Description

A base class for most frequently used parameters of all readers.

Base_ReaderParameters accumulates parameters that are used by many (but not necessarily all) readers (subclasses of Base_Reader).

By convention, a reader should have a method Parameters() returning a reference (const and non-const) to a respective subclass of Base_ReaderParameters - for instance, IGES_Reader::Parameters().

See also
Base_WriterParameters.
Examples
visualization/qtquick_qml/baseviewer/main.cxx.

Member Function Documentation

◆ DelayedConversion()

bool & cadex.Base_ReaderParameters.DelayedConversion ( )

Reserved for internal use.

Specifies whether the reader should defer conversion whenever possible or complete it.

Delayed conversion is supported by a few formats (including IGES, STEP, ACIS, Parasolid, JT, Rhino). If the importer supports delayed conversion and the value is set to true then Base_Reader::Transfer() will not execute full conversion of heavy-weight data (such as B-Rep or polygonal representations). Instead a light-weight internal infrastructure will be created which will execute conversion only upon first access to required data.

By default is false.

For more details refer to Delayed Conversion.

Warning
This setting is part of Incremental conversion add-on, which is licensed separetely from the base CAD Exchanger SDK.
If you do not have it, the passed value will not cause any effect and false will be assigned.

◆ ReadDrawing()

bool & cadex.Base_ReaderParameters.ReadDrawing ( )

Specifies whether a drawing should be read from the file.

By default is false.

Examples
exploring/drawings/main.cxx, and visualization/qtquick_qml/drawingviewer/main.cxx.

◆ ReadPMI()

bool & cadex.Base_ReaderParameters.ReadPMI ( )

Specifies whether Product and Manufacturing Information (PMI) should be read from the file.

By default is false.

Warning
This setting is part of PMI add-on, which is licensed separetely from the base CAD Exchanger SDK.
If you do not have it, the passed value will not cause any effect and false will be assigned.
Examples
exploring/pmi/main.cxx.

◆ SaveExternalReferencePaths()

bool & cadex.Base_ReaderParameters.SaveExternalReferencePaths ( )

Specifies whether source file path of SGE elements should be stored in its property tables.

Works only for files with external references.

By default is false.

◆ SetLengthUnit()

void cadex.Base_ReaderParameters.SetLengthUnit ( Base_LengthUnit  LengthUnit)

Sets a unit in which to treat geometric data in file.

By default all data is treated in millimeters. This may be overridden by specifing desired Base_LengthUnit, which is then used as scale factor for geometric data stored in file. This is particularly useful for formats, which do not provide information about units (e.g. OBJ, STL).

Note
Does nothing for formats with explicit unit assignment. For comprehensive information on unit handling in different readers consult Measurement Units.
See also
Base_WriterParameters::LengthUnit().