/***************************************************************************

octreescenemanager.h  -  description

-------------------

begin                : Fri Sep 27 2002

copyright            : (C) 2002 by Jon Anderson

email                : janders@users.sf.net

***************************************************************************/

/*

-----------------------------------------------------------------------------

This source file is part of OGRE

(Object-oriented Graphics Rendering Engine)

For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2014 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

-----------------------------------------------------------------------------

*/

#ifndef OCTREESCENEMANAGER_H

#define OCTREESCENEMANAGER_H

#include "OgreOctreePrerequisites.h"

#include "OgreSceneManager.h"

#include <list>

#include <algorithm>

#include "OgreOctree.h"

namespace Ogre

{

/** \addtogroup Plugins Plugins

*  @{

*/

/** \addtogroup Octree OctreeSceneManager

* Octree datastructure for managing scene nodes.

*  @{

*/

class OctreeNode;

class OctreeCamera;

typedef std::list< WireBoundingBox * > BoxList;

typedef std::list< unsigned long > ColorList;

/** Specialized SceneManager that divides the geometry into an octree in order to facilitate spatial queries.

*/

class _OgreOctreePluginExport OctreeSceneManager : public SceneManager

{

    friend class OctreeIntersectionSceneQuery;

    friend class OctreeRaySceneQuery;

    friend class OctreeSphereSceneQuery;

    friend class OctreeAxisAlignedBoxSceneQuery;

    friend class OctreePlaneBoundedVolumeListSceneQuery;

public:

    static int intersect_call;

    /** Standard Constructor.  Initializes the octree to -10000,-10000,-10000 to 10000,10000,10000 with a depth of 8. */

    OctreeSceneManager(const String& name);

    /** Standard Constructor */

    OctreeSceneManager(const String& name, AxisAlignedBox &box, int max_depth );

    /** Standard destructor */

    ~OctreeSceneManager();

    /// @copydoc SceneManager::getTypeName

    const String& getTypeName(void) const override;

    /** Initializes the manager to the given box and depth.

    */

    void init( AxisAlignedBox &box, int d );

    /** Creates a specialized OctreeNode */

    SceneNode * createSceneNodeImpl ( void ) override;

    /** Creates a specialized OctreeNode */

    SceneNode * createSceneNodeImpl ( const String &name ) override;

    /** Creates a specialized OctreeCamera */

    Camera * createCamera( const String &name ) override;

    /** Deletes a scene node */

    void destroySceneNode( const String &name ) override;

    /** Does nothing more */

    void _updateSceneGraph( Camera * cam ) override;

    /** Recurses through the octree determining which nodes are visible. */

    void _findVisibleObjects ( Camera * cam,

        VisibleObjectsBoundsInfo* visibleBounds, bool onlyShadowCasters ) override;

    /** Walks through the octree, adding any visible objects to the render queue.

    If any octant in the octree if completely within the view frustum,

    all subchildren are automatically added with no visibility tests.

    */

    void walkOctree( OctreeCamera *, RenderQueue *, Octree *, 

        VisibleObjectsBoundsInfo* visibleBounds, bool foundvisible, 

        bool onlyShadowCasters);

    /** Checks the given OctreeNode, and determines if it needs to be moved

    * to a different octant.

    */

    void _updateOctreeNode( OctreeNode * );

    /** Removes the given octree node */

    void _removeOctreeNode( OctreeNode * );

    /** Adds the Octree Node, starting at the given octree, and recursing at max to the specified depth.

    */

    void _addOctreeNode( OctreeNode *, Octree *octree, int depth = 0 );

    /** Recurses the octree, adding any nodes intersecting with the box into the given list.

    It ignores the exclude scene node.

    */

    void findNodesIn( const AxisAlignedBox &box, std::list< SceneNode * > &list, SceneNode *exclude = 0 );

    /** Recurses the octree, adding any nodes intersecting with the sphere into the given list.

    It ignores the exclude scene node.

    */

    void findNodesIn( const Sphere &sphere, std::list< SceneNode * > &list, SceneNode *exclude = 0 );

    /** Recurses the octree, adding any nodes intersecting with the volume into the given list.

      It ignores the exclude scene node.

      */

    void findNodesIn( const PlaneBoundedVolume &volume, std::list< SceneNode * > &list, SceneNode *exclude=0 );

    /** Recurses the octree, adding any nodes intersecting with the ray into the given list.

      It ignores the exclude scene node.

      */

    void findNodesIn( const Ray &ray, std::list< SceneNode * > &list, SceneNode *exclude=0 );

    /** Sets the box visibility flag */

    void setShowBoxes( bool b )

    {

        mShowBoxes = b;

    };

    /** Resizes the octree to the given size */

    void resize( const AxisAlignedBox &box );

    /** Sets the given option for the SceneManager

        Options are:

        "Size", AxisAlignedBox *;

        "Depth", int *;

        "ShowOctree", bool *;

    */

    bool setOption( const String &, const void * ) override;

    /** Gets the given option for the Scene Manager.

        See setOption

    */

    bool getOption( const String &, void * ) override;

    bool getOptionValues( const String & key, StringVector &refValueList ) override;

    bool getOptionKeys( StringVector &refKeys ) override;

    /** Overridden from SceneManager */

    void clearScene(void) override;

    AxisAlignedBoxSceneQuery* createAABBQuery(const AxisAlignedBox& box, uint32 mask) override;

    SphereSceneQuery* createSphereQuery(const Sphere& sphere, uint32 mask) override;

    PlaneBoundedVolumeListSceneQuery* createPlaneBoundedVolumeQuery(const PlaneBoundedVolumeList& volumes, uint32 mask) override;

    RaySceneQuery* createRayQuery(const Ray& ray, uint32 mask) override;

    IntersectionSceneQuery* createIntersectionQuery(uint32 mask) override;

protected:

    Octree::NodeList mVisible;

    /// The root octree

    Octree *mOctree;

    /// List of boxes to be rendered

    BoxList mBoxes;

    /// Number of rendered objs

    int mNumObjects;

    /// Max depth for the tree

    int mMaxDepth;

    /// Size of the octree

    AxisAlignedBox mBox;

    /// Boxes visibility flag

    bool mShowBoxes;

    Real mCorners[ 24 ];

    static unsigned long mColors[ 8 ];

    static unsigned short mIndexes[ 24 ];

    Matrix4 mScaleFactor;

};

/// Factory for OctreeSceneManager

class OctreeSceneManagerFactory : public SceneManagerFactory

{

public:

    /// Factory type name

    static const String FACTORY_TYPE_NAME;

    SceneManager* createInstance(const String& instanceName) override;

    const String& getTypeName(void) const override { return FACTORY_TYPE_NAME; }

};

/** @} */

/** @} */

}

#endif