SQByName.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SQByName.h                                     *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLSCENE_SCENEQUERY_BYNAME_H__
#define __PLSCENE_SCENEQUERY_BYNAME_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLCore/String/RegEx.h>
#include "PLScene/Scene/SceneQuery.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLScene {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    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
*/
class SQByName : public SceneQuery {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLS_RTTI_EXPORT, SQByName, "PLScene", PLScene::SceneQuery, "Scene node enumeration by name scene query class")
        // Constructors
        pl_constructor_0(DefaultConstructor,    "Default constructor",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Default constructor
        */
        PLS_API SQByName();

        /**
        *  @brief
        *    Destructor
        */
        PLS_API virtual ~SQByName();

        /**
        *  @brief
        *    Returns the used regular expression
        *
        *  @return
        *    The used regular expression
        */
        PLS_API const PLCore::RegEx &GetRegEx() const;

        /**
        *  @brief
        *    Sets the used regular expression
        *
        *  @param[in] cRegEx
        *    The regular expression to use
        */
        PLS_API void SetRegEx(const PLCore::RegEx &cRegEx);


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Recursive part of PerformQuery()
        *
        *  @param[in] cContainer
        *    Current scene container we work on
        *
        *  @return
        *    'true' to continue the query, 'false' if stop it right now
        */
        bool PerformQueryRec(const SceneContainer &cContainer);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        PLCore::RegEx m_cRegEx; /**< Regular expression used for the query */


    //[-------------------------------------------------------]
    //[ Public virtual SceneQuery functions                   ]
    //[-------------------------------------------------------]
    public:
        PLS_API virtual bool PerformQuery() override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLScene


#endif // __PLSCENE_SCENEQUERY_BYNAME_H__