#include <hps.h>
The SubwindowKit class is a user space object, useful for carrying a group of attribute settings related to subwindows. Calling SubwindowKit::GetDefault() will return a kit with values found in this table.
SubwindowKit::SubwindowKit |
( |
| ) |
|
Initializes an empty kit.
Copies the kit in_kit into this kit.
The move constructor creates a SubwindowKit by transferring the underlying impl of the rvalue reference to this SubwindowKit thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a SubwindowKit to take the impl from. |
virtual SubwindowKit::~SubwindowKit |
( |
| ) |
|
|
virtual |
bool SubwindowKit::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 Object.
bool SubwindowKit::Equals |
( |
SubwindowKit const & |
in_kit | ) |
const |
Check if the source SubwindowKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Creates a SubwindowKit 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 SubwindowKit with the default settings.
Type SubwindowKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from Object.
bool SubwindowKit::operator!= |
( |
SubwindowKit const & |
in_kit | ) |
const |
Check if the source SubwindowKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this SubwindowKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a SubwindowKit to take the impl from. |
- Returns
- A reference to this SubwindowKit.
Copies the source SubwindowKit into this object.
- Parameters
-
- Returns
- A reference to this object.
bool SubwindowKit::operator== |
( |
SubwindowKit const & |
in_kit | ) |
const |
Check if the source SubwindowKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Copies the source SubwindowKit into this object.
- Parameters
-
in_kit | The source object to copy. |
Controls the type of background to be used for subwindows originating from this segment. This has no effect when applied to segments without a subwindow present.
- Parameters
-
in_bg_type | The type of background to be used for subwindows originating from this segment. |
in_definition_name | the name of a definition to be used in the background. Only relevant if in_bg_type is Image or Cubemap. |
- Returns
- A reference to this object.
Controls the type of border, if any, that should be drawn for subwindows originating from this segment. This has no effect when applied to segments without a subwindow present.
- Parameters
-
in_border_type | The type of border, if any, that should be drawn for subwindows originating from this segment. |
- Returns
- A reference to this object.
Determines the algorithm used to remove objects (or parts of objects) that are hidden from view by other objects. This has no effect when applied to segments without a subwindow present.
- Parameters
-
in_hsra | The algorithm used to identify and remove hidden surfaces. |
- Returns
- A reference to this object.
Defines a portion of the containing window to act as a subwindow. Window segments have an implicit subwindow of -1 to 1 in both x and y directions that cannot be changed. Other segments can be constrained to some portion of that space. Most other subwindow-related settings are only relevant if they are applied on a segment that also contains a subwindow.
- Parameters
-
in_subwindow_position | The portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window. |
in_subwindow_type | The type of subwindow to create. |
- Returns
- A reference to this object.
Copies this object into the given SubwindowKit.
- Parameters
-
out_kit | The SubwindowKit to populate with the contents of this object. |
Shows the window background setting
- Parameters
-
out_bg_type | The type of background to be used for subwindows originating from this segment. |
out_definition_name | the name of a definition to be used in the background. |
- Returns
- true if the setting is valid, false otherwise.
Shows the subwindow border setting
- Parameters
-
out_border_type | The type of border, if any, that should be drawn for subwindows originating from this segment. |
- Returns
- true if the setting is valid, false otherwise.
Shows the rendering algorithm setting.
- Parameters
-
out_hsra | The algorithm used to identify and remove hidden surfaces. |
- Returns
- true if the setting is valid, false otherwise.
Shows the subwindow setting.
- Parameters
-
out_subwindow_position | The portion of the containing window that should be reserved for a subwindow. |
out_subwindow_type | The type of subwindow to create. |
- Returns
- true if the setting is valid, false otherwise.
Removes a subwindow background setting.
- Returns
- A reference to this object.
Removes a subwindow border setting.
- Returns
- A reference to this object.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes a rendering algorithm setting.
- Returns
- A reference to this object.
Removes a subwindow setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: