#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 & | SetResolution (float in_resolution, Hardcopy::ResolutionUnits in_units=Hardcopy::ResolutionUnits::DPI) |
ExportOptionsKit & | SetScale (float in_scale, Hardcopy::SizeUnits in_units=Hardcopy::SizeUnits::Inches) |
ExportOptionsKit & | SetSize (float in_width, float in_height, Hardcopy::SizeUnits in_units=Hardcopy::SizeUnits::Inches) |
ExportOptionsKit & | SetWYSIWYG (bool in_onoff) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowResolution (float &out_resolution, Hardcopy::ResolutionUnits &out_units) const |
bool | ShowScale (float &out_scale, HPS::Hardcopy::SizeUnits &out_units) const |
bool | ShowSize (float &out_width, float &out_height, Hardcopy::SizeUnits &out_units) const |
bool | ShowWYSIWYG (bool &out_onoff) const |
ExportOptionsKit & | UnsetEverything () |
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 Member Functions | |
static ExportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The HPS::Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. Calling HPS::Hardcopy::File::ExportOptionsKit::GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
HPS::Hardcopy::File::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS::Hardcopy::File::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::File::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::File::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.
|
static |
Creates a ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A ExportOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
bool HPS::Hardcopy::File::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::File::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::File::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::File::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::File::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::SetResolution | ( | float | in_resolution, |
Hardcopy::ResolutionUnits | in_units = Hardcopy::ResolutionUnits::DPI |
||
) |
Sets the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
in_resolution Resolution (dots per inch or dots per centimeter). in_units Units of preceding arguments. Defaults to Inches.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
ExportOptionsKit& HPS::Hardcopy::File::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::File::ExportOptionsKit::SetSize | ( | float | in_width, |
float | in_height, | ||
Hardcopy::SizeUnits | in_units = Hardcopy::SizeUnits::Inches |
||
) |
Sets the size of the image to be inserted into the Hardcopy.
- Parameters
-
in_width Width in inches. in_height Height in inches. in_units Units of preceding arguments. Defaults to Inches
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::SetWYSIWYG | ( | bool | in_onoff | ) |
Enables or disables WYSIWYG hardcopy output. The WYSIWYG setting (which stands for What You See Is What You Get) works as follows:
- If true, what you see on the screen is what will be printed. This is the default.
- If false, everything which will fit on the page size you have specified will be printed, even if some of that is not on screen when you issue the command.
- Parameters
-
in_onoff true is on, false is off.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
void HPS::Hardcopy::File::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::File::ExportOptionsKit::ShowResolution | ( | float & | out_resolution, |
Hardcopy::ResolutionUnits & | out_units | ||
) | const |
Shows the resolution of the image to be inserted into the Hardcopy.
- Parameters
-
out_resolution Resolution (dots per inch or dots per centimeter). out_units Units of preceding arguments.
- Returns
- true if a size setting was specified, false otherwise.
bool HPS::Hardcopy::File::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::File::ExportOptionsKit::ShowSize | ( | float & | out_width, |
float & | out_height, | ||
Hardcopy::SizeUnits & | out_units | ||
) | const |
Shows the size of the image to be inserted into the Hardcopy.
- Parameters
-
out_width Width. out_height Height. out_units Units of preceding arguments.
- Returns
- true if a size setting was specified, false otherwise.
bool HPS::Hardcopy::File::ExportOptionsKit::ShowWYSIWYG | ( | bool & | out_onoff | ) | const |
Shows true if wysiwyg has been enabled
- Parameters
-
out_onoff whether 'what you see is what you get' is turned on or off
- Returns
- true if a wysiwyg setting was specified, false otherwise.
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetResolution | ( | ) |
Removes the resolution of the image to be inserted into the Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetScale | ( | ) |
Removes the scale setting from Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetSize | ( | ) |
Removes the size of the image to be inserted into the Hardcopy.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Hardcopy::File::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