CAD Exchanger SDK
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::IFC_ReaderParameters cadex::IGES_ReaderParameters cadex::JT_ReaderParameters cadex::OBJ_ReaderParameters cadex::Para_ReaderParameters cadex::Rhino_ReaderParameters cadex::SLD_ReaderParameters cadex::STEP_ReaderParameters cadex::STL_ReaderParameters cadex::VRML_ReaderParameters

Public Types

typedef std::shared_ptr< internal::Base_ReaderParametersImpl > ImplPtrType
 Reserved for internal use.
 

Public Member Functions

bool DelayedConversion () const
 Specifies whether the import should fully complete conversion or defer it This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.See above for non-const method.
 
bool & DelayedConversion ()
 Specifies whether the reader should defer conversion whenever possible or complete it. More...
 
bool ReadPMI () const
 Specifies whether Product and Manufacturing Information (PMI) should be read from the file. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.See above for non-const method.
 
bool & ReadPMI ()
 Specifies whether Product and Manufacturing Information (PMI) should be read from the file. More...
 
void SetLengthUnit (Base_LengthUnit LengthUnit)
 Sets a unit in which to treat geometric data in file. More...
 
internal::Base_ReaderParametersImpl * Impl () const
 Returns internal implementation object.
 
template<typename T >
T * Impl () const
 Reserved for internal use.
 
const ImplPtrTypeSharedImpl () const
 Reserved for internal use.
 

Protected Member Functions

 Base_ReaderParameters (internal::Base_ReaderParametersImpl *theImpl)
 Constructor. More...
 

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.

Constructor & Destructor Documentation

◆ Base_ReaderParameters()

cadex::Base_ReaderParameters::Base_ReaderParameters ( internal::Base_ReaderParametersImpl *  theImpl)
protected

Constructor.

Initializes with default values:

Member Function Documentation

◆ DelayedConversion()

bool & cadex::Base_ReaderParameters::DelayedConversion ( )

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.

◆ ReadPMI()

bool & cadex::Base_ReaderParameters::ReadPMI ( )

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

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().