Scene node enumeration by name scene query class. More...
#include <SQByName.h>
Inheritance diagram for PLScene::SQByName:
Public Member Functions | |
| PLS_API | SQByName () |
| Default constructor. | |
| virtual PLS_API | ~SQByName () |
| Destructor. | |
| PLS_API const PLCore::RegEx & | GetRegEx () const |
| Returns the used regular expression. | |
| PLS_API void | SetRegEx (const PLCore::RegEx &cRegEx) |
| Sets the used regular expression. | |
| virtual PLS_API bool | PerformQuery () override |
| Performs the query. | |
Detailed Description
Scene node enumeration by name scene query class.
- Remarks:
- This scene query will enumerate scene nodes of the scene graph if their name matches a given regular expression.
- Note:
- Cell portal recursion is not performed
Constructor & Destructor Documentation
| PLS_API PLScene::SQByName::SQByName | ( | ) |
Default constructor.
| virtual PLS_API PLScene::SQByName::~SQByName | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| PLS_API const PLCore::RegEx& PLScene::SQByName::GetRegEx | ( | ) | const |
Returns the used regular expression.
- Returns:
- The used regular expression
| PLS_API void PLScene::SQByName::SetRegEx | ( | const PLCore::RegEx & | cRegEx | ) |
Sets the used regular expression.
- Parameters:
-
[in] cRegEx The regular expression to use
| virtual PLS_API bool PLScene::SQByName::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:
