#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::WindowKey |
![]() | |
static const HPS::Type | staticType = HPS::Type::SegmentKey |
![]() | |
static const HPS::Type | staticType = HPS::Type::Key |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The WindowKey class is a smart pointer to a database object. Windows are special segments that are backed by a driver instance and a physical window. Some operations and attributes can only be performed or set from window keys. The WindowKey class itself is a base class for more specific window types (application windows, off-screen windows, stand-alone windows).
Constructor & Destructor Documentation
◆ WindowKey() [1/4]
HPS::WindowKey::WindowKey | ( | ) |
An uninitialized key refers to no database object and Type() will return Type::None.
◆ WindowKey() [2/4]
HPS::WindowKey::WindowKey | ( | WindowKey const & | in_window | ) |
Shares a reference to a database object referred to by in_window.
◆ WindowKey() [3/4]
HPS::WindowKey::WindowKey | ( | WindowKey && | in_that | ) |
◆ WindowKey() [4/4]
HPS::WindowKey::WindowKey | ( | Key const & | in_key | ) |
Shares a reference to a database object referred to by in_that. If the key assignment is invalid, this key will revert to an uninitialized state.
◆ ~WindowKey()
HPS::WindowKey::~WindowKey | ( | ) |
Releases a reference to a database object but does not destroy the database object.
Member Function Documentation
◆ ConvertCoordinate()
bool HPS::WindowKey::ConvertCoordinate | ( | Coordinate::Space | in_space, |
Point const & | in_point, | ||
Coordinate::Space | in_output_space, | ||
Point & | out_point | ||
) | const |
Converts the point in_point from in_space to in_output_space using the transforms associated with this window. Returns success.
◆ FindFonts()
size_t HPS::WindowKey::FindFonts | ( | FontSearchResults & | out_results | ) | const |
Searches the system for fonts.
- Parameters
-
out_results Out parameter that contains results of the font search
- Returns
- The number of fonts found
◆ FindHighlights() [1/2]
size_t HPS::WindowKey::FindHighlights | ( | HighlightSearchOptionsKit const & | in_options, |
HighlightSearchResults & | out_results | ||
) | const |
Searches for any highlights under this WindowKey.
- Parameters
-
in_options Search options constraining what type of highlights to look for. If this is empty, all highlights will be returned. out_results The key paths under the window that are highlighted with the given search options.
- Returns
- The number of highlighted key paths found.
◆ FindHighlights() [2/2]
size_t HPS::WindowKey::FindHighlights | ( | KeyPath const & | in_key_path, |
HPS::HighlightSearch::Scope | in_scope, | ||
HighlightSearchOptionsKit const & | in_options, | ||
HighlightSearchResults & | out_results | ||
) | const |
Searches for any highlights under this WindowKey.
- Parameters
-
in_key_path The key path to scope this highlight search by. in_scope Determines how the scope is interpreted during a highlight search. in_options Search options constraining what type of highlights to look for. If this is empty, all highlights will be returned. out_results The key paths under the window that are highlighted with the given search options.
- Returns
- The number of highlighted key paths found.
◆ GetDebuggingControl() [1/2]
DebuggingControl HPS::WindowKey::GetDebuggingControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment.
◆ GetDebuggingControl() [2/2]
DebuggingControl const HPS::WindowKey::GetDebuggingControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment.
◆ GetEventDispatcher() [1/2]
EventDispatcher& HPS::WindowKey::GetEventDispatcher | ( | ) |
Returns a control that allows the user to interact with events in various ways.
◆ GetEventDispatcher() [2/2]
EventDispatcher const& HPS::WindowKey::GetEventDispatcher | ( | ) | const |
Returns a control that allows the user to interact with events in various ways.
◆ GetHighlightControl() [1/2]
HighlightControl HPS::WindowKey::GetHighlightControl | ( | ) |
Returns a control that allows the user to highlight segments or geometry in this window.
◆ GetHighlightControl() [2/2]
HighlightControl const HPS::WindowKey::GetHighlightControl | ( | ) | const |
Returns a control that allows the user to highlight segments or geometry in this window.
◆ GetPostProcessEffectsControl() [1/2]
PostProcessEffectsControl HPS::WindowKey::GetPostProcessEffectsControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment.
◆ GetPostProcessEffectsControl() [2/2]
PostProcessEffectsControl const HPS::WindowKey::GetPostProcessEffectsControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment.
◆ GetSelectionControl() [1/2]
SelectionControl HPS::WindowKey::GetSelectionControl | ( | ) |
Returns a control that allows the user to perform selections in this window.
◆ GetSelectionControl() [2/2]
SelectionControl const HPS::WindowKey::GetSelectionControl | ( | ) | const |
Returns a control that allows the user to perform selections in this window.
◆ GetSelectionOptionsControl() [1/2]
SelectionOptionsControl HPS::WindowKey::GetSelectionOptionsControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the selection options on this window.
◆ GetSelectionOptionsControl() [2/2]
SelectionOptionsControl const HPS::WindowKey::GetSelectionOptionsControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the selection options on this window.
◆ GetUpdateOptionsControl() [1/2]
UpdateOptionsControl HPS::WindowKey::GetUpdateOptionsControl | ( | ) |
Returns a control that allows the user to change update options in this window.
◆ GetUpdateOptionsControl() [2/2]
UpdateOptionsControl const HPS::WindowKey::GetUpdateOptionsControl | ( | ) | const |
Returns a control that allows the user to change update options in this window.
◆ GetWindowInfoControl()
WindowInfoControl const HPS::WindowKey::GetWindowInfoControl | ( | ) | const |
Returns a control that allows the user to query various window properties, including size, aspect ratio, resolution, etc.
◆ ObjectType()
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::SegmentKey.
Reimplemented in HPS::OffScreenWindowKey, HPS::ApplicationWindowKey, and HPS::StandAloneWindowKey.
◆ operator=() [1/2]
Copy assignment operator for WindowKey
◆ operator=() [2/2]
◆ SetDebugging()
WindowKey& HPS::WindowKey::SetDebugging | ( | DebuggingKit const & | in_kit | ) |
Sets the debugging attributes designated by in_kit on this segment.
◆ SetDriverEventHandler()
WindowKey& HPS::WindowKey::SetDriverEventHandler | ( | DriverEventHandler const & | in_handler, |
intptr_t | in_type | ||
) |
Sets the specified driver event handler as the handler for the specified driver event type on this window.
- Parameters
-
in_handler Driver event handler to be set. in_type Type of driver event to add the handler for.
◆ SetPostProcessEffects()
WindowKey& HPS::WindowKey::SetPostProcessEffects | ( | PostProcessEffectsKit const & | in_kit | ) |
Sets the post-process effects attributes designated by in_kit on this segment.
◆ SetSelectionOptions()
WindowKey& HPS::WindowKey::SetSelectionOptions | ( | SelectionOptionsKit const & | in_kit | ) |
Sets the options that will be used by default for selections performed from this window. Note: these options cannot be unset.
◆ SetUpdateOptions()
WindowKey& HPS::WindowKey::SetUpdateOptions | ( | HPS::UpdateOptionsKit const & | in_kit | ) |
Sets the options that will be used by default for update options performed from this window. Note: these options cannot be unset.
◆ ShowDebugging()
bool HPS::WindowKey::ShowDebugging | ( | DebuggingKit & | out_kit | ) | const |
Shows the debugging attribute settings on this segment.
- Returns
- False if no debugging attribute settings exist on this segment.
◆ ShowPostProcessEffects()
bool HPS::WindowKey::ShowPostProcessEffects | ( | PostProcessEffectsKit & | out_kit | ) | const |
Shows the post-process effects attribute settings on this segment. Returns false if no post-process effects attribute settings exist on this segment.
◆ ShowSelectionOptions()
bool HPS::WindowKey::ShowSelectionOptions | ( | SelectionOptionsKit & | out_kit | ) | const |
Shows the options that will be used by default for selections performed from this window.
◆ ShowSnapshot()
bool HPS::WindowKey::ShowSnapshot | ( | ImageKit & | out_kit | ) | const |
Shows the current display as an image. Note: this will return false if an Update was never made or if the window key has framebuffer retention disabled.
- Parameters
-
out_kit An image kit to show the display into.
- Returns
- true if able to show display into ImageKit, false otherwise.
◆ ShowUpdateOptions()
bool HPS::WindowKey::ShowUpdateOptions | ( | HPS::UpdateOptionsKit & | out_kit | ) | const |
Shows the options that will be used by default for update options performed from this window.
◆ UnsetDriverEventHandler()
WindowKey& HPS::WindowKey::UnsetDriverEventHandler | ( | intptr_t | in_type | ) |
Unsets the driver event handler for the specified driver event type on this window.
- Parameters
-
in_type Type of driver event to remove the handler for
◆ Update() [1/3]
void HPS::WindowKey::Update | ( | ) |
Performs a default update in this window, redrawing and refreshing the display.
◆ Update() [2/3]
void HPS::WindowKey::Update | ( | UpdateOptionsKit const & | in_kit | ) |
Performs an update in this window, redrawing and refreshing the display using the options in the UpdateOptionsKit.
- Parameters
-
in_kit Allows the user to control how thorough an update should be.
◆ Update() [3/3]
void HPS::WindowKey::Update | ( | Window::UpdateType | in_type, |
Time | in_time_limit = -1 |
||
) |
Performs an update in this window within the specified amount of time, redrawing and refreshing the display based on the Window::UpdateType value. Key behavioral notes regarding a timed-update:
- Geometry deferral/omission
- View-dependent shadows will not be drawn (view-independent shadows will be drawn.)
- Transparent geometry will be deferred and processed after the rest of the scene.
- If static tree + lmv is enabled, text and lines will be deferred and drawn after opaque facetted geometry
- Non-incremental rendering modes/attributes
- A timed update requires Visualize to interrupt the rendering process. However, certain types of rendering modes/attributes cannot be interrupted because they are 'non-incremental'. - If your application wishes to use such modes/attributes alongside fixed-framerate, it will need to make a decision about whether Fixed-framerate is preferred. They include: - HiddenLine and FastHiddenLine rendering algorithms
- Transparency that is drawn using 'depth peeling'. (All depth-peeled transparent geometry will be processed once it is started.)
- A timed update requires Visualize to interrupt the rendering process. However, certain types of rendering modes/attributes cannot be interrupted because they are 'non-incremental'. - If your application wishes to use such modes/attributes alongside fixed-framerate, it will need to make a decision about whether Fixed-framerate is preferred. They include: - HiddenLine and FastHiddenLine rendering algorithms
- Parameters
-
in_control Allows the user to control how thorough this update should be. in_time_limit Specifies the desired maximum time this update should take.
◆ UpdateWithNotifier() [1/3]
UpdateNotifier HPS::WindowKey::UpdateWithNotifier | ( | ) |
Performs a default update in this window, redrawing and refreshing the display.
- Returns
- A UpdateNotifier object that can be used to find out information about the update.
◆ UpdateWithNotifier() [2/3]
UpdateNotifier HPS::WindowKey::UpdateWithNotifier | ( | HPS::UpdateOptionsKit const & | in_kit | ) |
Performs a default update in this window, redrawing and refreshing the display.
- Returns
- A UpdateNotifier object that can be used to find out information about the update.
◆ UpdateWithNotifier() [3/3]
UpdateNotifier HPS::WindowKey::UpdateWithNotifier | ( | Window::UpdateType | in_type, |
Time | in_time_limit = -1 |
||
) |
Performs an update in this window, redrawing and refreshing the display.
- Parameters
-
in_type Allows the user to control how thorough an update should be. in_time_limit Specifies a maximum time this update should take.
- Returns
- A UpdateNotifier object that can be used to find out information about the update.
The documentation for this class was generated from the following file:
- include/hps.h