#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_that) |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetHiddenLineSorting (bool in_on, float in_activation_weight=2.0f, HPS::Line::SizeUnits in_units=HPS::Line::SizeUnits::Pixels) |
ExportOptionsKit & | SetResolution (float in_resolution) |
ExportOptionsKit & | SetScale (float in_scale, Hardcopy::SizeUnits in_units=Hardcopy::SizeUnits::Inches) |
ExportOptionsKit & | SetSize (float in_width, float in_height) |
ExportOptionsKit & | SetWYSIWYG (bool in_onoff) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowHiddenLineSorting (bool &out_state, float &out_threshold, HPS::Line::SizeUnits &out_units) const |
bool | ShowResolution (float &out_resolution) const |
bool | ShowScale (float &out_scale, HPS::Hardcopy::SizeUnits &out_units) const |
bool | ShowSize (float &out_width, float &out_height) const |
bool | ShowWYSIWYG (bool &out_onoff) const |
ExportOptionsKit & | UnsetEverything () |
ExportOptionsKit & | UnsetHiddenLineSorting () |
ExportOptionsKit & | UnsetResolution () |
ExportOptionsKit & | UnsetScale () |
ExportOptionsKit & | UnsetSize () |
ExportOptionsKit & | UnsetWYSIWYG () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::HardcopyGDIExportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The ExportOptionsKit class contains settings controlling hardcopy export.
Constructor & Destructor Documentation
HPS::Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS::Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
HPS::Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_that | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an ExportOptionsKit to take the impl from.
Member Function Documentation
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::Hardcopy::GDI::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
bool HPS::Hardcopy::GDI::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ExportOptionsKit to take the impl from.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
- Returns
- A reference to this ExportOptionsKit.
bool HPS::Hardcopy::GDI::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::Hardcopy::GDI::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::SetHiddenLineSorting | ( | bool | in_on, |
float | in_activation_weight = 2.0f , |
||
HPS::Line::SizeUnits | in_units = HPS::Line::SizeUnits::Pixels |
||
) |
Species whether hidden lines are sorted, and if so, what the threshold for sorting is. If Hidden Line Sorting is activated, lines will be printed in proper z-order. If this option is not activated, the order in which lines are printed is non-deterministic. Enabling this option will result in slower performance.
- Parameters
-
in_on Whether to sort hidden lines or not. in_activation_weight What is the minimum size of hidden lines that are sorted. Lines thinner than this will not be sorted. in_units Units applied to in_activation_weight.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::SetResolution | ( | float | in_resolution | ) |
Sets the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
in_resolution Resolution in DPI (dots per unit).
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::SetScale | ( | float | in_scale, |
Hardcopy::SizeUnits | in_units = Hardcopy::SizeUnits::Inches |
||
) |
Scales Visualize units to correspond to real world units. For example, SetScale(1.0f, Hardcopy::SizeUnits::Inches), will make it so that every Visualize unit corresponds to 1 inch for this export, SetScale(2.0f, Hardcopy::SizeUnits::Centimeters), will make it so that every Visualize unit corresponds to 2 centimeters for this export. SetScale(0.2, Hardcopy::SizeUnits::Centimeters), will make it so that every Visualize unit corresponds to 2 millimeters for this export. Setting a scale is not defined for perspective cameras.
- Parameters
-
in_scale the unit scale. in_scale is required to be a positive number. in_units the unit in_scale is expressed in.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::SetSize | ( | float | in_width, |
float | in_height | ||
) |
Sets the size of the image to be exported to the Clipboard or EMF file. This value is ignored for printer export.
- Parameters
-
in_width Width in inches. in_height Height in inches.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::SetWYSIWYG | ( | bool | in_onoff | ) |
Enables or disables wysiwyg hardcopy output
- Parameters
-
onoff true is on, false is off
- Returns
- A reference to this ExportOptionsKit.
void HPS::Hardcopy::GDI::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
bool HPS::Hardcopy::GDI::ExportOptionsKit::ShowHiddenLineSorting | ( | bool & | out_state, |
float & | out_threshold, | ||
HPS::Line::SizeUnits & | out_units | ||
) | const |
Shows the hidden line sorting options of Hardcopy.
- Parameters
-
out_state Whether hidden line sorting is on or off. out_threshold The minimum width at which hidden lines are sorted. out_units The units that out_threshold is measured in.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::Hardcopy::GDI::ExportOptionsKit::ShowResolution | ( | float & | out_resolution | ) | const |
Shows the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
out_resolution Resolution in specified units (dots per unit).
- Returns
- true if a size setting was specified, false otherwise.
bool HPS::Hardcopy::GDI::ExportOptionsKit::ShowScale | ( | float & | out_scale, |
HPS::Hardcopy::SizeUnits & | out_units | ||
) | const |
Shows true if a scale has been set
- Parameters
-
out_scale the scale specified. out_units the units out_scale is specified in.
- Returns
- true if a scale setting was specified, false otherwise.
bool HPS::Hardcopy::GDI::ExportOptionsKit::ShowSize | ( | float & | out_width, |
float & | out_height | ||
) | const |
Shows the size of the image to be exported to the Clipboard or EMF file. This value is ignored for printer export.
- Parameters
-
out_width Width in inches. out_height Height in inches.
- Returns
- true if a size setting was specified, false otherwise.
bool HPS::Hardcopy::GDI::ExportOptionsKit::ShowWYSIWYG | ( | bool & | out_onoff | ) | const |
Shows true if wysiwyg has been enabled
- Returns
- true if a size setting was specified, false otherwise.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetHiddenLineSorting | ( | ) |
Removes the line sorting settings for hidden lines from Hardcopy
- Returns
- A reference to this object.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetResolution | ( | ) |
Removes the resolution of the image to be inserted into the Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetScale | ( | ) |
Removes the scale setting from Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetSize | ( | ) |
Removes the size of the image to be inserted into the Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetWYSIWYG | ( | ) |
Removes the wysiwyg setting from Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h