visibility_notifier.h

/*************************************************************************/
/*  visibility_notifier.h                                                */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                    http://www.godotengine.org                         */
/*************************************************************************/
/* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur.                 */
/*                                                                       */
/* 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 VISIBILITY_NOTIFIER_H
#define VISIBILITY_NOTIFIER_H

#include "scene/3d/spatial.h"

class Camera;
class VisibilityNotifier : public Spatial {

    OBJ_TYPE(VisibilityNotifier,Spatial);

    Set<Camera*> cameras;

    AABB aabb;

protected:

    virtual void _screen_enter() {}
    virtual void _screen_exit() {}

    void _notification(int p_what);
    static void _bind_methods();
friend class SpatialIndexer;

    void _enter_camera(Camera* p_camera);
    void _exit_camera(Camera* p_camera);

public:

    void set_aabb(const AABB& p_aabb);
    AABB get_aabb() const;
    bool is_on_screen() const;

    VisibilityNotifier();
};


class VisibilityEnabler : public VisibilityNotifier {

    OBJ_TYPE(VisibilityEnabler,VisibilityNotifier);
public:

    enum Enabler {
        ENABLER_PAUSE_ANIMATIONS,
        ENABLER_FREEZE_BODIES,
        ENABLER_MAX
    };

protected:

    virtual void _screen_enter();
    virtual void _screen_exit();

    bool visible;

    void _find_nodes(Node* p_node);

    Map<Node*,Variant> nodes;
    void _node_removed(Node* p_node);
    bool enabler[ENABLER_MAX];

    void _change_node_state(Node* p_node,bool p_enabled);

    void _notification(int p_what);
    static void _bind_methods();

public:

    void set_enabler(Enabler p_enabler,bool p_enable);
    bool is_enabler_enabled(Enabler p_enabler) const;

    VisibilityEnabler();

};

VARIANT_ENUM_CAST(VisibilityEnabler::Enabler);


#endif // VISIBILITY_NOTIFIER_H