cadex::ModelData_WriterParameters Class Reference

Defines parameters used by the ModelData_Model::Save() function. More...

#include <cadex/ModelData_WriterParameters.hxx>

Inheritance diagram for cadex::ModelData_WriterParameters:

Public Types
enum	FileFormatType {   CDX = 1 , CDXWEB , Xml = 0 , Binary = CDX ,   Cdxfb = CDXWEB }
Public Types inherited from cadex::Base_WriterParameters
typedef std::shared_ptr< internal::Base_WriterParametersImpl >	ImplPtrType
	Reserved for internal use.

Public Member Functions
FileFormatType	FileFormat () const
	Returns the target format of ModelData_Model export.
FileFormatType &	FileFormat ()
	Sets the target format of ModelData_Model export.
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
Protected Member Functions inherited from cadex::Base_WriterParameters
	Base_WriterParameters (internal::Base_WriterParametersImpl *theImpl)
	Constructor.

Detailed Description

Defines parameters used by the ModelData_Model::Save() function.

Examples

MTKConverter/Program.cs, MTKConverter/main.cxx, conversion/cdxwebconverter/Program.cs, and conversion/cdxwebconverter/main.cxx.

Member Enumeration Documentation

FileFormatType

enum cadex::ModelData_WriterParameters::FileFormatType

Defines the types of native files that ModelData_Model can be saved into.

Enumerator
CDX	Export the model as binary CDX file.
CDXWEB	Export the model as CDXWEB, efficient binary file format used for CAD Exchanger Web Toolkit.
Xml	Deprecated: Export the model as XML.
Binary	Deprecated: Export the model as binary file.
Cdxfb	Deprecated: Export the model as CDXFB, efficient binary file format used for CAD Exchanger Web Toolkit.

Examples

MTKConverter/Program.cs, and conversion/cdxwebconverter/Program.cs.