Hide menu
Loading...
Searching...
No Matches
cadex::ModelData::ModelWriterParameters Class Reference

Defines parameters of the ModelWriter. More...

#include <cadex/ModelData/ModelWriterParameters.hxx>

Inheritance diagram for cadex::ModelData::ModelWriterParameters:
cadex::BaseObject

Public Member Functions

 ModelWriterParameters ()
 Constructor.
 
bool STLEnableMultiPartMode () const
 Specifies whether a model should be formatted part by part or merged.
 
void SetSTLEnableMultiPartMode (bool theSTLEnableMultiPartMode)
 Sets whether a model should be formatted part by part or merged.
 
bool PreferTextFormat () const
 Specifies whether an output should be formatted as text or binary.
 
void SetPreferTextFormat (bool thePreferTextFormat)
 Sets whether an output should be formatted as text or binary.
 
bool WritePCurves () const
 Specifies whether parametric curves should written to the file.
 
void SetWritePCurves (bool theWritePCurves)
 Sets whether parametric curves should written to the file.
 
bool WritePMI () const
 Specifies whether Product and Manufacturing Information (PMI) should be written to the file.
 
void SetWritePMI (bool theWritePMI)
 Sets whether Product and Manufacturing Information (PMI) should be written to the file.
 
- Public Member Functions inherited from cadex::BaseObject
size_t Id () const
 Return unique identifier of public object.
 
internal::BaseObjectImpl * Impl () const
 
bool IsNull () const
 
 operator bool () const
 
template<typename T >
bool IsOfType () const
 
template<typename T >
T * Impl () const
 Reserved for internal use.
 

Additional Inherited Members

- Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl > ImplType
 
- Protected Member Functions inherited from cadex::BaseObject
 BaseObject (const ImplType &theImpl)
 

Detailed Description

Defines parameters of the ModelWriter.

Parameters can be set using ModelWriter::SetParameters().

Constructor & Destructor Documentation

◆ ModelWriterParameters()

cadex::ModelData::ModelWriterParameters::ModelWriterParameters ( )

Constructor.

Member Function Documentation

◆ PreferTextFormat()

bool cadex::ModelData::ModelWriterParameters::PreferTextFormat ( ) const

Specifies whether an output should be formatted as text or binary.

See also
SetPreferTextFormat().

◆ SetPreferTextFormat()

void cadex::ModelData::ModelWriterParameters::SetPreferTextFormat ( bool thePreferTextFormat)

Sets whether an output should be formatted as text or binary.

See also
PreferTextFormat().

◆ SetSTLEnableMultiPartMode()

void cadex::ModelData::ModelWriterParameters::SetSTLEnableMultiPartMode ( bool theSTLEnableMultiPartMode)

Sets whether a model should be formatted part by part or merged.

Warning
Must be false if PreferTextFormat parameter equals false.
See also
STLEnableMultiPartMode().
PreferTextFormat().

◆ SetWritePCurves()

void cadex::ModelData::ModelWriterParameters::SetWritePCurves ( bool theWritePCurves)

Sets whether parametric curves should written to the file.

See also
SetWritePCurves().

◆ SetWritePMI()

void cadex::ModelData::ModelWriterParameters::SetWritePMI ( bool theWritePMI)

Sets whether Product and Manufacturing Information (PMI) should be written to the file.

By default, it is false.

Warning
This setting is part of PMI add-on, which is licensed separately from the base Manufacturing Toolkit.
If you do not have it, the passed value will not cause any effect and false will be assigned.

◆ STLEnableMultiPartMode()

bool cadex::ModelData::ModelWriterParameters::STLEnableMultiPartMode ( ) const

Specifies whether a model should be formatted part by part or merged.

See also
SetSTLEnableMultiPartMode().

◆ WritePCurves()

bool cadex::ModelData::ModelWriterParameters::WritePCurves ( ) const

Specifies whether parametric curves should written to the file.

See also
WritePCurves().

◆ WritePMI()

bool cadex::ModelData::ModelWriterParameters::WritePMI ( ) const

Specifies whether Product and Manufacturing Information (PMI) should be written to the file.

See SetWritePMI().