#include <hps.h>

Inheritance diagram for HPS::WindowInfoKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (WindowInfoKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (WindowInfoKit const &in_kit) const
 
WindowInfoKitoperator= (WindowInfoKit &&in_that)
 
WindowInfoKitoperator= (WindowInfoKit const &in_kit)
 
bool operator== (WindowInfoKit const &in_kit) const
 
void Set (WindowInfoKit const &in_kit)
 
WindowInfoKitSetPhysicalPixels (unsigned int in_width, unsigned int in_height)
 
WindowInfoKitSetPhysicalSize (float in_width, float in_height)
 
WindowInfoKitSetWindowPixels (unsigned int in_width, unsigned int in_height)
 
WindowInfoKitSetWindowSize (float in_width, float in_height)
 
void Show (WindowInfoKit &out_kit) const
 
bool ShowPhysicalPixels (unsigned int &out_width, unsigned int &out_height) const
 
bool ShowPhysicalSize (float &out_width, float &out_height) const
 
bool ShowPixelAspectRatio (float &out_pixel_aspect) const
 
bool ShowResolution (float &out_horizontal, float &out_vertical) const
 
bool ShowWindowAspectRatio (float &out_window_aspect) const
 
bool ShowWindowPixels (unsigned int &out_width, unsigned int &out_height) const
 
bool ShowWindowSize (float &out_width, float &out_height) const
 
WindowInfoKitUnsetEverything ()
 
WindowInfoKitUnsetPhysicalPixels ()
 
WindowInfoKitUnsetPhysicalSize ()
 
WindowInfoKitUnsetWindowPixels ()
 
WindowInfoKitUnsetWindowSize ()
 
 WindowInfoKit ()
 
 WindowInfoKit (WindowInfoKit const &in_kit)
 
 WindowInfoKit (WindowInfoKit &&in_that)
 
virtual ~WindowInfoKit ()
 
- 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 Attributes

static const HPS::Type staticType = HPS::Type::WindowInfoKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The WindowInfoKit class is a user space object, useful for carrying a group attribute settings.

Constructor & Destructor Documentation

◆ WindowInfoKit() [1/3]

HPS::WindowInfoKit::WindowInfoKit ( )

Initializes an empty kit.

◆ WindowInfoKit() [2/3]

HPS::WindowInfoKit::WindowInfoKit ( WindowInfoKit const &  in_kit)

Copies the kit in_kit into this kit.

◆ WindowInfoKit() [3/3]

HPS::WindowInfoKit::WindowInfoKit ( WindowInfoKit &&  in_that)

The move constructor creates a WindowInfoKit by transferring the underlying impl of the rvalue reference to this WindowInfoKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a WindowInfoKit to take the impl from.

◆ ~WindowInfoKit()

virtual HPS::WindowInfoKit::~WindowInfoKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::WindowInfoKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::WindowInfoKit::Equals ( WindowInfoKit const &  in_kit) const

Check if the source WindowInfoKit is equivalent to this object.

Parameters
in_kitThe source WindowInfoKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::WindowInfoKit::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::WindowInfoKit::operator!= ( WindowInfoKit const &  in_kit) const

Check if the source WindowInfoKit is not equivalent to this object.

Parameters
in_kitThe source WindowInfoKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

WindowInfoKit& HPS::WindowInfoKit::operator= ( WindowInfoKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this WindowInfoKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a WindowInfoKit to take the impl from.
Returns
A reference to this WindowInfoKit.

◆ operator=() [2/2]

WindowInfoKit& HPS::WindowInfoKit::operator= ( WindowInfoKit const &  in_kit)

Copies the source WindowInfoKit into this object.

Parameters
in_kitThe source WindowInfoKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::WindowInfoKit::operator== ( WindowInfoKit const &  in_kit) const

Check if the source WindowInfoKit is equivalent to this object.

Parameters
in_kitThe source WindowInfoKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::WindowInfoKit::Set ( WindowInfoKit const &  in_kit)

Copies the source WindowInfoKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetPhysicalPixels()

WindowInfoKit& HPS::WindowInfoKit::SetPhysicalPixels ( unsigned int  in_width,
unsigned int  in_height 
)

Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Parameters
in_widthThe width of the physical display in pixels.
in_heightThe height of the physical display in pixels.
Returns
A reference to this object.

◆ SetPhysicalSize()

WindowInfoKit& HPS::WindowInfoKit::SetPhysicalSize ( float  in_width,
float  in_height 
)

Sets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Parameters
in_widthThe width of the physical display in centimeters.
in_heightThe height of the physical display in centimeters.
Returns
A reference to this object.

◆ SetWindowPixels()

WindowInfoKit& HPS::WindowInfoKit::SetWindowPixels ( unsigned int  in_width,
unsigned int  in_height 
)

Sets the number of pixels in the window.

Parameters
in_widthThe width of the window in pixels.
in_heightThe height of the window in pixels.
Returns
A reference to this object.

◆ SetWindowSize()

WindowInfoKit& HPS::WindowInfoKit::SetWindowSize ( float  in_width,
float  in_height 
)

Sets the size, in centimeters, of the window.

Parameters
in_widthThe width of the window in centimeters.
in_heightThe height of the window in centimeters.
Returns
A reference to this object.

◆ Show()

void HPS::WindowInfoKit::Show ( WindowInfoKit out_kit) const

Copies this object into the given WindowInfoKit.

Parameters
out_kitThe WindowInfoKit to populate with the contents of this object.

◆ ShowPhysicalPixels()

bool HPS::WindowInfoKit::ShowPhysicalPixels ( unsigned int &  out_width,
unsigned int &  out_height 
) const

Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Parameters
out_widthThe width of the physical display in pixels.
out_heightThe height of the physical display in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowPhysicalSize()

bool HPS::WindowInfoKit::ShowPhysicalSize ( float &  out_width,
float &  out_height 
) const

Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Parameters
out_widthThe width of the physical display in centimeters.
out_heightThe height of the physical display in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ ShowPixelAspectRatio()

bool HPS::WindowInfoKit::ShowPixelAspectRatio ( float &  out_pixel_aspect) const

Shows the aspect ratio of the window's pixels. This is computed as the horizontal resolution divided by the vertical resolution.

Parameters
out_pixel_aspectThe aspect ratio of the window defined as width / height in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowResolution()

bool HPS::WindowInfoKit::ShowResolution ( float &  out_horizontal,
float &  out_vertical 
) const

Shows both the horizontal and vertical resolution of the window. Resolution is computed as pixels per centimeter. If the size or the pixels are not set, this function will return false.

Parameters
out_horizontalThe horizontal resolution of the window.
out_verticalThe vertical resolution of the window.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowAspectRatio()

bool HPS::WindowInfoKit::ShowWindowAspectRatio ( float &  out_window_aspect) const

Shows the aspect ratio of the window. Aspect ratio is computed as width / height in centimeters.

Parameters
out_window_aspectThe aspect ratio of the window defined as width / height in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowPixels()

bool HPS::WindowInfoKit::ShowWindowPixels ( unsigned int &  out_width,
unsigned int &  out_height 
) const

Shows the number of pixels in the window.

Parameters
out_widthThe width of the window in pixels.
out_heightThe height of the window in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowSize()

bool HPS::WindowInfoKit::ShowWindowSize ( float &  out_width,
float &  out_height 
) const

Shows the size, in centimeters, of the window.

Parameters
out_widthThe width of the window in centimeters.
out_heightThe height of the window in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

WindowInfoKit& HPS::WindowInfoKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetPhysicalPixels()

WindowInfoKit& HPS::WindowInfoKit::UnsetPhysicalPixels ( )

Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Returns
A reference to this object.

◆ UnsetPhysicalSize()

WindowInfoKit& HPS::WindowInfoKit::UnsetPhysicalSize ( )

Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Returns
A reference to this object.

◆ UnsetWindowPixels()

WindowInfoKit& HPS::WindowInfoKit::UnsetWindowPixels ( )

Unsets the number of pixels in the window.

Returns
A reference to this object.

◆ UnsetWindowSize()

WindowInfoKit& HPS::WindowInfoKit::UnsetWindowSize ( )

Unsets the size, in centimeters, of the window.

Returns
A reference to this object.

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