CUCompositeNode.h

//
//  CUCompositeNode.h
//  Cornell University Game Library (CUGL)
//
//  This module provides support for a composite behavior node. It is used
//  to select from one or more children, according to priority.
//
//  BehaviorNode objects are managed by BehaviorManager, and should never
//  be allocated directly.  Instead, you create a behavior node definition
//  and pass it to a factor method in BehaviorManager.
//
//  EXPERIMENTAL: This module is experimental.  The API may change significantly
//  in future CUGL releases.
//
//  CUGL MIT License:
//      This software is provided 'as-is', without any express or implied
//      warranty.  In no event will the authors be held liable for any damages
//      arising from the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose,
//      including commercial applications, and to alter it and redistribute it
//      freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; you must not
//      claim that you wrote the original software. If you use this software
//      in a product, an acknowledgment in the product documentation would be
//      appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, and must not
//      be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//  Author: Apurv Sethi and Andrew Matsumoto (with Walker White)
//  Version: 5/21/2018
//
#ifndef __CU_COMPOSITE_NODE_H__
#define __CU_COMPOSITE_NODE_H__

#include <cugl/ai/behavior/CUBehaviorNode.h>
#include <string>
#include <vector>

namespace cugl {
    namespace ai {
class CompositeNode : public BehaviorNode {
#pragma mark Values
protected:
    bool _preemptive;

#pragma mark Internal Helpers

    virtual int selectChild() const = 0;

public:
#pragma mark Constructors

    CompositeNode();

    ~CompositeNode() { dispose(); }

    virtual void dispose() override;
    
#pragma mark Attributes

    bool isPreemptive() const { return _preemptive; }
    
    void setPreemptive(bool preemptive) { _preemptive = preemptive; }

#pragma mark Tree Management

    const BehaviorNode* getChildByPriorityIndex(Uint32 index) const;

    template <typename T>
    const T* getChildByPriorityIndex(Uint32 index) const {
        return dynamic_cast<const T*>(getChildByPriorityIndex(index));
    }

    const BehaviorNode* getActiveChild() const;

    template <typename T>
    const T* getActiveChild() const {
        return dynamic_cast<const T*>(getActiveChild());
    }
    
#pragma mark Behavior Management

    virtual void query(float dt) override;
    
    BehaviorNode::State update(float dt) override;
    
};

    }
}
#endif /* __CU_COMPOSITE_NODE_H__ */