fyrox_impl/scene/

base.rs

// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
//
// 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.

//! Contains all structures and methods to create and manage base scene graph nodes.
//!
//! For more info see [`Base`]

use super::collider::BitMask;
use crate::{
    core::{
        algebra::{Matrix4, Vector3},
        log::Log,
        math::{aabb::AxisAlignedBoundingBox, Matrix4Ext},
        pool::{ErasedHandle, Handle},
        reflect::prelude::*,
        type_traits::prelude::*,
        variable::InheritableVariable,
        visitor::{Visit, VisitResult, Visitor},
        ImmutableString,
    },
    engine::SerializationContext,
    graph::SceneGraph,
    resource::model::ModelResource,
    scene::{node::Node, transform::Transform},
    script::{Script, ScriptTrait},
};
use fyrox_core::algebra::UnitQuaternion;
use fyrox_core::pool::ObjectOrVariant;
use fyrox_core::visitor::error::VisitError;
use serde::{Deserialize, Serialize};
use std::{
    any::Any,
    cell::Cell,
    ops::{Deref, DerefMut},
    sync::mpsc::Sender,
};
use strum_macros::{AsRefStr, EnumString, VariantNames};

/// Level of detail is a collection of objects for given normalized distance range.
/// Objects will be rendered **only** if they're in specified range.
/// Normalized distance is a distance in (0; 1) range where 0 - closest to camera,
/// 1 - farthest. Real distance can be obtained by multiplying normalized distance
/// with z_far of current projection matrix.
#[derive(Debug, Default, Clone, Visit, Reflect, PartialEq, TypeUuidProvider)]
#[type_uuid(id = "576b31a2-2b39-4c79-95dd-26aeaf381d8b")]
pub struct LevelOfDetail {
    /// Beginning of the range in which the level will be visible. It is expressed in normalized
    /// coordinates: where 0.0 - closest to camera, 1.0 - farthest from camera.
    begin: f32,
    /// End of the range in which the level will be visible. It is expressed in normalized coordinates:
    /// where 0.0 - closest to camera, 1.0 - farthest from camera.
    end: f32,
    /// List of objects, where each object represents level of detail of parent's LOD group.
    pub objects: Vec<Handle<Node>>,
}

impl LevelOfDetail {
    /// Creates new level of detail.
    pub fn new(begin: f32, end: f32, objects: Vec<Handle<Node>>) -> Self {
        for object in objects.iter() {
            // Invalid handles are not allowed.
            assert!(object.is_some());
        }
        let begin = begin.min(end);
        let end = end.max(begin);
        Self {
            begin: begin.clamp(0.0, 1.0),
            end: end.clamp(0.0, 1.0),
            objects,
        }
    }

    /// Sets new starting point in distance range. Input value will be clamped in
    /// (0; 1) range.
    pub fn set_begin(&mut self, percent: f32) {
        self.begin = percent.clamp(0.0, 1.0);
        if self.begin > self.end {
            std::mem::swap(&mut self.begin, &mut self.end);
        }
    }

    /// Returns starting point of the range.
    pub fn begin(&self) -> f32 {
        self.begin
    }

    /// Sets new end point in distance range. Input value will be clamped in
    /// (0; 1) range.
    pub fn set_end(&mut self, percent: f32) {
        self.end = percent.clamp(0.0, 1.0);
        if self.end < self.begin {
            std::mem::swap(&mut self.begin, &mut self.end);
        }
    }

    /// Returns end point of the range.
    pub fn end(&self) -> f32 {
        self.end
    }
}

/// LOD (Level-Of-Detail) group is a set of cascades (levels), where each cascade takes specific
/// distance range. Each cascade contains list of objects that should or shouldn't be rendered
/// if distance satisfy cascade range. LOD may significantly improve performance if your scene
/// contains lots of high poly objects and objects may be far away from camera. Distant objects
/// in this case will be rendered with lower details freeing precious GPU resources for other
/// useful tasks.
///
/// Lod group must contain non-overlapping cascades, each cascade with its own set of objects
/// that belongs to level of detail. Engine does not care if you create overlapping cascades,
/// it is your responsibility to create non-overlapping cascades.
#[derive(Debug, Default, Clone, Visit, Reflect, PartialEq, TypeUuidProvider)]
#[type_uuid(id = "8e7b18b1-c1e0-47d7-b952-4394c1d049e5")]
pub struct LodGroup {
    /// Set of cascades.
    pub levels: Vec<LevelOfDetail>,
}

/// A property value.
#[derive(
    Debug, Visit, Reflect, PartialEq, Clone, AsRefStr, EnumString, VariantNames, TypeUuidProvider,
)]
#[type_uuid(id = "cce94b60-a57e-48ba-b6f4-e5e84788f7f8")]
pub enum PropertyValue {
    /// A node handle.
    ///
    /// # Important notes
    ///
    /// The value of the property will be remapped when owning node is cloned, this means that the
    /// handle will always be correct.
    NodeHandle(Handle<Node>),
    /// An arbitrary, type-erased handle.
    ///
    /// # Important notes
    ///
    /// The value of the property will **not** be remapped when owning node is cloned, this means
    /// that the handle correctness is not guaranteed on copy.
    Handle(ErasedHandle),
    /// A string value.
    String(String),
    /// A 64-bit signed integer value.
    I64(i64),
    /// A 64-bit unsigned integer value.
    U64(u64),
    /// A 32-bit signed integer value.
    I32(i32),
    /// A 32-bit unsigned integer value.
    U32(u32),
    /// A 16-bit signed integer value.
    I16(i16),
    /// A 16-bit unsigned integer value.
    U16(u16),
    /// A 8-bit signed integer value.
    I8(i8),
    /// A 8-bit unsigned integer value.
    U8(u8),
    /// A 32-bit floating point value.
    F32(f32),
    /// A 64-bit floating point value.
    F64(f64),
}

impl Default for PropertyValue {
    fn default() -> Self {
        Self::I8(0)
    }
}

/// A custom property.
#[derive(Debug, Visit, Reflect, Default, Clone, PartialEq, TypeUuidProvider)]
#[type_uuid(id = "fc87fd21-a5e6-40d5-a79d-19f96b25d6c9")]
pub struct Property {
    /// Name of the property.
    pub name: String,
    /// A value of the property.
    pub value: PropertyValue,
}

/// A script message from scene node. It is used for deferred initialization/deinitialization.
pub enum NodeScriptMessage {
    /// A script was set to a node and needs to be initialized.
    InitializeScript {
        /// Node handle.
        handle: Handle<Node>,
        /// Index of the script.
        script_index: usize,
    },
    /// A node script must be destroyed. It can happen if the script was replaced with some other
    /// or a node was destroyed.
    DestroyScript {
        /// Script instance.
        script: Script,
        /// Node handle.
        handle: Handle<Node>,
        /// Index of the script.
        script_index: usize,
    },
}

/// Unique id of a node, that could be used as a reliable "index" of the node. This id is mostly
/// useful for network games.
#[derive(
    Clone,
    Copy,
    Eq,
    Hash,
    Ord,
    PartialEq,
    PartialOrd,
    Default,
    Debug,
    Reflect,
    Serialize,
    Deserialize,
)]
#[repr(transparent)]
pub struct SceneNodeId(pub Uuid);

impl Visit for SceneNodeId {
    fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult {
        self.0.visit(name, visitor)
    }
}

/// A script container record.
#[derive(Clone, Reflect, Debug, Default, TypeUuidProvider)]
#[type_uuid(id = "51bc577b-5a50-4a97-9b31-eda2f3d46c9d")]
pub struct ScriptRecord {
    // Script is wrapped into `Option` to be able to do take-return trick to bypass borrow checker
    // issues.
    pub(crate) script: Option<Script>,
    #[reflect(hidden)]
    pub(crate) should_be_deleted: bool,
}

impl ScriptRecord {
    pub(crate) fn new(script: Script) -> Self {
        Self {
            script: Some(script),
            should_be_deleted: false,
        }
    }
}

impl Deref for ScriptRecord {
    type Target = Option<Script>;

    fn deref(&self) -> &Self::Target {
        &self.script
    }
}

impl DerefMut for ScriptRecord {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.script
    }
}

impl Visit for ScriptRecord {
    fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult {
        visit_opt_script(name, &mut self.script, visitor)
    }
}

#[allow(clippy::enum_variant_names)] // STFU
#[derive(PartialEq, Eq, Hash, Copy, Clone, Debug)]
pub(crate) enum NodeMessageKind {
    TransformChanged,
    VisibilityChanged,
    EnabledFlagChanged,
}

#[derive(PartialEq, Eq, Hash, Copy, Clone, Debug)]
pub(crate) struct NodeMessage {
    pub node: Handle<Node>,
    pub kind: NodeMessageKind,
}

impl NodeMessage {
    pub fn new(node: Handle<Node>, kind: NodeMessageKind) -> Self {
        Self { node, kind }
    }
}

#[derive(Clone, Debug)]
struct TrackedProperty<T> {
    property: T,
    node_message_kind: NodeMessageKind,
    node_handle: Handle<Node>,
    sender: Option<Sender<NodeMessage>>,
}

impl<T> TrackedProperty<T> {
    fn unbound(property: T, kind: NodeMessageKind) -> Self {
        Self {
            property,
            node_message_kind: kind,
            node_handle: Default::default(),
            sender: None,
        }
    }

    fn set_message_data(&mut self, sender: Sender<NodeMessage>, node_handle: Handle<Node>) {
        self.sender = Some(sender);
        self.node_handle = node_handle;
    }
}

impl<T: Visit> Visit for TrackedProperty<T> {
    fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult {
        self.property.visit(name, visitor)
    }
}

impl<T> Deref for TrackedProperty<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.property
    }
}

impl<T> DerefMut for TrackedProperty<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        if let Some(sender) = self.sender.as_ref() {
            Log::verify(sender.send(NodeMessage {
                node: self.node_handle,
                kind: self.node_message_kind,
            }))
        }
        &mut self.property
    }
}

/// Base scene graph node is a simplest possible node, it is used to build more complex ones using composition.
/// It contains all fundamental properties for each scene graph nodes, like local and global transforms, name,
/// lifetime, etc. Base node is a building block for all complex node hierarchies - it contains list of children
/// and handle to parent node.
///
/// # Example
///
/// ```
/// # use fyrox_impl::scene::base::BaseBuilder;
/// # use fyrox_impl::scene::graph::Graph;
/// # use fyrox_impl::scene::node::Node;
/// # use fyrox_impl::core::pool::Handle;
/// # use fyrox_impl::scene::pivot::{Pivot, PivotBuilder};
///
/// fn create_pivot_node(graph: &mut Graph) -> Handle<Pivot> {
///     PivotBuilder::new(BaseBuilder::new()
///         .with_name("BaseNode"))
///         .build(graph)
/// }
/// ```
#[derive(Debug, Reflect, Clone)]
pub struct Base {
    #[reflect(hidden)]
    self_handle: Handle<Node>,

    #[reflect(hidden)]
    script_message_sender: Option<Sender<NodeScriptMessage>>,

    #[reflect(hidden)]
    message_sender: Option<Sender<NodeMessage>>,

    // Name is not inheritable, because property inheritance works bad with external 3D models.
    // They use names to search "original" nodes.
    #[reflect(setter = "set_name_internal")]
    pub(crate) name: ImmutableString,

    #[reflect(deref)]
    local_transform: TrackedProperty<Transform>,

    #[reflect(deref)]
    visibility: TrackedProperty<InheritableVariable<bool>>,

    #[reflect(deref)]
    enabled: TrackedProperty<InheritableVariable<bool>>,

    /// Control whether this node should be rendered. A node should be rendered only if its render mask shares
    /// some set bits in common with the render mask of the camera.
    pub render_mask: InheritableVariable<BitMask>,

    /// Maximum amount of Some(time) that node will \"live\" or None if the node has unlimited lifetime.
    pub(crate) lifetime: InheritableVariable<Option<f32>>,

    #[reflect(setter = "set_lod_group")]
    lod_group: InheritableVariable<Option<LodGroup>>,

    #[reflect(setter = "set_tag")]
    tag: InheritableVariable<String>,

    #[reflect(setter = "set_cast_shadows")]
    cast_shadows: InheritableVariable<bool>,

    /// A set of custom properties that can hold almost any data. It can be used to set additional
    /// properties to scene nodes.
    #[reflect(setter = "set_properties")]
    pub properties: InheritableVariable<Vec<Property>>,

    #[reflect(setter = "set_frustum_culling")]
    frustum_culling: InheritableVariable<bool>,

    /// When `true` it means that this node is instance of `resource`.
    /// More precisely - this node is root of whole descendant nodes
    /// hierarchy which was instantiated from resource.
    #[reflect(read_only)]
    pub(crate) is_resource_instance_root: bool,

    #[reflect(read_only)]
    pub(crate) global_visibility: Cell<bool>,

    #[reflect(hidden)]
    pub(crate) parent: Handle<Node>,

    #[reflect(hidden)]
    pub(crate) children: Vec<Handle<Node>>,

    #[reflect(read_only)]
    pub(crate) global_transform: Cell<Matrix4<f32>>,

    // Bone-specific matrix. Non-serializable.
    #[reflect(hidden)]
    pub(crate) inv_bind_pose_transform: Matrix4<f32>,

    // A resource from which this node was instantiated from, can work in pair
    // with `original` handle to get corresponding node from resource.
    #[reflect(read_only)]
    pub(crate) resource: Option<ModelResource>,

    // Handle to node in scene of model resource from which this node
    // was instantiated from.
    #[reflect(read_only)]
    #[reflect(hidden)]
    pub(crate) original_handle_in_resource: Handle<Node>,

    /// Unique id of a node, that could be used as a reliable "index" of the node. This id is mostly
    /// useful for network games. Keep in mind, that this id **will** be randomized in case if you're
    /// instantiating a prefab. In other words, all instances of a prefab will have unique instance
    /// id.
    pub(crate) instance_id: SceneNodeId,

    // Scripts of the scene node.
    //
    // # Important notes
    //
    // WARNING: Setting a new script via reflection will break normal script destruction process!
    // Use it at your own risk only when you're completely sure what you are doing.
    pub(crate) scripts: Vec<ScriptRecord>,

    #[reflect(read_only)]
    pub(crate) global_enabled: Cell<bool>,
}

impl Drop for Base {
    fn drop(&mut self) {
        self.remove_all_scripts();
    }
}

impl Base {
    /// Returns handle of the node. A node has valid handle only after it was inserted in a graph!
    #[inline]
    pub fn handle(&self) -> Handle<Node> {
        self.self_handle
    }

    /// Sets name of node. Can be useful to mark a node to be able to find it later on.
    #[inline]
    pub fn set_name<N: AsRef<str>>(&mut self, name: N) {
        self.set_name_internal(ImmutableString::new(name));
    }

    fn set_name_internal(&mut self, name: ImmutableString) -> ImmutableString {
        std::mem::replace(&mut self.name, name)
    }

    /// Returns name of node.
    #[inline]
    pub fn name(&self) -> &str {
        self.name.as_str()
    }

    /// Returns owned name of node.
    #[inline]
    pub fn name_owned(&self) -> String {
        self.name.to_mutable()
    }

    pub(crate) fn on_connected_to_graph(
        &mut self,
        self_handle: Handle<Node>,
        message_sender: Sender<NodeMessage>,
        script_message_sender: Sender<NodeScriptMessage>,
    ) {
        self.self_handle = self_handle;
        self.message_sender = Some(message_sender.clone());
        self.script_message_sender = Some(script_message_sender);
        self.local_transform
            .set_message_data(message_sender.clone(), self_handle);
        self.visibility
            .set_message_data(message_sender.clone(), self_handle);
        self.enabled.set_message_data(message_sender, self_handle);
        // Kick off initial hierarchical property propagation.
        self.notify(self.self_handle, NodeMessageKind::TransformChanged);
        self.notify(self.self_handle, NodeMessageKind::VisibilityChanged);
        self.notify(self.self_handle, NodeMessageKind::EnabledFlagChanged);
    }

    fn notify(&self, node: Handle<Node>, kind: NodeMessageKind) {
        let Some(sender) = self.message_sender.as_ref() else {
            return;
        };
        Log::verify(sender.send(NodeMessage::new(node, kind)));
    }

    /// Returns shared reference to local transform of a node, can be used to fetch
    /// some local spatial properties, such as position, rotation, scale, etc.
    #[inline]
    pub fn local_transform(&self) -> &Transform {
        &self.local_transform
    }

    /// Returns mutable reference to local transform of a node, can be used to set some local spatial
    /// properties, such as position, rotation, scale, etc. To set global position and rotation, use
    /// [`super::Graph::set_global_position`] and [`super::Graph::set_global_rotation`] methods respectively.
    #[inline]
    pub fn local_transform_mut(&mut self) -> &mut Transform {
        &mut self.local_transform
    }

    /// Sets new local transform of a node. If you need to modify existing local transformation,
    /// use [`Self::local_transform_mut`].
    #[inline]
    pub fn set_local_transform(&mut self, transform: Transform) {
        self.local_transform.property = transform;
        self.notify(self.self_handle, NodeMessageKind::TransformChanged);
    }

    /// Sets the new position of the node in the parent's node coordinate system.
    #[inline]
    pub fn set_position(&mut self, position: Vector3<f32>) {
        self.local_transform_mut().set_position(position);
    }

    /// Sets the new position of the node in the parent's node coordinate system.
    #[inline]
    pub fn set_position_xyz(&mut self, x: f32, y: f32, z: f32) {
        self.set_position(Vector3::new(x, y, z))
    }

    /// Sets the new rotation of the node in the parent's node coordinate system.
    #[inline]
    pub fn set_rotation(&mut self, rotation: UnitQuaternion<f32>) {
        self.local_transform_mut().set_rotation(rotation);
    }

    /// Sets the new rotation of the node in the parent's node coordinate system.
    #[inline]
    pub fn set_rotation_angles(&mut self, roll: f32, pitch: f32, yaw: f32) {
        self.set_rotation(UnitQuaternion::from_euler_angles(roll, pitch, yaw))
    }

    /// Sets the new rotation of the node around X axis in the parent's node coordinate system.
    #[inline]
    pub fn set_rotation_x(&mut self, angle: f32) {
        self.set_rotation(UnitQuaternion::from_axis_angle(&Vector3::x_axis(), angle))
    }

    /// Sets the new rotation of the node around Y axis in the parent's node coordinate system.
    #[inline]
    pub fn set_rotation_y(&mut self, angle: f32) {
        self.set_rotation(UnitQuaternion::from_axis_angle(&Vector3::y_axis(), angle))
    }

    /// Sets the new rotation of the node around Z axis in the parent's node coordinate system.
    #[inline]
    pub fn set_rotation_z(&mut self, angle: f32) {
        self.set_rotation(UnitQuaternion::from_axis_angle(&Vector3::z_axis(), angle))
    }

    /// Sets the new scale of the node in the parent's node coordinate system.
    #[inline]
    pub fn set_scale(&mut self, scale: Vector3<f32>) {
        self.local_transform_mut().set_scale(scale);
    }

    /// Sets the new scale of the node in the parent's node coordinate system.
    #[inline]
    pub fn set_scale_xyz(&mut self, x: f32, y: f32, z: f32) {
        self.set_scale(Vector3::new(x, y, z));
    }

    /// Sets the new scale of the node for all axes at once in the parent's node coordinate system.
    #[inline]
    pub fn set_uniform_scale(&mut self, scale: f32) {
        self.set_scale(Vector3::repeat(scale))
    }

    /// Tries to find properties by the name. The method returns an iterator because it possible
    /// to have multiple properties with the same name.
    #[inline]
    pub fn find_properties_ref<'a>(&'a self, name: &'a str) -> impl Iterator<Item = &'a Property> {
        self.properties.iter().filter(move |p| p.name == name)
    }

    /// Tries to find a first property with the given name.
    #[inline]
    pub fn find_first_property_ref(&self, name: &str) -> Option<&Property> {
        self.properties.iter().find(|p| p.name == name)
    }

    /// Sets a new set of properties of the node.
    #[inline]
    pub fn set_properties(&mut self, properties: Vec<Property>) -> Vec<Property> {
        std::mem::replace(
            self.properties.get_value_mut_and_mark_modified(),
            properties,
        )
    }

    /// Sets lifetime of node in seconds, lifetime is useful for temporary objects.
    /// Example - you firing a gun, it produces two particle systems for each shot:
    /// one for gunpowder fumes and one when bullet hits some surface. These particle
    /// systems won't last very long - usually they will disappear in 1-2 seconds
    /// but nodes will still be in scene consuming precious CPU clocks. This is where
    /// lifetimes become handy - you just set appropriate lifetime for a particle
    /// system node and it will be removed from scene when time will end. This is
    /// efficient algorithm because scene holds every object in pool and allocation
    /// or deallocation of node takes very little amount of time.
    #[inline]
    pub fn set_lifetime(&mut self, time_seconds: Option<f32>) -> &mut Self {
        self.lifetime.set_value_and_mark_modified(time_seconds);
        self
    }

    /// Returns current lifetime of a node. Will be None if node has undefined lifetime.
    /// For more info about lifetimes see [`set_lifetime`](Self::set_lifetime).
    #[inline]
    pub fn lifetime(&self) -> Option<f32> {
        *self.lifetime
    }

    /// Returns handle of parent node.
    #[inline]
    pub fn parent(&self) -> Handle<Node> {
        self.parent
    }

    /// Returns slice of handles to children nodes. This can be used, for example, to
    /// traverse tree starting from some node.
    #[inline]
    pub fn children(&self) -> &[Handle<Node>] {
        self.children.as_slice()
    }

    /// Returns global transform matrix, such matrix contains combined transformation
    /// of transforms of parent nodes. This is the final matrix that describes real
    /// location of object in the world.
    #[inline]
    pub fn global_transform(&self) -> Matrix4<f32> {
        self.global_transform.get()
    }

    /// Calculates global transform of the node, but discards scaling part of it.
    #[inline]
    pub fn global_transform_without_scaling(&self) -> Matrix4<f32> {
        const EPSILON: f32 = 10.0 * f32::EPSILON;
        let basis = self.global_transform().basis();
        let rotation = UnitQuaternion::from_matrix_eps(&basis, EPSILON, 16, Default::default());
        Matrix4::new_translation(&self.global_position()) * rotation.to_homogeneous()
    }

    /// Returns inverse of bind pose matrix. Bind pose matrix - is special matrix
    /// for bone nodes, it stores initial transform of bone node at the moment
    /// of "binding" vertices to bones.
    #[inline]
    pub fn inv_bind_pose_transform(&self) -> Matrix4<f32> {
        self.inv_bind_pose_transform
    }

    /// Returns true if this node is model resource instance root node.
    #[inline]
    pub fn is_resource_instance_root(&self) -> bool {
        self.is_resource_instance_root
    }

    /// Returns resource from which this node was instantiated from.
    #[inline]
    pub fn resource(&self) -> Option<ModelResource> {
        self.resource.clone()
    }

    /// Sets local visibility of a node.
    #[inline]
    pub fn set_visibility(&mut self, visibility: bool) -> bool {
        self.visibility.set_value_and_mark_modified(visibility)
    }

    /// Returns local visibility of a node.
    #[inline]
    pub fn visibility(&self) -> bool {
        *self.visibility.property
    }

    /// Returns current **local-space** bounding box. Keep in mind that this value is just
    /// a placeholder, because there is not information to calculate actual bounding box.
    #[inline]
    pub fn local_bounding_box(&self) -> AxisAlignedBoundingBox {
        AxisAlignedBoundingBox::unit()
    }

    /// Returns current **world-space** bounding box.
    #[inline]
    pub fn world_bounding_box(&self) -> AxisAlignedBoundingBox {
        self.local_bounding_box()
            .transform(&self.global_transform())
    }

    /// Returns combined visibility of an node. This is the final visibility of a node. Global visibility calculated
    /// using visibility of all parent nodes until root one, so if some parent node upper on tree is invisible then
    /// all its children will be invisible. It defines if object will be rendered. It is *not* the same as real
    /// visibility from point of view of a camera. Use frustum-box intersection test instead.
    #[inline]
    pub fn global_visibility(&self) -> bool {
        self.global_visibility.get()
    }

    /// Handle to node in scene of model resource from which this node was instantiated from.
    ///
    /// # Notes
    ///
    /// This handle is extensively used to fetch information about the state of node in the resource
    /// to sync properties of instance with its original in the resource.
    #[inline]
    pub fn original_handle_in_resource(&self) -> Handle<Node> {
        self.original_handle_in_resource
    }

    /// Returns `true` if the node has a parent object in a resource from which it may restore
    /// values of its inheritable properties.
    #[inline]
    pub fn has_inheritance_parent(&self) -> bool {
        self.original_handle_in_resource.is_some() && self.resource.is_some()
    }

    /// Returns position of the node in absolute coordinates.
    #[inline]
    pub fn global_position(&self) -> Vector3<f32> {
        self.global_transform.get().position()
    }

    /// Returns "look" vector of global transform basis, in most cases return vector will be non-normalized.
    #[inline]
    pub fn look_vector(&self) -> Vector3<f32> {
        self.global_transform.get().look()
    }

    /// Returns "side" vector of global transform basis, in most cases return vector will be non-normalized.
    #[inline]
    pub fn side_vector(&self) -> Vector3<f32> {
        self.global_transform.get().side()
    }

    /// Returns "up" vector of global transform basis, in most cases return vector will be non-normalized.
    #[inline]
    pub fn up_vector(&self) -> Vector3<f32> {
        self.global_transform.get().up()
    }

    /// Sets new lod group.
    #[inline]
    pub fn set_lod_group(&mut self, lod_group: Option<LodGroup>) -> Option<LodGroup> {
        std::mem::replace(self.lod_group.get_value_mut_and_mark_modified(), lod_group)
    }

    /// Extracts lod group, leaving None in the node.
    #[inline]
    pub fn take_lod_group(&mut self) -> Option<LodGroup> {
        std::mem::take(self.lod_group.get_value_mut_and_mark_modified())
    }

    /// Returns shared reference to current lod group.
    #[inline]
    pub fn lod_group(&self) -> Option<&LodGroup> {
        self.lod_group.as_ref()
    }

    /// Returns mutable reference to current lod group.
    #[inline]
    pub fn lod_group_mut(&mut self) -> Option<&mut LodGroup> {
        self.lod_group.get_value_mut_and_mark_modified().as_mut()
    }

    /// Returns node tag.
    #[inline]
    pub fn tag(&self) -> &str {
        &self.tag
    }

    /// Returns a copy of node tag.
    #[inline]
    pub fn tag_owned(&self) -> String {
        (*self.tag).clone()
    }

    /// Sets new tag.
    #[inline]
    pub fn set_tag(&mut self, tag: String) -> String {
        self.tag.set_value_and_mark_modified(tag)
    }

    /// Return the frustum_culling flag
    #[inline]
    pub fn frustum_culling(&self) -> bool {
        *self.frustum_culling
    }

    /// Sets whether to use frustum culling or not
    #[inline]
    pub fn set_frustum_culling(&mut self, frustum_culling: bool) -> bool {
        self.frustum_culling
            .set_value_and_mark_modified(frustum_culling)
    }

    /// Returns true if the node should cast shadows, false - otherwise.
    #[inline]
    pub fn cast_shadows(&self) -> bool {
        *self.cast_shadows
    }

    /// Sets whether the mesh should cast shadows or not.
    #[inline]
    pub fn set_cast_shadows(&mut self, cast_shadows: bool) -> bool {
        self.cast_shadows.set_value_and_mark_modified(cast_shadows)
    }

    /// Returns current instance id.
    pub fn instance_id(&self) -> SceneNodeId {
        self.instance_id
    }

    /// Removes a script with the given `index` from the scene node. The script will be destroyed
    /// in either the current update tick (if it was removed from some other script) or in the next
    /// update tick of the parent graph.
    pub fn remove_script(&mut self, index: usize) {
        // Send script to the graph to destroy script instances correctly.
        if let Some(entry) = self.scripts.get_mut(index) {
            entry.should_be_deleted = true;

            // We might be in a middle of a script method execution, where script is temporarily
            // extracted from the array.
            if let Some(script) = entry.take() {
                if let Some(sender) = self.script_message_sender.as_ref() {
                    Log::verify(sender.send(NodeScriptMessage::DestroyScript {
                        script,
                        handle: self.self_handle,
                        script_index: index,
                    }));
                } else {
                    Log::warn(format!(
                        "There is a script instance on a node {}, but no message sender. \
                    The script won't be correctly destroyed!",
                        self.name(),
                    ));
                }
            }
        }
    }

    /// Removes all assigned scripts from the scene node. The scripts will be removed from
    /// first-to-last order an their actual destruction will happen either on the current update tick
    /// of the parent graph (if it was removed from some other script) or in the next update tick.
    pub fn remove_all_scripts(&mut self) {
        let script_count = self.scripts.len();
        for i in 0..script_count {
            self.remove_script(i);
        }
    }

    /// Sets a new script for the scene node by index. Previous script will be removed (see
    /// [`Self::remove_script`] docs for more info).
    #[inline]
    pub fn replace_script(&mut self, index: usize, script: Option<Script>) {
        self.remove_script(index);

        if let Some(entry) = self.scripts.get_mut(index) {
            entry.script = script;
            if let Some(sender) = self.script_message_sender.as_ref() {
                if entry.script.is_some() {
                    Log::verify(sender.send(NodeScriptMessage::InitializeScript {
                        handle: self.self_handle,
                        script_index: index,
                    }));
                }
            }
        }
    }

    /// Adds a new script to the scene node. The new script will be initialized either in the current
    /// update tick (if the script was added in one of the [`ScriptTrait`] methods) or on the next
    /// update tick.
    #[inline]
    pub fn add_script<T>(&mut self, script: T)
    where
        T: ScriptTrait,
    {
        let script_index = self.scripts.len();
        self.scripts.push(ScriptRecord::new(Script::new(script)));
        if let Some(sender) = self.script_message_sender.as_ref() {
            Log::verify(sender.send(NodeScriptMessage::InitializeScript {
                handle: self.self_handle,
                script_index,
            }));
        }
    }

    /// Checks if the node has a script of a particular type. Returns `false` if there is no such
    /// script.
    #[inline]
    pub fn has_script<T>(&self) -> bool
    where
        T: ScriptTrait,
    {
        self.try_get_script::<T>().is_some()
    }

    /// Checks if the node has any scripts assigned.
    #[inline]
    pub fn has_scripts_assigned(&self) -> bool {
        self.scripts.iter().any(|script| script.is_some())
    }

    /// Tries to find a **first** script of the given type `T`, returns `None` if there's no such
    /// script.
    #[inline]
    pub fn try_get_script<T>(&self) -> Option<&T>
    where
        T: ScriptTrait,
    {
        self.scripts
            .iter()
            .find_map(|s| s.as_ref().and_then(|s| s.cast::<T>()))
    }

    /// Returns an iterator that yields references to the scripts of the given type `T`.
    #[inline]
    pub fn try_get_scripts<T>(&self) -> impl Iterator<Item = &T>
    where
        T: ScriptTrait,
    {
        self.scripts
            .iter()
            .filter_map(|e| e.script.as_ref().and_then(|s| s.cast::<T>()))
    }

    /// Tries to find a **first** script of the given type `T`, returns `None` if there's no such
    /// script.
    #[inline]
    pub fn try_get_script_mut<T>(&mut self) -> Option<&mut T>
    where
        T: ScriptTrait,
    {
        self.scripts
            .iter_mut()
            .find_map(|s| s.as_mut().and_then(|s| s.cast_mut::<T>()))
    }

    /// Returns an iterator that yields references to the scripts of the given type `T`.
    #[inline]
    pub fn try_get_scripts_mut<T>(&mut self) -> impl Iterator<Item = &mut T>
    where
        T: ScriptTrait,
    {
        self.scripts
            .iter_mut()
            .filter_map(|e| e.script.as_mut().and_then(|s| s.cast_mut::<T>()))
    }

    /// Tries find a component of the given type `C` across **all** available scripts of the node.
    /// If you want to search a component `C` in a particular script, then use [`Self::try_get_script`]
    /// and then search for component in it.
    #[inline]
    pub fn try_get_script_component<C>(&self) -> Option<&C>
    where
        C: Any,
    {
        self.scripts
            .iter()
            .find_map(|s| s.as_ref().and_then(|s| s.query_component_ref::<C>()))
    }

    /// Tries find a component of the given type `C` across **all** available scripts of the node.
    /// If you want to search a component `C` in a particular script, then use [`Self::try_get_script`]
    /// and then search for component in it.
    #[inline]
    pub fn try_get_script_component_mut<C>(&mut self) -> Option<&mut C>
    where
        C: Any,
    {
        self.scripts
            .iter_mut()
            .find_map(|s| s.as_mut().and_then(|s| s.query_component_mut::<C>()))
    }

    /// Returns total count of scripts assigned to the node.
    #[inline]
    pub fn script_count(&self) -> usize {
        self.scripts.len()
    }

    /// Returns a shared reference to a script instance with the given `index`. This method will
    /// return [`None`] if the `index` is out of bounds or the script is temporarily not available.
    /// This could happen if this method was called from some method of a [`ScriptTrait`]. It
    /// happens because of borrowing rules - you cannot take another reference to a script that is
    /// already mutably borrowed.
    #[inline]
    pub fn script(&self, index: usize) -> Option<&Script> {
        self.scripts.get(index).and_then(|s| s.as_ref())
    }

    /// Returns an iterator that yields all assigned scripts.
    #[inline]
    pub fn scripts(&self) -> impl Iterator<Item = &Script> {
        self.scripts.iter().filter_map(|s| s.as_ref())
    }

    /// Returns a mutable reference to a script instance with the given `index`. This method will
    /// return [`None`] if the `index` is out of bounds or the script is temporarily not available.
    /// This could happen if this method was called from some method of a [`ScriptTrait`]. It
    /// happens because of borrowing rules - you cannot take another reference to a script that is
    /// already mutably borrowed.
    ///
    /// # Important notes
    ///
    /// Do **not** replace script instance using mutable reference given to you by this method.
    /// This will prevent correct script de-initialization! Use [`Self::replace_script`] if you need
    /// to replace the script.
    #[inline]
    pub fn script_mut(&mut self, index: usize) -> Option<&mut Script> {
        self.scripts.get_mut(index).and_then(|s| s.as_mut())
    }

    /// Returns an iterator that yields all assigned scripts.
    #[inline]
    pub fn scripts_mut(&mut self) -> impl Iterator<Item = &mut Script> {
        self.scripts.iter_mut().filter_map(|s| s.as_mut())
    }

    /// Enables or disables scene node. Disabled scene nodes won't be updated (including scripts) or rendered.
    ///
    /// # Important notes
    ///
    /// Enabled/disabled state will affect children nodes. It means that if you have a node with children nodes,
    /// and you disable the node, all children nodes will be disabled too even if their [`Self::is_enabled`] method
    /// returns `true`.
    #[inline]
    pub fn set_enabled(&mut self, enabled: bool) -> bool {
        self.enabled.set_value_and_mark_modified(enabled)
    }

    /// Returns `true` if the node is enabled, `false` - otherwise. The return value does **not** include the state
    /// of parent nodes. It should be considered as "local" enabled flag. To get actual enabled state, that includes
    /// the state of parent nodes, use [`Self::is_globally_enabled`] method.
    #[inline]
    pub fn is_enabled(&self) -> bool {
        *self.enabled.property
    }

    /// Returns `true` if the node and every parent up in hierarchy is enabled, `false` - otherwise. This method
    /// returns "true" `enabled` flag. Its value could be different from the value returned by [`Self::is_enabled`].
    #[inline]
    pub fn is_globally_enabled(&self) -> bool {
        self.global_enabled.get()
    }

    /// Returns a root resource of the scene node. This method crawls up on dependency tree until it finds that
    /// the ancestor node does not have any dependencies and returns this resource as the root resource. For
    /// example, in case of simple scene node instance, this method will return the resource from which the node
    /// was instantiated from. In case of 2 or more levels of dependency, it will always return the "top"
    /// dependency in the dependency graph.
    #[inline]
    pub fn root_resource(&self) -> Option<ModelResource> {
        if let Some(resource) = self.resource.as_ref() {
            let mut state = resource.state();
            if let Some(model) = state.data() {
                if let Ok(ancestor_node) = model
                    .get_scene()
                    .graph
                    .try_get_node(self.original_handle_in_resource)
                {
                    return if ancestor_node.resource.is_none() {
                        Some(resource.clone())
                    } else {
                        ancestor_node.root_resource()
                    };
                }
            }
        }
        None
    }
}

impl Default for Base {
    fn default() -> Self {
        BaseBuilder::new().build_base()
    }
}

// Serializes Option<Script> using given serializer.
pub(crate) fn visit_opt_script(
    name: &str,
    script: &mut Option<Script>,
    visitor: &mut Visitor,
) -> VisitResult {
    let mut region = visitor.enter_region(name)?;

    let mut script_type_uuid = script.as_ref().map(|s| s.id()).unwrap_or_default();
    script_type_uuid.visit("TypeUuid", &mut region)?;

    if region.is_reading() {
        *script = if script_type_uuid.is_nil() {
            None
        } else {
            let serialization_context = region
                .blackboard
                .get::<SerializationContext>()
                .expect("Visitor blackboard must contain serialization context!");

            Some(
                serialization_context
                    .script_constructors
                    .try_create(&script_type_uuid)
                    .ok_or_else(|| {
                        VisitError::User(format!(
                            "There is no corresponding script constructor for {script_type_uuid} type!"
                        ))
                    })?,
            )
        };
    }

    if let Some(script) = script {
        script.visit("ScriptData", &mut region)?;
    }

    Ok(())
}

impl Visit for Base {
    fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult {
        let mut region = visitor.enter_region(name)?;

        self.name.visit("Name", &mut region)?;
        self.local_transform.visit("Transform", &mut region)?;
        self.visibility.visit("Visibility", &mut region)?;
        self.parent.visit("Parent", &mut region)?;
        self.children.visit("Children", &mut region)?;
        self.resource.visit("Resource", &mut region)?;
        self.is_resource_instance_root
            .visit("IsResourceInstance", &mut region)?;
        self.lifetime.visit("Lifetime", &mut region)?;
        self.lod_group.visit("LodGroup", &mut region)?;
        self.original_handle_in_resource
            .visit("Original", &mut region)?;
        self.tag.visit("Tag", &mut region)?;
        self.properties.visit("Properties", &mut region)?;
        self.frustum_culling.visit("FrustumCulling", &mut region)?;
        self.cast_shadows.visit("CastShadows", &mut region)?;
        self.instance_id.visit("InstanceId", &mut region)?;
        self.enabled.visit("Enabled", &mut region)?;
        self.render_mask.visit("RenderMask", &mut region)?;

        // Script visiting may fail for various reasons:
        //
        // 1) Data inside a script is not compatible with latest code (there is no backward
        //    compatibility for the data)
        // 2) Script was removed in the game.
        //
        // None of the reasons are fatal and we should still give an ability to load such node
        // to edit or remove it.

        let _ = self.scripts.visit("Scripts", &mut region);

        Ok(())
    }
}

/// Base node builder allows you to create nodes in declarative manner.
pub struct BaseBuilder {
    name: String,
    visibility: bool,
    local_transform: Transform,
    children: Vec<Handle<Node>>,
    lifetime: Option<f32>,
    lod_group: Option<LodGroup>,
    inv_bind_pose_transform: Matrix4<f32>,
    tag: String,
    frustum_culling: bool,
    cast_shadows: bool,
    scripts: Vec<ScriptRecord>,
    instance_id: SceneNodeId,
    enabled: bool,
}

impl Default for BaseBuilder {
    fn default() -> Self {
        Self::new()
    }
}

impl BaseBuilder {
    /// Creates new builder instance.
    #[inline]
    pub fn new() -> Self {
        Self {
            name: Default::default(),
            visibility: true,
            local_transform: Default::default(),
            children: Default::default(),
            lifetime: None,
            lod_group: None,
            inv_bind_pose_transform: Matrix4::identity(),
            tag: Default::default(),
            frustum_culling: true,
            cast_shadows: true,
            scripts: vec![],
            instance_id: SceneNodeId(Uuid::new_v4()),
            enabled: true,
        }
    }

    /// Sets desired name.
    #[inline]
    pub fn with_name<P: AsRef<str>>(mut self, name: P) -> Self {
        name.as_ref().clone_into(&mut self.name);
        self
    }

    /// Sets desired visibility.
    #[inline]
    pub fn with_visibility(mut self, visibility: bool) -> Self {
        self.visibility = visibility;
        self
    }

    /// Sets desired local transform.
    #[inline]
    pub fn with_local_transform(mut self, transform: Transform) -> Self {
        self.local_transform = transform;
        self
    }

    /// Sets desired inverse bind pose transform.
    #[inline]
    pub fn with_inv_bind_pose_transform(mut self, inv_bind_pose: Matrix4<f32>) -> Self {
        self.inv_bind_pose_transform = inv_bind_pose;
        self
    }

    /// Enables or disables the scene node.
    pub fn with_enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }

    /// Adds a new child to the node. If the given handle is [`Handle::NONE`], then the handle will
    /// be ignored.
    pub fn with_child(mut self, handle: Handle<impl ObjectOrVariant<Node>>) -> Self {
        if handle.is_some() {
            self.children.push(handle.to_base())
        }
        self
    }

    /// Sets desired lifetime.
    #[inline]
    pub fn with_lifetime(mut self, time_seconds: f32) -> Self {
        self.lifetime = Some(time_seconds);
        self
    }

    /// Sets desired lod group.
    #[inline]
    pub fn with_lod_group(mut self, lod_group: LodGroup) -> Self {
        self.lod_group = Some(lod_group);
        self
    }

    /// Sets desired tag.
    #[inline]
    pub fn with_tag(mut self, tag: String) -> Self {
        self.tag = tag;
        self
    }

    /// Sets desired frustum_culling flag.
    #[inline]
    pub fn with_frustum_culling(mut self, frustum_culling: bool) -> Self {
        self.frustum_culling = frustum_culling;
        self
    }

    /// Sets whether mesh should cast shadows or not.
    #[inline]
    pub fn with_cast_shadows(mut self, cast_shadows: bool) -> Self {
        self.cast_shadows = cast_shadows;
        self
    }

    /// Sets script of the node.
    #[inline]
    pub fn with_script<T>(mut self, script: T) -> Self
    where
        T: ScriptTrait,
    {
        self.scripts.push(ScriptRecord::new(Script::new(script)));
        self
    }

    /// Sets new instance id.
    pub fn with_instance_id(mut self, id: SceneNodeId) -> Self {
        self.instance_id = id;
        self
    }

    /// Creates an instance of [`Base`].
    #[inline]
    pub fn build_base(self) -> Base {
        Base {
            self_handle: Default::default(),
            script_message_sender: None,
            message_sender: None,
            name: self.name.into(),
            children: self.children,
            local_transform: TrackedProperty::unbound(
                self.local_transform,
                NodeMessageKind::TransformChanged,
            ),
            lifetime: self.lifetime.into(),
            visibility: TrackedProperty::unbound(
                self.visibility.into(),
                NodeMessageKind::VisibilityChanged,
            ),
            enabled: TrackedProperty::unbound(
                self.enabled.into(),
                NodeMessageKind::EnabledFlagChanged,
            ),
            render_mask: BitMask::all().into(),
            global_visibility: Cell::new(true),
            parent: Handle::NONE,
            global_transform: Cell::new(Matrix4::identity()),
            inv_bind_pose_transform: self.inv_bind_pose_transform,
            resource: None,
            original_handle_in_resource: Handle::NONE,
            is_resource_instance_root: false,
            lod_group: self.lod_group.into(),
            tag: self.tag.into(),
            properties: Default::default(),
            frustum_culling: self.frustum_culling.into(),
            cast_shadows: self.cast_shadows.into(),
            scripts: self.scripts,
            instance_id: SceneNodeId(Uuid::new_v4()),

            global_enabled: Cell::new(true),
        }
    }
}