CAD Exchanger SDK
cadex::OBJ_WriterParameters Class Reference

Defines parameters of the OBJ writer. More...

Inheritance diagram for cadex::OBJ_WriterParameters:
cadex::Base_WriterParameters

Public Member Functions

 OBJ_WriterParameters ()
 Constructor.
 
bool ToGenerateMtlFile () const
 Returns true if the write should generates a separate .mtl file. More...
 
bool & ToGenerateMtlFile ()
 Returns true if the write should generates a separate .mtl file. More...
 
bool WriteNormals () const
 Returns true if the normals should be saved in the .obj file. More...
 
bool & WriteNormals ()
 Returns true if the normals should be saved in the .obj file. More...
 
bool OverrideDuplicateNames () const
 Specifies whether original names should be overridden by name with suffix. More...
 
bool & OverrideDuplicateNames ()
 Specifies whether original names should be overridden by name with suffix. More...
 
bool ReplaceSpacesInNames () const
 Specifies whether original names should be overridden by name without space characters. More...
 
bool & ReplaceSpacesInNames ()
 Specifies whether original names should be overridden by name without space characters. More...
 
- Public Member Functions inherited from cadex::Base_WriterParameters
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.
 

Additional Inherited Members

- Public Types inherited from cadex::Base_WriterParameters
typedef std::shared_ptr< internal::Base_WriterParametersImpl > ImplPtrType
 Reserved for internal use.
 
- Protected Member Functions inherited from cadex::Base_WriterParameters
 Base_WriterParameters (internal::Base_WriterParametersImpl *theImpl)
 Constructor. More...
 

Detailed Description

Defines parameters of the OBJ writer.

Refer to Exporter Parameters.

Parameters can be set using OBJ_Writer::Parameters().

Examples:
conversion/export/main.cxx.

Member Function Documentation

◆ OverrideDuplicateNames() [1/2]

bool cadex::OBJ_WriterParameters::OverrideDuplicateNames ( ) const

Specifies whether original names should be overridden by name with suffix.

By default is true.

◆ OverrideDuplicateNames() [2/2]

bool & cadex::OBJ_WriterParameters::OverrideDuplicateNames ( )

Specifies whether original names should be overridden by name with suffix.

By default is true.

◆ ReplaceSpacesInNames() [1/2]

bool cadex::OBJ_WriterParameters::ReplaceSpacesInNames ( ) const

Specifies whether original names should be overridden by name without space characters.

By default is false

◆ ReplaceSpacesInNames() [2/2]

bool & cadex::OBJ_WriterParameters::ReplaceSpacesInNames ( )

Specifies whether original names should be overridden by name without space characters.

By default is false

◆ ToGenerateMtlFile() [1/2]

bool cadex::OBJ_WriterParameters::ToGenerateMtlFile ( ) const

Returns true if the write should generates a separate .mtl file.

By default is true.

Examples:
conversion/export/main.cxx.

◆ ToGenerateMtlFile() [2/2]

bool & cadex::OBJ_WriterParameters::ToGenerateMtlFile ( )

Returns true if the write should generates a separate .mtl file.

By default is true.

◆ WriteNormals() [1/2]

bool cadex::OBJ_WriterParameters::WriteNormals ( ) const

Returns true if the normals should be saved in the .obj file.

By default is true.

◆ WriteNormals() [2/2]

bool & cadex::OBJ_WriterParameters::WriteNormals ( )

Returns true if the normals should be saved in the .obj file.

By default is true.