Hide menu
Loading...
Searching...
No Matches
cadex::Base_WriterParameters Class Reference

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

#include <cadex/Base_WriterParameters.hxx>

Inheritance diagram for cadex::Base_WriterParameters:
cadex::ACIS_WriterParameters cadex::BRep_WriterParameters cadex::Collada_WriterParameters cadex::DXF_WriterParameters cadex::FBX_WriterParameters cadex::GLTF_WriterParameters cadex::IFC_WriterParameters cadex::IGES_WriterParameters cadex::Image_WriterParameters cadex::JT_WriterParameters cadex::ModelData_WriterParameters cadex::OBJ_WriterParameters cadex::Para_WriterParameters cadex::Rhino_WriterParameters cadex::STEP_WriterParameters cadex::STL_WriterParameters cadex::U3D_WriterParameters cadex::USD_WriterParameters cadex::VRML_WriterParameters cadex::X3DPDF_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.
 
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_LengthUnitLengthUnit ()
 Specifies the length unit.
 
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.
 
const Base_UTF16StringAuthor () const
 Returns the author name.
 
Base_UTF16StringAuthor ()
 Specifies the model author name.
 
const Base_UTF16StringOrganization () const
 Returns the organization name.
 
Base_UTF16StringOrganization ()
 Specifies the organization name.
 
const Base_UTF16StringOriginatingSystem () const
 Returns the originating system name.
 
Base_UTF16StringOriginatingSystem ()
 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 ImplPtrTypeSharedImpl () const
 Reserved for internal use.
 

Protected Member Functions

 Base_WriterParameters (internal::Base_WriterParametersImpl *theImpl)
 Constructor.
 

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.

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.

Used in STEP, Rhino, STL, VRML, X3D.

◆ UseOYAsUpAxis()

bool & cadex::Base_WriterParameters::UseOYAsUpAxis ( )

Specifies whether OY should be saved as axis normal.

By default is false.

◆ WriteBRepRepresentation()

bool & cadex::Base_WriterParameters::WriteBRepRepresentation ( )

Specifies whether B-Rep representation should be saved.

Used in formats that support B-Rep representations, such as JT, STEP, Rhino, etc.

◆ WritePMI()

bool & cadex::Base_WriterParameters::WritePMI ( )

Specifies whether Product and Manufacturing Information (PMI) should be saved.

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.

◆ WritePolyRepresentation()

bool & cadex::Base_WriterParameters::WritePolyRepresentation ( )

Specifies whether polygonal representation should be saved.

Used in formats that support polygonal representations, such as JT, STEP, Rhino, etc.

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 formats that support textures, such as OBJ, Rhino, etc.