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

Defines parameters used by the GLTF writer. More...

#include <cadex/GLTF_WriterParameters.hxx>

Inheritance diagram for cadex::GLTF_WriterParameters:
cadex::Base_WriterParameters

Public Types

enum  GLTFFormatType { GLTF , GLB }
 Defines the exported format of GLTF writer.
 
- Public Types inherited from cadex::Base_WriterParameters
typedef std::shared_ptr< internal::Base_WriterParametersImpl > ImplPtrType
 Reserved for internal use.
 

Public Member Functions

GLTFFormatType GLTFFormat () const
 
GLTFFormatTypeGLTFFormat ()
 
bool UseDracoCompression () const
 Returns true if Draco compression will be used and false otherwise.
 
bool & UseDracoCompression ()
 Returns true if Draco compression will be used and false otherwise.
 
- 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_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.
 

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 GLTF writer.

Refer to sdk_format_gltf_settings_export.

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

Member Function Documentation

◆ GLTFFormat() [1/2]

GLTF_WriterParameters::GLTFFormatType & cadex::GLTF_WriterParameters::GLTFFormat ( )
Deprecated:

Kept for preserving binary compatibility. Has no effect.

◆ GLTFFormat() [2/2]

GLTF_WriterParameters::GLTFFormatType cadex::GLTF_WriterParameters::GLTFFormat ( ) const
Deprecated:

Kept for preserving binary compatibility. Has no effect.

◆ UseDracoCompression() [1/2]

bool & cadex::GLTF_WriterParameters::UseDracoCompression ( )

Returns true if Draco compression will be used and false otherwise.

Allows to significantly decrease the size of the mesh. By default is true.

Note
In rare cases the receiving software does not support such a compression and therefore will not import a compressed file.

◆ UseDracoCompression() [2/2]

bool cadex::GLTF_WriterParameters::UseDracoCompression ( ) const

Returns true if Draco compression will be used and false otherwise.

Allows to significantly decrease the size of the mesh. By default is true.

Note
In rare cases the receiving software does not support such a compression and therefore will not import a compressed file.