REFERENCE MANUAL
The WindowInfoControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. 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... | |
WindowInfoControl (HPS.WindowKey in_window) | |
Initializes a control tied to the window segment in_window. More... | |
WindowInfoControl (HPS.WindowInfoControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The WindowInfoControl class is a smart pointer that is tied to a database object.
This object allows you to query various attributes about a window, such as its size and aspect ratio.
HPS.WindowInfoControl.WindowInfoControl | ( | HPS.WindowKey | in_window | ) |
Initializes a control tied to the window segment in_window.
HPS.WindowInfoControl.WindowInfoControl | ( | HPS.WindowInfoControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
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.
bool HPS.WindowInfoControl.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.WindowInfoControl.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.WindowInfoControl.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.WindowInfoControl.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.WindowInfoControl.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.WindowInfoControl.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.WindowInfoControl.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. |