cadex::OBJ_WriterParameters Class Reference

Defines parameters of the OBJ writer. More...

#include <cadex/OBJ_WriterParameters.hxx>

Inheritance diagram for cadex::OBJ_WriterParameters:

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

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.

Detailed Description

Defines parameters of the OBJ writer.

Refer to Exporter Parameters.

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

Examples

conversion/export/Program.cs, conversion/export/main.cxx, conversion/transferparams/Program.cs, and conversion/transferparams/main.cxx.

Member Function Documentation

OverrideDuplicateNames() [1/2]

bool & cadex::OBJ_WriterParameters::OverrideDuplicateNames

(

)

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

By default is true.

OverrideDuplicateNames() [2/2]

bool cadex::OBJ_WriterParameters::OverrideDuplicateNames

(

)

const

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

By default is true.

ReplaceSpacesInNames() [1/2]

bool & cadex::OBJ_WriterParameters::ReplaceSpacesInNames

(

)

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

By default is false

ReplaceSpacesInNames() [2/2]

bool cadex::OBJ_WriterParameters::ReplaceSpacesInNames

(

)

const

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

By default is false

ToGenerateMtlFile() [1/2]

bool & cadex::OBJ_WriterParameters::ToGenerateMtlFile

(

)

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

By default is true.

ToGenerateMtlFile() [2/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, and conversion/transferparams/main.cxx.

WriteNormals() [1/2]

bool & cadex::OBJ_WriterParameters::WriteNormals

(

)

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

By default is true.

WriteNormals() [2/2]

bool cadex::OBJ_WriterParameters::WriteNormals

(

)

const

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

By default is true.