HPS::Selection Class Reference

#include <hps.h>

Public Types

enum  Algorithm : uint32_t { Algorithm::Visual, Algorithm::Analytic }
 
enum  Granularity : uint32_t { Granularity::General, Granularity::Detailed }
 
enum  Level : uint32_t { Level::Segment, Level::Entity, Level::Subentity }
 

Detailed Description

The Selection class is a concept class for selection-related enum classes.

Member Enumeration Documentation

enum HPS::Selection::Algorithm : uint32_t
strong

Enumeration of the various selection algorithms.

Enumerator
Visual 

This algorithm will post-process the SelectionResults to remove items which are obscured by other objects in the scene, and therefore only items that are visible on the screen will be selected. If aperture selection is used, the selected items are sorted based on proximity, and ties (items with equal proximity) will be further z-sorted. If area-selection is used, then proximity is ignored (everything in the area is considered) and the selection list is z-sorted.

Analytic 

This algorithm will perform analytic world space selection testing, and will not post-process the SelectionResults based on obscuration. (Therefore, items which are not currently visible may still be returned in the SelectionResults) Items will be sorted by screen-space proximity to the selection location. However, since direct hits have a proximity of zero, they are given first priority and they are sorted relative to each other based on their z-distance.

enum HPS::Selection::Granularity : uint32_t
strong

Enumeration of the various selection granularities.

Enumerator
General 

Use the most efficient selection determination for curves, edges and lines.

Detailed 

Use the most accurate selection determination for curves, edges and lines.

enum HPS::Selection::Level : uint32_t
strong

Enumeration of the various selection levels.

Enumerator
Segment 

Return the owning segment of the selected geometry entities in SelectionResults.

Entity 

Return the selected geometry entities in SelectionResults.

Subentity 

Return the selected geometry entities and the associated faces, edges and vertices for shells or meshes in SelectionResults.


The documentation for this class was generated from the following file: