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::utils::behavior::BaseBehavior;
25use crate::{
26 core::{pool::Handle, visitor::prelude::*},
27 utils::behavior::{BehaviorNode, BehaviorTree},
28};
29
30/// See module docs.
31#[derive(Debug, PartialEq, Visit, Eq, Clone)]
32pub struct Inverter<B>
33where
34 B: BaseBehavior,
35{
36 /// A handle of child node, the state of which will be inverted.
37 pub child: Handle<BehaviorNode<B>>,
38}
39
40impl<B> Default for Inverter<B>
41where
42 B: BaseBehavior,
43{
44 fn default() -> Self {
45 Self {
46 child: Default::default(),
47 }
48 }
49}
50
51impl<B> Inverter<B>
52where
53 B: BaseBehavior,
54{
55 /// Creates new inverter node with given action.
56 pub fn new(child: Handle<BehaviorNode<B>>) -> Self {
57 Self { child }
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::Inverter(self))
63 }
64}