HSelectionSetOOC

template<typename SelectionSet>
class HSelectionSetOOC

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.

Inherits from: SelectionSet, private HSelectionSetHelperBaseOOC, private HTClient

Structures

Enumerations

Type Definitions

Methods

template<typename SelectionSet>
HSelectionSetOOC<SelectionSet>::HSelectionSetOOC(HBaseView &view, bool deep_select)

private

template<typename SelectionSet>
HSelectionSetOOC<SelectionSet>::~HSelectionSetOOC()

private

template<typename SelectionSet>
virtual bool HSelectionSetOOC<SelectionSet>::Tick(float request_time, float actual_time)

private virtual

Timer events are delivered here first. If this function is not overridden, the events will be delivered to whatever was set with the mt_tick_function argument of the constructor or later on with SetTickFunction().

Parameters

request_time: The time for which the timer event was originally scheduled.

actual_time: The time at which the tick was actually delivered which is greater than or equal to request_time.

Returns

True if no errors were encountered.
template<typename SelectionSet>
void HSelectionSetOOC<SelectionSet>::OnDeletedKey(HC_KEY key, int type)

private

template<typename SelectionSet>
static HSelectionSetOOC *HSelectionSetOOC<SelectionSet>::CreateInstance(HBaseView &view, bool deep_select)

static

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.
template<typename SelectionSet>
static bool HSelectionSetOOC<SelectionSet>::CanCreateInstance()

static

Returns

A boolean that denotes whether or not an HSelectionSetOOC object can be created by a call to CreateInstance.
template<typename SelectionSet>
virtual void HSelectionSetOOC<SelectionSet>::Reset()

virtual

Resets the HSelectionSetOOC object. This will deselect any points selected by this object.

template<typename SelectionSet>
virtual bool HSelectionSetOOC<SelectionSet>::DeleteSelection(bool emit_message = false)

virtual

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. emit_message Controls whether or not the HBaseView associated with this object is notified about the deletion.

Parameters

emit_message: Controls whether or not the HBaseView associated with this object is notified about the deletion.
template<typename SelectionSet>
void HSelectionSetOOC<SelectionSet>::SetDeepSelection(bool deep_select)

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.
template<typename SelectionSet>
ooc::query::QueryIterator HSelectionSetOOC<SelectionSet>::SelectedPoints()

Returns

Returns a QueryIterator to the points selected by this selection set.
template<typename SelectionSet>
bool HSelectionSetOOC<SelectionSet>::UpdateSelection()

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.
template<typename SelectionSet>
void HSelectionSetOOC<SelectionSet>::AddRectangleWindow(ooc::Point const &min, ooc::Point const &max)

Adds a rectangular window to select points from in window space coordinates. This should only be called within an HSelectionSetOOC::SynchronizeWith callback.

Parameters

min: The minimum point of the rectangle.

max: The maximum point of the rectangle.

template<typename SelectionSet>
void HSelectionSetOOC<SelectionSet>::AddTriangleWindow(ooc::Point const &p1, ooc::Point const &p2, ooc::Point const &p3)

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.

template<typename SelectionSet>
bool HSelectionSetOOC<SelectionSet>::HasWindows()
template<typename SelectionSet>
template<typename Func>
auto HSelectionSetOOC<SelectionSet>::SynchronizeWith(Func const &task) -> decltype(task())

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.
template<typename SelectionSet>
static void HSelectionSetOOC<SelectionSet>::StaticOnDeletedKey(HC_KEY key, int type)

private static

Variables

template<typename SelectionSet>
HWindowFilterOOC HSelectionSetOOC<SelectionSet>::filter

private

template<typename SelectionSet>
HMutexOOC HSelectionSetOOC<SelectionSet>::selection_mutex

private

template<typename SelectionSet>
VArray<CallbackKeyInfo> *HSelectionSetOOC<SelectionSet>::callback_key_infos

private

VArray< CallbackKeyInfo >