#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::HardcopyGDIExportOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The ExportOptionsKit class contains settings controlling hardcopy export.
◆ ExportOptionsKit() [1/3]
HPS::Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit |
( |
| ) |
|
◆ ExportOptionsKit() [2/3]
HPS::Hardcopy::GDI::ExportOptionsKit::ExportOptionsKit |
( |
ExportOptionsKit const & |
in_kit | ) |
|
◆ ExportOptionsKit() [3/3]
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
-
◆ Empty()
bool HPS::Hardcopy::GDI::ExportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Hardcopy::GDI::ExportOptionsKit::Equals |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
◆ ObjectType()
HPS::Type HPS::Hardcopy::GDI::ExportOptionsKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
◆ operator!=()
bool HPS::Hardcopy::GDI::ExportOptionsKit::operator!= |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ExportOptionsKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::Hardcopy::GDI::ExportOptionsKit::operator== |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
◆ Set()
void HPS::Hardcopy::GDI::ExportOptionsKit::Set |
( |
ExportOptionsKit const & |
in_kit | ) |
|
◆ SetBackgroundPreference()
The background preference setting is used to decide how the background of this Hardcopy operation will be handled. If no preference is specified, the background will be forced to be white.
- Parameters
-
in_background_preference | how the background for this Hardcopy export will be handled. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetHiddenLineSorting()
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.
◆ SetRenderingAlgorithm()
The rendering algorithm setting is used to decide how the Hardcopy export will be performed. If no preference is specified, two passes will be used for the Hardcopy export.
- Parameters
-
in_rendering_algorithm | how the Hardcopy export will be handled. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetResolution()
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.
◆ SetScale()
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.
◆ SetSize()
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.
◆ SetWYSIWYG()
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.
◆ Show()
void HPS::Hardcopy::GDI::ExportOptionsKit::Show |
( |
ExportOptionsKit & |
out_kit | ) |
const |
◆ ShowBackgroundPreference()
Shows the background preference for this Hardcopy export.
- Parameters
-
out_background_preference | the preference for the background of this Hardcopy export. |
- Returns
- true if a background preference setting was specified, false otherwise.
◆ ShowHiddenLineSorting()
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.
◆ ShowRenderingAlgorithm()
Shows the rendering algorithm for this Hardcopy export.
- Parameters
-
out_rendering_algorithm | the rendering algorithm setting of this Hardcopy export. |
- Returns
- true if a rendering algorithm setting was specified, false otherwise.
◆ ShowResolution()
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.
◆ ShowScale()
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.
◆ ShowSize()
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.
◆ ShowWYSIWYG()
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.
◆ UnsetBackgroundPreference()
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetBackgroundPreference |
( |
| ) |
|
◆ UnsetEverything()
◆ UnsetHiddenLineSorting()
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetHiddenLineSorting |
( |
| ) |
|
Removes the line sorting settings for hidden lines from Hardcopy
- Returns
- A reference to this object.
◆ UnsetRenderingAlgorithm()
ExportOptionsKit& HPS::Hardcopy::GDI::ExportOptionsKit::UnsetRenderingAlgorithm |
( |
| ) |
|
◆ UnsetResolution()
◆ UnsetScale()
◆ UnsetSize()
◆ UnsetWYSIWYG()
The documentation for this class was generated from the following file: