HPS::Hardcopy::File::ExportOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::Hardcopy::File::ExportOptionsKit:
HPS::Kit HPS::Object

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
 
ExportOptionsKitoperator= (ExportOptionsKit &&in_that)
 
ExportOptionsKitoperator= (ExportOptionsKit const &in_kit)
 
bool operator== (ExportOptionsKit const &in_kit) const
 
void Set (ExportOptionsKit const &in_kit)
 
ExportOptionsKitSetResolution (float in_resolution, Hardcopy::ResolutionUnits in_units=Hardcopy::ResolutionUnits::DPI)
 
ExportOptionsKitSetScale (float in_scale, Hardcopy::SizeUnits in_units=Hardcopy::SizeUnits::Inches)
 
ExportOptionsKitSetSize (float in_width, float in_height, Hardcopy::SizeUnits in_units=Hardcopy::SizeUnits::Inches)
 
ExportOptionsKitSetWYSIWYG (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
 
ExportOptionsKitUnsetEverything ()
 
ExportOptionsKitUnsetResolution ()
 
ExportOptionsKitUnsetScale ()
 
ExportOptionsKitUnsetSize ()
 
ExportOptionsKitUnsetWYSIWYG ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static ExportOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (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_kitThe 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_thatAn rvalue reference to an ExportOptionsKit to take the impl from.

Member Function Documentation

bool HPS::Hardcopy::File::ExportOptionsKit::Empty ( ) const
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_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
static ExportOptionsKit HPS::Hardcopy::File::ExportOptionsKit::GetDefault ( )
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.
HPS::Type HPS::Hardcopy::File::ExportOptionsKit::ObjectType ( ) const
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_kitThe 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_thatAn 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_kitThe 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_kitThe 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_kitThe 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_resolutionResolution (dots per inch or dots per centimeter).
in_unitsUnits 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_scalethe unit scale. in_scale is required to be a positive number.
in_unitsthe 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_widthWidth in inches.
in_heightHeight in inches.
in_unitsUnits 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_onofftrue 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_kitThe 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_resolutionResolution (dots per inch or dots per centimeter).
out_unitsUnits 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_scalethe scale specified.
out_unitsthe 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_widthWidth.
out_heightHeight.
out_unitsUnits 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_onoffwhether '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: