REFERENCE MANUAL
The WindowInfoKit class is a user space object, useful for carrying a group attribute settings. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.WindowInfoKit in_kit) |
Check if the source WindowInfoKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.WindowInfoKit in_kit) |
Copies the source WindowInfoKit into this object. More... | |
HPS.WindowInfoKit | SetPhysicalPixels (uint in_width, uint in_height) |
Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | SetPhysicalSize (float in_width, float in_height) |
Sets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | SetWindowPixels (uint in_width, uint in_height) |
Sets the number of pixels in the window. More... | |
HPS.WindowInfoKit | SetWindowSize (float in_width, float in_height) |
Sets the size, in centimeters, of the window. More... | |
void | Show (out HPS.WindowInfoKit out_kit) |
Copies this object into the given WindowInfoKit. More... | |
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.). More... | |
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.). More... | |
bool | ShowPixelAspectRatio (out float out_pixel_aspect) |
Shows the aspect ratio of the window's pixels. More... | |
bool | ShowResolution (out float out_horizontal, out float out_vertical) |
Shows both the horizontal and vertical resolution of the window. More... | |
bool | ShowWindowAspectRatio (out float out_window_aspect) |
Shows the aspect ratio of the window. More... | |
bool | ShowWindowPixels (out uint out_width, out uint out_height) |
Shows the number of pixels in the window. More... | |
bool | ShowWindowSize (out float out_width, out float out_height) |
Shows the size, in centimeters, of the window. More... | |
HPS.WindowInfoKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.WindowInfoKit | UnsetPhysicalPixels () |
Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | UnsetPhysicalSize () |
Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | UnsetWindowPixels () |
Unsets the number of pixels in the window. More... | |
HPS.WindowInfoKit | UnsetWindowSize () |
Unsets the size, in centimeters, of the window. More... | |
WindowInfoKit () | |
Initializes an empty kit. More... | |
WindowInfoKit (HPS.WindowInfoKit in_kit) | |
Copies the kit in_kit into this kit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.WindowInfoKit a, HPS.WindowInfoKit b) |
static bool | operator== (HPS.WindowInfoKit a, HPS.WindowInfoKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The WindowInfoKit class is a user space object, useful for carrying a group attribute settings.
HPS.WindowInfoKit.WindowInfoKit | ( | ) |
Initializes an empty kit.
HPS.WindowInfoKit.WindowInfoKit | ( | HPS.WindowInfoKit | in_kit | ) |
Copies the kit in_kit into this kit.
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.WindowInfoKit.Equals | ( | HPS.WindowInfoKit | in_kit | ) |
Check if the source WindowInfoKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_window_info_kit" kindref="compound">WindowInfoKit</ref> to compare to this object. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.WindowInfoKit.Set | ( | HPS.WindowInfoKit | in_kit | ) |
Copies the source WindowInfoKit into this object.
in_kit | The source object to copy. |
HPS.WindowInfoKit HPS.WindowInfoKit.SetPhysicalPixels | ( | uint | in_width, |
uint | in_height | ||
) |
Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
in_width | The width of the physical display in pixels. |
in_height | The height of the physical display in pixels. |
HPS.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.).
in_width | The width of the physical display in centimeters. |
in_height | The height of the physical display in centimeters. |
HPS.WindowInfoKit HPS.WindowInfoKit.SetWindowPixels | ( | uint | in_width, |
uint | in_height | ||
) |
Sets the number of pixels in the window.
in_width | The width of the window in pixels. |
in_height | The height of the window in pixels. |
HPS.WindowInfoKit HPS.WindowInfoKit.SetWindowSize | ( | float | in_width, |
float | in_height | ||
) |
Sets the size, in centimeters, of the window.
in_width | The width of the window in centimeters. |
in_height | The height of the window in centimeters. |
void HPS.WindowInfoKit.Show | ( | out HPS.WindowInfoKit | out_kit | ) |
Copies this object into the given WindowInfoKit.
out_kit | The <ref refid="class_h_p_s_1_1_window_info_kit" kindref="compound">WindowInfoKit</ref> to populate with the contents of this object. |
bool HPS.WindowInfoKit.ShowPhysicalPixels | ( | out uint | out_width, |
out uint | out_height | ||
) |
Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
out_width | The width of the physical display in pixels. |
out_height | The height of the physical display in pixels. |
bool HPS.WindowInfoKit.ShowPhysicalSize | ( | out float | out_width, |
out float | out_height | ||
) |
Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
out_width | The width of the physical display in centimeters. |
out_height | The height of the physical display in centimeters. |
bool HPS.WindowInfoKit.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.
out_pixel_aspect | The aspect ratio of the window defined as width / height in pixels. |
bool HPS.WindowInfoKit.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.
out_horizontal | The horizontal resolution of the window. |
out_vertical | The vertical resolution of the window. |
bool HPS.WindowInfoKit.ShowWindowAspectRatio | ( | out float | out_window_aspect | ) |
Shows the aspect ratio of the window.
Aspect ratio is computed as width / height in centimeters.
out_window_aspect | The aspect ratio of the window defined as width / height in centimeters. |
bool HPS.WindowInfoKit.ShowWindowPixels | ( | out uint | out_width, |
out uint | out_height | ||
) |
Shows the number of pixels in the window.
out_width | The width of the window in pixels. |
out_height | The height of the window in pixels. |
bool HPS.WindowInfoKit.ShowWindowSize | ( | out float | out_width, |
out float | out_height | ||
) |
Shows the size, in centimeters, of the window.
out_width | The width of the window in centimeters. |
out_height | The height of the window in centimeters. |
HPS.WindowInfoKit HPS.WindowInfoKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.WindowInfoKit HPS.WindowInfoKit.UnsetPhysicalPixels | ( | ) |
Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
HPS.WindowInfoKit HPS.WindowInfoKit.UnsetPhysicalSize | ( | ) |
Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
HPS.WindowInfoKit HPS.WindowInfoKit.UnsetWindowPixels | ( | ) |
Unsets the number of pixels in the window.
HPS.WindowInfoKit HPS.WindowInfoKit.UnsetWindowSize | ( | ) |
Unsets the size, in centimeters, of the window.