rafx-framework 0.0.12

Rendering framework built on an extensible asset pipeline
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use crate::visibility::view_frustum_arc::ViewFrustumArc;
use crate::visibility::visibility_object_allocator::{
    VisibilityObjectAllocator, VisibilityObjectId, VisibilityObjectRef,
};
use crate::visibility::visibility_object_arc::{CullModel, VisibilityObjectArc};
use crate::visibility::EntityId;
use crossbeam_channel::Sender;
use rafx_visibility::{AsyncCommand, VisibilityWorldArc, ZoneHandle};
use std::sync::Arc;

pub struct VisibilityRegion {
    allocator: Arc<VisibilityObjectAllocator>,
    commands: Sender<AsyncCommand>,
    dynamic_zone: ZoneHandle,
    static_zone: ZoneHandle,
}

impl VisibilityRegion {
    pub fn new() -> Self {
        let visibility_world = VisibilityWorldArc::new();
        let allocator = Arc::new(VisibilityObjectAllocator::new(visibility_world.clone()));

        let mut inner = visibility_world.inner.lock();
        let static_zone = inner.new_zone();
        let dynamic_zone = inner.new_zone();

        VisibilityRegion {
            commands: visibility_world.new_async_command_sender(),
            static_zone,
            dynamic_zone,
            allocator,
        }
    }

    pub fn register_view_frustum(&self) -> ViewFrustumArc {
        self.allocator
            .new_view_frustum(Some(self.static_zone), Some(self.dynamic_zone))
    }

    pub fn register_static_view_frustum(&self) -> ViewFrustumArc {
        self.allocator
            .new_view_frustum(Some(self.static_zone), None)
    }

    pub fn register_dynamic_view_frustum(&self) -> ViewFrustumArc {
        self.allocator
            .new_view_frustum(None, Some(self.dynamic_zone))
    }

    /// Returns a smart pointer to a handle representing a static object.
    /// A static object is a hint to the visibility world that the object's transform changes rarely.
    /// Most geometry in the world is static -- buildings, trees, rocks, grass, and so on.
    pub fn register_static_object(
        &self,
        entity_id: EntityId,
        cull_model: CullModel,
    ) -> VisibilityObjectArc {
        self.register_object(entity_id, cull_model, self.static_zone)
    }

    /// Returns a smart pointer to a handle representing a dynamic object.
    /// A dynamic object is a hint to the visibility world that the object's transform changes often.
    /// Characters, projectiles, vehicles, and moving platforms are examples of dynamic geometry.
    pub fn register_dynamic_object(
        &self,
        entity_id: EntityId,
        cull_model: CullModel,
    ) -> VisibilityObjectArc {
        self.register_object(entity_id, cull_model, self.dynamic_zone)
    }

    fn register_object(
        &self,
        entity_id: EntityId,
        cull_model: CullModel,
        zone: ZoneHandle,
    ) -> VisibilityObjectArc {
        self.allocator.new_object(entity_id, cull_model, Some(zone))
    }

    pub fn object_ref(
        &self,
        id: VisibilityObjectId,
    ) -> VisibilityObjectRef {
        self.allocator.object_ref(id)
    }
}

impl Drop for VisibilityRegion {
    fn drop(&mut self) {
        let _ = self
            .commands
            .send(AsyncCommand::DestroyZone(self.static_zone));
        let _ = self
            .commands
            .send(AsyncCommand::DestroyZone(self.dynamic_zone));
    }
}