WindowInfoKit

class HPS.WindowInfoKit : public HPS.Kit 

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

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.WindowInfoKit in_kit)

Check if the source WindowInfoKit is equivalent to this object.

Param in_kit: The source WindowInfoKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.WindowInfoKit in_kit)

Copies the source WindowInfoKit into this object.

Param in_kit: The source object to copy.

HPS.WindowInfoKit SetPhysicalPixels (uint in_width, uint in_height)

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

Param in_width: The width of the physical display in pixels.
Param in_height: The height of the physical display in pixels.
Return: A reference to this object.

HPS.WindowInfoKit SetPhysicalSize (float in_width, float in_height)

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

Param in_width: The width of the physical display in centimeters.
Param in_height: The height of the physical display in centimeters.
Return: A reference to this object.

HPS.WindowInfoKit SetWindowPixels (uint in_width, uint in_height)

Sets the number of pixels in the window.

Param in_width: The width of the window in pixels.
Param in_height: The height of the window in pixels.
Return: A reference to this object.

HPS.WindowInfoKit SetWindowSize (float in_width, float in_height)

Sets the size, in centimeters, of the window.

Param in_width: The width of the window in centimeters.
Param in_height: The height of the window in centimeters.
Return: A reference to this object.

void Show (out HPS.WindowInfoKit out_kit)

Copies this object into the given WindowInfoKit.

Param out_kit: The WindowInfoKit to populate with the contents of this object.

bool ShowPhysicalPixels (out uint out_width, out uint out_height)

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

Param out_width: The width of the physical display in pixels.
Param out_height: The height of the physical display in pixels.
Return: true if the setting is valid, false otherwise.

bool ShowPhysicalSize (out float out_width, out float out_height)

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

Param out_width: The width of the physical display in centimeters.
Param out_height: The height of the physical display in centimeters.
Return: true if the setting is valid, false otherwise.

bool ShowPixelAspectRatio (out float out_pixel_aspect)

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

Param out_pixel_aspect: The aspect ratio of the window defined as width / height in pixels.
Return: true if the setting is valid, false otherwise.

bool ShowResolution (out float out_horizontal, out float out_vertical)

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.

Param out_horizontal: The horizontal resolution of the window.
Param out_vertical: The vertical resolution of the window.
Return: true if the setting is valid, false otherwise.

bool ShowWindowAspectRatio (out float out_window_aspect)

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

Param out_window_aspect: The aspect ratio of the window defined as width / height in centimeters.
Return: true if the setting is valid, false otherwise.

bool ShowWindowPixels (out uint out_width, out uint out_height)

Shows the number of pixels in the window.

Param out_width: The width of the window in pixels.
Param out_height: The height of the window in pixels.
Return: true if the setting is valid, false otherwise.

bool ShowWindowSize (out float out_width, out float out_height)

Shows the size, in centimeters, of the window.

Param out_width: The width of the window in centimeters.
Param out_height: The height of the window in centimeters.
Return: true if the setting is valid, false otherwise.

HPS.WindowInfoKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.WindowInfoKit UnsetPhysicalPixels ()

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

Return: A reference to this object.

HPS.WindowInfoKit UnsetPhysicalSize ()

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

Return: A reference to this object.

HPS.WindowInfoKit UnsetWindowPixels ()

Unsets the number of pixels in the window.

Return: A reference to this object.

HPS.WindowInfoKit UnsetWindowSize ()

Unsets the size, in centimeters, of the window.

Return: A reference to this object.

WindowInfoKit (): Initializes an empty kit.

WindowInfoKit (HPS.WindowInfoKit in_kit): Copies the kit in_kit into this kit.

Public Static Functions

bool operator!= (HPS.WindowInfoKit a, HPS.WindowInfoKit b)

bool operator== (HPS.WindowInfoKit a, HPS.WindowInfoKit b)