fyrox_impl/utils/behavior/inverter.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//! A node, that inverts its child state ([`super::Status::Failure`] becomes [`super::Status::Success`] and vice versa, [`super::Status::Running`] remains
22//! unchanged)
23
24use crate::{
25 core::{pool::Handle, visitor::prelude::*},
26 utils::behavior::{BehaviorNode, BehaviorTree},
27};
28
29/// See module docs.
30#[derive(Debug, PartialEq, Visit, Eq, Clone)]
31pub struct Inverter<B>
32where
33 B: Clone,
34{
35 /// A handle of child node, the state of which will be inverted.
36 pub child: Handle<BehaviorNode<B>>,
37}
38
39impl<B> Default for Inverter<B>
40where
41 B: Clone,
42{
43 fn default() -> Self {
44 Self {
45 child: Default::default(),
46 }
47 }
48}
49
50impl<B> Inverter<B>
51where
52 B: Clone + 'static,
53{
54 /// Creates new inverter node with given action.
55 pub fn new(child: Handle<BehaviorNode<B>>) -> Self {
56 Self { child }
57 }
58
59 /// Adds self to given behavior tree and returns handle to self.
60 pub fn add_to(self, tree: &mut BehaviorTree<B>) -> Handle<BehaviorNode<B>> {
61 tree.add_node(BehaviorNode::Inverter(self))
62 }
63}