The HPS::Hardcopy::File::ExportOptionsKit class contains settings controlling hardcopy export. More...

#include <hps.h>

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

Collaboration diagram for HPS::Hardcopy::File::ExportOptionsKit:

Public Member Functions
	ExportOptionsKit ()
	The default constructor creates an empty ExportOptionsKit object. More...

	ExportOptionsKit (ExportOptionsKit const &in_kit)
	The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More...

	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. More...

ExportOptionsKit &	operator= (ExportOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy. More...

virtual	~ExportOptionsKit ()

HPS::Type	ObjectType () const

void	Set (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...

void	Show (ExportOptionsKit &out_kit) const
	Copies this ExportOptionsKit into the given ExportOptionsKit. More...

ExportOptionsKit &	operator= (ExportOptionsKit const &in_kit)
	Copies the source ExportOptionsKit into this ExportOptionsKit. More...

bool	Empty () const
	Indicates whether this ExportOptionsKit has any values set on it. More...

bool	Equals (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...

bool	operator== (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More...

bool	operator!= (ExportOptionsKit const &in_kit) const
	Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit. More...

bool	ShowSize (float &out_width, float &out_height, Hardcopy::SizeUnits &out_units) const
	Shows the size of the image to be inserted into the Hardcopy. More...

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. More...

ExportOptionsKit &	UnsetSize ()
	Removes the size of the image to be inserted into the Hardcopy. More...

bool	ShowResolution (float &out_resolution, Hardcopy::ResolutionUnits &out_units) const
	Shows the resolution of the image to be inserted into the Hardcopy. More...

ExportOptionsKit &	SetResolution (float in_resolution, Hardcopy::ResolutionUnits in_units=Hardcopy::ResolutionUnits::DPI)
	Sets the resolution of the image to be inserted into the Hardcopy. More...

ExportOptionsKit &	UnsetResolution ()
	Removes the resolution of the image to be inserted into the Hardcopy. More...

bool	ShowHiddenLineSorting (bool &out_state, float &out_threshold, HPS::Line::SizeUnits &out_units) const
	Shows the hidden line sorting options of Hardcopy. More...

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. More...

ExportOptionsKit &	UnsetHiddenLineSorting ()
	Removes the line sorting settings for hidden lines from Hardcopy. More...

bool	ShowWYSIWYG (bool &out_onoff) const
	Shows true if wysiwyg has been enabled. More...

ExportOptionsKit &	SetWYSIWYG (bool in_onoff)
	Enables or disables WYSIWYG hardcopy output. More...

ExportOptionsKit &	UnsetWYSIWYG ()
	Removes the wysiwyg setting from Hardcopy. More...

bool	ShowScale (float &out_scale, HPS::Hardcopy::SizeUnits &out_units) const
	Shows true if a scale has been set. More...

ExportOptionsKit &	SetScale (float in_scale, Hardcopy::SizeUnits in_units=Hardcopy::SizeUnits::Inches)
	Scales Visualize units to correspond to real world units. More...

ExportOptionsKit &	UnsetScale ()
	Removes the scale setting from Hardcopy. More...

ExportOptionsKit &	UnsetEverything ()
	Removes all settings from this ExportOptionsKit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static ExportOptionsKit	GetDefault ()
	Creates a ExportOptionsKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::HardcopyExportOptionsKit

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

◆ ExportOptionsKit() [1/3]

HPS::Hardcopy::File::ExportOptionsKit::ExportOptionsKit ( )

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/3]

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.

◆ ExportOptionsKit() [3/3]

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.

◆ ~ExportOptionsKit()

virtual HPS::Hardcopy::File::ExportOptionsKit::~ExportOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

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.

◆ Equals()

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.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::Hardcopy::File::ExportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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.

◆ operator=() [1/2]

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.

◆ operator=() [2/2]

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.

◆ operator==()

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.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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.

◆ SetHiddenLineSorting()

ExportOptionsKit& HPS::Hardcopy::File::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.

◆ SetResolution()

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

◆ SetScale()

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.

◆ SetSize()

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

◆ SetWYSIWYG()

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

◆ Show()

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.

◆ ShowHiddenLineSorting()

bool HPS::Hardcopy::File::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.

◆ ShowResolution()

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.

◆ ShowScale()

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.

◆ ShowSize()

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.

◆ ShowWYSIWYG()

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.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetEverything()

ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetEverything ( )

Removes all settings from this ExportOptionsKit.

Returns: A reference to this ExportOptionsKit.

◆ UnsetHiddenLineSorting()

ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetHiddenLineSorting ( )

Removes the line sorting settings for hidden lines from Hardcopy.

Returns: A reference to this object.

◆ UnsetResolution()

ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetResolution ( )

Removes the resolution of the image to be inserted into the Hardcopy.

Returns: A reference to this ExportOptionsKit.

◆ UnsetScale()

ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetScale ( )

Removes the scale setting from Hardcopy.

Returns: A reference to this ExportOptionsKit.

◆ UnsetSize()

ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetSize ( )

Removes the size of the image to be inserted into the Hardcopy.

Returns: A reference to this ExportOptionsKit.

◆ UnsetWYSIWYG()

ExportOptionsKit& HPS::Hardcopy::File::ExportOptionsKit::UnsetWYSIWYG ( )

Removes the wysiwyg setting from Hardcopy.

Returns: A reference to this ExportOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Hardcopy::File::ExportOptionsKit::staticType = HPS::Type::HardcopyExportOptionsKit

static

The documentation for this class was generated from the following file:

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExportOptionsKit() [1/3]

◆ ExportOptionsKit() [2/3]

◆ ExportOptionsKit() [3/3]

◆ ~ExportOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetHiddenLineSorting()

◆ SetResolution()

◆ SetScale()

◆ SetSize()

◆ SetWYSIWYG()

◆ Show()

◆ ShowHiddenLineSorting()

◆ ShowResolution()

◆ ShowScale()

◆ ShowSize()

◆ ShowWYSIWYG()

◆ Type()

◆ UnsetEverything()

◆ UnsetHiddenLineSorting()

◆ UnsetResolution()

◆ UnsetScale()

◆ UnsetSize()

◆ UnsetWYSIWYG()

Member Data Documentation

◆ staticType