cadex::Base_ReaderParameters Class Reference

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

#include <cadex/Base_ReaderParameters.hxx>

Inheritance diagram for cadex::Base_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.
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.
bool	SaveExternalReferencePaths () const
	Specifies whether source file path of SGE elements should be stored in its property tables. 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 &	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 () const
	Specifies whether a drawing 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 &	ReadDrawing ()
	Specifies whether a drawing should be read from the file.
internal::Base_ReaderParametersImpl *	Impl () const
	Returns internal implementation object.
template<typename T >
T *	Impl () const
	Reserved for internal use.
const ImplPtrType &	SharedImpl () const
	Reserved for internal use.

Protected Member Functions
	Base_ReaderParameters (internal::Base_ReaderParametersImpl *theImpl)
	Constructor.

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.

Constructor & Destructor Documentation

Base_ReaderParameters()

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

protected

Constructor.

Initializes with default values:

• DelayedConversion() - false.

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.

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.

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.

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