CAD Exchanger SDK
cadex::Base_WriterParameters Class Reference

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

Inheritance diagram for cadex::Base_WriterParameters:
cadex::ACIS_WriterParameters cadex::BRep_WriterParameters cadex::IGES_WriterParameters cadex::JT_WriterParameters cadex::OBJ_WriterParameters cadex::Para_WriterParameters cadex::Rhino_WriterParameters cadex::STEP_WriterParameters cadex::STL_WriterParameters cadex::VRML_WriterParameters cadex::X3D_WriterParameters

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. More...
 
bool WritePolyRepresentation () const
 Returns whether polygonal representation should be saved.
 
bool & WritePolyRepresentation ()
 Specifies whether polygonal representation should be saved. More...
 
bool WriteTextures () const
 Returns whether texture should be saved.
 
bool & WriteTextures ()
 Specifies whether texture should be saved. More...
 
Base_LengthUnit LengthUnit () const
 Returns the length unit.
 
Base_LengthUnitLengthUnit ()
 Specifies the length unit. More...
 
ModelData_RepresentationMask PreferredLOD () const
 Returns the type of polygonal representation that should be written.
 
ModelData_RepresentationMaskPreferredLOD ()
 Specifies the type of polygonal representation that should be written. More...
 
const Base_UTF16StringAuthor () const
 Returns the author name.
 
Base_UTF16StringAuthor ()
 Specifies the model author name. More...
 
const Base_UTF16StringOrganization () const
 Returns the organization name.
 
Base_UTF16StringOrganization ()
 Specifies the organization name. More...
 
const Base_UTF16StringOriginatingSystem () const
 Returns the originating system name.
 
Base_UTF16StringOriginatingSystem ()
 Specifies the originating system name. More...
 
internal::Base_WriterParametersImpl * 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_WriterParameters (internal::Base_WriterParametersImpl *theImpl)
 Constructor. More...
 

Detailed Description

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

See also
Base_ReaderParameters.

Constructor & Destructor Documentation

◆ Base_WriterParameters()

cadex::Base_WriterParameters::Base_WriterParameters ( internal::Base_WriterParametersImpl *  theImpl)
protected

Constructor.

Initializes with default values:

Member Function Documentation

◆ Author()

Base_UTF16String & cadex::Base_WriterParameters::Author ( )

Specifies the model author name.

Will be written in file header for formats which supports this.

◆ LengthUnit()

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.

Warning
Custom properties are always converted "as-is", i.e. are not affected by length unit.

For comprehensive information on unit handling in different writers consult Measurement Units.

◆ Organization()

Base_UTF16String & cadex::Base_WriterParameters::Organization ( )

Specifies the organization name.

Will be written in file header for formats which supports this.

◆ OriginatingSystem()

Base_UTF16String & cadex::Base_WriterParameters::OriginatingSystem ( )

Specifies the originating system name.

Will be written in file header for formats which supports this.

◆ PreferredLOD()

ModelData_RepresentationMask & cadex::Base_WriterParameters::PreferredLOD ( )

Specifies the type of polygonal representation that should be written.

If specified representation can not be found or ModelData_RM_Poly is set, then the first valid one is chosen.

Used in STEP, Rhino.

◆ WriteBRepRepresentation()

bool & cadex::Base_WriterParameters::WriteBRepRepresentation ( )

Specifies whether B-Rep representation should be saved.

Used in JT, STEP, Rhino.

◆ WritePolyRepresentation()

bool & cadex::Base_WriterParameters::WritePolyRepresentation ( )

Specifies whether polygonal representation should be saved.

Used in JT, STEP, Rhino.

Note
If set to true and the source model does not contain polygonal representation, it is created on the fly.

◆ WriteTextures()

bool & cadex::Base_WriterParameters::WriteTextures ( )

Specifies whether texture should be saved.

Used in OBJ, Rhino.