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

Defines parameters of the image writer. More...

#include <cadex/Image_WriterParameters.hxx>

Inheritance diagram for cadex::Image_WriterParameters:
cadex::Base_WriterParameters

Public Member Functions

 Image_WriterParameters ()
 Constructor.
 
size_t Width () const
 Returns a width of exported image in pixels.
 
void SetWidth (size_t theWidth)
 Sets a width of exported image in pixels.
 
size_t Height () const
 Returns a height of exported image in pixels.
 
void SetHeight (size_t theHeight)
 Sets a height of exported image in pixels.
 
const ModelData_ColorBackgroundColor () const
 Returns a background color of image.
 
void SetBackgroundColor (const ModelData_Color &theColor)
 Sets a background color of image.
 
bool ShowPMI () const
 Returns a flag controlling the display of PMI. If the value is true then PMI annotations will be.
 
void SetShowPMI (bool theShowPMI)
 Sets a flag controlling the display of PMI.
 
- 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

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

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

Examples
conversion/screenshot/Program.cs, and conversion/screenshot/main.cxx.

Constructor & Destructor Documentation

◆ Image_WriterParameters()

cadex::Image_WriterParameters::Image_WriterParameters ( )

Constructor.

Initializes with default values:

See also
Base_WriterParameters::Base_WriterParameters()