fyrox_impl/utils/behavior/
leaf.rs

1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! Leaf is a "final" node of a behavior tree. It contains user-defined action which
22//! is able to mutate given context.
23
24use crate::{
25    core::{pool::Handle, visitor::prelude::*},
26    utils::behavior::{BehaviorNode, BehaviorTree},
27};
28use std::cell::RefCell;
29
30/// See module docs.
31#[derive(Debug, PartialEq, Visit, Eq, Clone)]
32pub struct LeafNode<B>
33where
34    B: Clone,
35{
36    /// User-defined behavior.
37    pub behavior: Option<RefCell<B>>,
38}
39
40impl<B> Default for LeafNode<B>
41where
42    B: Clone,
43{
44    fn default() -> Self {
45        Self { behavior: None }
46    }
47}
48
49impl<B> LeafNode<B>
50where
51    B: Clone + 'static,
52{
53    /// Creates new leaf node with given action.
54    pub fn new(behavior: B) -> Self {
55        Self {
56            behavior: Some(RefCell::new(behavior)),
57        }
58    }
59
60    /// Adds self to given behavior tree and returns handle to self.
61    pub fn add_to(self, tree: &mut BehaviorTree<B>) -> Handle<BehaviorNode<B>> {
62        tree.add_node(BehaviorNode::Leaf(self))
63    }
64}
fyrox_impl/utils/behavior/leaf.rs

fyrox_impl/utils/behavior/
leaf.rs
