REFERENCE MANUAL
#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The SubwindowControl class is a smart pointer that is tied to a database object. The SubwindowControl allows you to manipulate the various settings associated with subwindows, such as border, background, and priority. As the main Visualize window is also an implicit subwindow, this control also allows you to set the rendering algorithm. The rendering algorithm should only have a single setting for each window or subwindow. Setting disparate rendering algorithms in multiple places in your scene can lead to unexpected results.
Default values for the various fields of SubwindowControl can be found here.
|
explicit |
Initializes a control tied to the segment in_seg.
SubwindowControl::SubwindowControl | ( | SubwindowControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
SubwindowControl::SubwindowControl | ( | SubwindowControl && | in_that | ) |
The move constructor creates a SubwindowControl by transferring the underlying impl of the rvalue reference to this SubwindowControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SubwindowControl to take the impl from. |
SubwindowControl::~SubwindowControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Control.
SubwindowControl& SubwindowControl::operator= | ( | SubwindowControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SubwindowControl thereby avoiding a copy.
in_that | An rvalue reference to a SubwindowControl to take the impl from. |
SubwindowControl& SubwindowControl::operator= | ( | SubwindowControl const & | in_that | ) |
Share the smart-pointer.
SubwindowControl& SubwindowControl::SetBackground | ( | Subwindow::Background | in_bg_type, |
char const * | in_definition_name = "" |
||
) |
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.
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. |
SubwindowControl& SubwindowControl::SetBorder | ( | Subwindow::Border | in_border_type | ) |
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.
in_border_type | The type of border, if any, that should be drawn for subwindows originating from this segment. |
SubwindowControl& SubwindowControl::SetRenderingAlgorithm | ( | Subwindow::RenderingAlgorithm | in_hsra | ) |
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.
in_hsra | The algorithm used to identify and remove hidden surfaces. |
SubwindowControl& SubwindowControl::SetSubwindow | ( | Rectangle const & | in_window_position, |
Subwindow::Type | in_type = Subwindow::Type::Standard |
||
) |
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.
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. |
bool SubwindowControl::ShowBackground | ( | Subwindow::Background & | out_bg_type, |
UTF8 & | out_definition_name | ||
) | const |
Shows the window background setting
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. |
bool SubwindowControl::ShowBorder | ( | Subwindow::Border & | out_border_type | ) | const |
Shows the subwindow border setting
out_border_type | The type of border, if any, that should be drawn for subwindows originating from this segment. |
bool SubwindowControl::ShowRenderingAlgorithm | ( | Subwindow::RenderingAlgorithm & | out_hsra | ) | const |
Shows the rendering algorithm setting.
out_hsra | The algorithm used to identify and remove hidden surfaces. |
bool SubwindowControl::ShowSubwindow | ( | Rectangle & | out_window_position, |
Subwindow::Type & | out_subwindow_type | ||
) | const |
Shows the subwindow setting.
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. |
SubwindowControl& SubwindowControl::UnsetBackground | ( | ) |
Removes a subwindow background setting.
SubwindowControl& SubwindowControl::UnsetBorder | ( | ) |
Removes a subwindow border setting.
SubwindowControl& SubwindowControl::UnsetEverything | ( | ) |
Removes all settings from this object.
SubwindowControl& SubwindowControl::UnsetRenderingAlgorithm | ( | ) |
Removes a rendering algorithm setting.
SubwindowControl& SubwindowControl::UnsetSubwindow | ( | ) |
Removes a subwindow setting.