#include <HSelectionSetOOC.h>
template<typename SelectionSet>
class HSelectionSetOOC< SelectionSet >
The HOpSelectionSetOOC class is the class that should be used when using the HOpSelectAreaOOC and HOpSelectPolygonOOC selection operators for selecting OOC points. Only one instance of HOpSelectionSetOOC can be alive at any given time.
- Parameters
-
| SelectionSet | The underlying selection set type to use. |
◆ AddRectangleWindow()
template<typename SelectionSet>
| void HSelectionSetOOC< SelectionSet >::AddRectangleWindow |
( |
ooc::Point const & |
min, |
|
|
ooc::Point const & |
max |
|
) |
| |
|
inline |
◆ AddTriangleWindow()
template<typename SelectionSet>
| void HSelectionSetOOC< SelectionSet >::AddTriangleWindow |
( |
ooc::Point const & |
p1, |
|
|
ooc::Point const & |
p2, |
|
|
ooc::Point const & |
p3 |
|
) |
| |
|
inline |
Adds a triangular window to select points from in window space coordinates. This should only be called within an HSelectionSetOOC::SynchronizeWith callback.
- Parameters
-
| p1 | The first point of the triangle. |
| p2 | The second point of the triangle. |
| p3 | The third point of the triangle. |
◆ CanCreateInstance()
template<typename SelectionSet>
- Returns
- A boolean that denotes whether or not an HSelectionSetOOC object can be created by a call to CreateInstance.
◆ CreateInstance()
template<typename SelectionSet>
Creates a new HSelectionSetOOC instance if one does not already exist. Returns a null pointer otherwise.
- Parameters
-
| view | A reference to an HBaseView object. |
| deep_select | Controls whether or not OOC points that are not loaded in memory get selected with this selection set. (See SetDeepSelection.) |
- Returns
- A pointer to the created HSelectionSetOOC.
◆ DeleteSelection()
template<typename SelectionSet>
| virtual bool HSelectionSetOOC< SelectionSet >::DeleteSelection |
( |
bool |
emit_message = false | ) |
|
|
inlinevirtual |
Deletes all points selected by this object. This function works by doing the following:
- Obtaining an iterator to the selected OOC points.
- Iterating these points to associate each with a collection of points per ooc::NodeHandle.
- Calling ooc::delta::DeleteSpecificPoints for each ooc::NodeHandle points pairing. Notably, this function only deletes the points in memory. This change will not be saved to disk unless one calls ooc::io::CommitDeltasToFile.
- Parameters
-
| emit_message | Controls whether or not the HBaseView associated with this object is notified about the deletion. |
References HBaseView::GetModelKey(), HSelectionSetOOC< SelectionSet >::Reset(), and HSelectionSetOOC< SelectionSet >::SelectedPoints().
◆ Reset()
template<typename SelectionSet>
◆ SelectedPoints()
template<typename SelectionSet>
◆ SetDeepSelection()
template<typename SelectionSet>
Sets whether or not the selection set will select points that are not currently loaded into memory.
- Parameters
-
| deep_select | Enables deep selection if true. Disables deep selection if false. |
References HSelectionSetOOC< SelectionSet >::Reset().
◆ SynchronizeWith()
template<typename SelectionSet>
template<typename Func >
| auto HSelectionSetOOC< SelectionSet >::SynchronizeWith |
( |
Func const & |
task | ) |
-> decltype(task())
|
|
inline |
Creates a synchronization point to add rectangular or triangular windows to the selection set. (See AddRectangleWindow and AddTriangleWindow functions.)
- Parameters
-
| task | The callback to be called when the HSelectionSetOOC object is in a synchronized state. |
Referenced by HOpSelectAreaOOC< SelectionSet >::OnLButtonUp().
◆ UpdateSelection()
template<typename SelectionSet>
Updates the highlighting of the selection points. This may be needed if points are loaded into memory or points are unloaded from memory. This will not force an HBaseView::Update. That is, this function will not update the visual presentation of the model. A separate update is needed for that. This function will be automatically called in this object's Tick function, which executes periodically. The Tick function will call HBaseView::Update if this function returns true. This allows newly loaded points to be automatically highlighted without programmer interaction.
- Returns
- Returns true if any new points have been highlighted or if any points have been unhighlighted.
References HBaseView::GetIncludeLinkKey(), and HBaseView::GetViewKey().
The documentation for this class was generated from the following file:
