Line intersection scene query class. More...
#include <SQLine.h>
Inheritance diagram for PLScene::SQLine:
Public Member Functions | |
| PLS_API | SQLine () |
| Default constructor. | |
| virtual PLS_API | ~SQLine () |
| Destructor. | |
| PLS_API PLMath::Line & | GetLine () |
| Returns the used line. | |
| PLS_API PLRenderer::Cull::Enum | GetCull () const |
| Returns the used cull mode. | |
| PLS_API void | SetCull (PLRenderer::Cull::Enum nCull=PLRenderer::Cull::CCW) |
| Sets the used cull mode. | |
| virtual PLS_API bool | PerformQuery () override |
| Performs the query. | |
Detailed Description
Line intersection scene query class.
- Remarks:
- This line test scene query will enumerate all scene nodes intersecting the given line.
Constructor & Destructor Documentation
| PLS_API PLScene::SQLine::SQLine | ( | ) |
Default constructor.
| virtual PLS_API PLScene::SQLine::~SQLine | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| PLS_API PLMath::Line& PLScene::SQLine::GetLine | ( | ) |
Returns the used line.
- Returns:
- The used line
| PLS_API PLRenderer::Cull::Enum PLScene::SQLine::GetCull | ( | ) | const |
Returns the used cull mode.
- Returns:
- The used cull mode (see "PLRenderer::Cull")
- Note:
- May not always be used, e.g. usually this is useful for mesh intersection tests
| PLS_API void PLScene::SQLine::SetCull | ( | PLRenderer::Cull::Enum | nCull = PLRenderer::Cull::CCW | ) |
Sets the used cull mode.
- Parameters:
-
[in] nCull The used cull mode (see "PLRenderer::Cull")
- See also:
- "GetCull()"
| virtual PLS_API bool PLScene::SQLine::PerformQuery | ( | ) | [override, virtual] |
Performs the query.
- Note:
- Before you start the query you have to do some settings within the derived query classes first. (for instance setting the query volume)
- Returns:
- 'true' if the query was cancelled by the user, else 'false'
Implements PLScene::SceneQuery.
The documentation for this class was generated from the following file:
