A base class for most frequently used parameters of all writers. More...
#include <cadex/Base_WriterParameters.hxx>
Public Types | |
typedef std::shared_ptr< internal::Base_WriterParametersImpl > | ImplPtrType |
Reserved for internal use. | |
Public Member Functions | |
bool | WriteBRepRepresentation () const |
Returns whether B-Rep representation should be saved. | |
bool & | WriteBRepRepresentation () |
Specifies whether B-Rep representation should be saved. | |
bool | WritePolyRepresentation () const |
Returns whether polygonal representation should be saved. | |
bool & | WritePolyRepresentation () |
Specifies whether polygonal representation should be saved. | |
bool | WriteTextures () const |
Returns whether texture should be saved. | |
bool & | WriteTextures () |
Specifies whether texture should be saved. | |
bool | WritePMI () const |
Specifies whether Product and Manufacturing Information (PMI) should be saved. 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 & | WritePMI () |
Specifies whether Product and Manufacturing Information (PMI) should be saved. | |
Base_LengthUnit | LengthUnit () const |
Returns the length unit. | |
Base_LengthUnit & | LengthUnit () |
Specifies the length unit. | |
ModelData_RepresentationMask | PreferredLOD () const |
Returns the type of polygonal representation that should be written. | |
ModelData_RepresentationMask & | PreferredLOD () |
Specifies the type of polygonal representation that should be written. | |
const Base_UTF16String & | Author () const |
Returns the author name. | |
Base_UTF16String & | Author () |
Specifies the model author name. | |
const Base_UTF16String & | Organization () const |
Returns the organization name. | |
Base_UTF16String & | Organization () |
Specifies the organization name. | |
const Base_UTF16String & | OriginatingSystem () const |
Returns the originating system name. | |
Base_UTF16String & | OriginatingSystem () |
Specifies the originating system name. | |
bool | UseOYAsUpAxis () const |
Specifies whether OY should be saved as axis normal. 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 & | UseOYAsUpAxis () |
Specifies whether OY should be saved as axis normal. | |
internal::Base_WriterParametersImpl * | 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_WriterParameters (internal::Base_WriterParametersImpl *theImpl) | |
Constructor. | |
A base class for most frequently used parameters of all writers.
Base_WriterParameters accumulates parameters that are used by many (but not necessarily all) writers (subclasses of Base_Writer).
By convention, the writer should have a method Parameters() returning a reference (const and non-const) to a respective subclass of Base_WriterParameters - for instance, ACIS_Writer::Parameters().
|
protected |
Constructor.
Initializes with default values:
Base_UTF16String & cadex::Base_WriterParameters::Author | ( | ) |
Specifies the model author name.
Will be written in file header for formats which supports this.
Base_LengthUnit & cadex::Base_WriterParameters::LengthUnit | ( | ) |
Specifies the length unit.
The length unit is used to convert all geometric entities and also geometric validation properties.
For comprehensive information on unit handling in different writers consult Measurement Units.
Base_UTF16String & cadex::Base_WriterParameters::Organization | ( | ) |
Specifies the organization name.
Will be written in file header for formats which supports this.
Base_UTF16String & cadex::Base_WriterParameters::OriginatingSystem | ( | ) |
Specifies the originating system name.
Will be written in file header for formats which supports this.
ModelData_RepresentationMask & cadex::Base_WriterParameters::PreferredLOD | ( | ) |
Specifies the type of polygonal representation that should be written.
Taken into account only if there are multiple polygonal representations to choose from. Otherwise the only available polygonal representation is used.
If the specified representation cannot be found or ModelData_RM_Poly is set, then the first available polygonal representation is chosen.
bool & cadex::Base_WriterParameters::UseOYAsUpAxis | ( | ) |
Specifies whether OY should be saved as axis normal.
By default is false.
bool & cadex::Base_WriterParameters::WriteBRepRepresentation | ( | ) |
bool & cadex::Base_WriterParameters::WritePMI | ( | ) |
Specifies whether Product and Manufacturing Information (PMI) should be saved.
By default is false.
false
will be assigned. bool & cadex::Base_WriterParameters::WritePolyRepresentation | ( | ) |