VisPortal.h

Go to the documentation of this file.

/*********************************************************\
 *  File: VisPortal.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_VISIBILITY_VISPORTAL_H__
#define __PLSCENE_VISIBILITY_VISPORTAL_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLCore/Base/Event/EventHandler.h>
#include "PLScene/Visibility/VisNode.h"


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


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class SCCell;
class VisContainer;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Portal of the visibility tree
*/
class VisPortal : public VisNode {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class VisContainer;


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Returns the target visibility cell the portal links to
        *
        *  @return
        *    The target visibility cell the portal links to, a null pointer if it's not possible to
        *    'see through' the portal (SNCellPortal::NoSeeThrough flag) or on error.
        */
        PLS_API VisContainer *GetTargetVisContainer() const;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cParent
        *    The parent visibility node
        */
        VisPortal(VisNode &cParent);

        /**
        *  @brief
        *    Destructor
        */
        virtual ~VisPortal();

        /**
        *  @brief
        *    Called when the scene node assigned with this visibility portal was destroyed
        */
        void OnDestroy();


    //[-------------------------------------------------------]
    //[ Private event handlers                                ]
    //[-------------------------------------------------------]
    private:
        PLCore::EventHandler<> EventHandlerDestroy;


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        VisContainer *m_pTargetCell;    /**< The target visibility cell the portal links to */


    //[-------------------------------------------------------]
    //[ Public virtual VisNode functions                      ]
    //[-------------------------------------------------------]
    public:
        PLS_API virtual bool IsPortal() const override;


};


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


#endif // __PLSCENE_VISIBILITY_VISPORTAL_H__