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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
use crate::render_features::render_features_prelude::*;
use crate::visibility::VisibilityObjectId;
use fnv::{FnvHashMap, FnvHasher};
use std::hash::{BuildHasherDefault, Hash};

/// The `FramePacket` is the data that must be extracted from either the `AssetManager` or the game's
/// `World` during the `Extract` step. After the `Extract` step has finished, there is no more access
/// allowed to either the `AssetManager` or the game's `World`. The `FramePacket` **must** be considered
/// immutable after the `Extract` step has finished.
pub trait FramePacketData {
    /// All data that is either unassociated with or shared by
    /// any of the render objects across each `RenderView`.
    type PerFrameData: Sync + Send;

    /// All data associated with a particular `Entity` and `RenderObject`.
    type RenderObjectInstanceData: Sync + Send;

    /// All data that is associated with a particular `RenderView`.
    /// This and a `Vec`<`RenderObjectInstancePerViewData`> define
    /// each `ViewPacket` in the `FramePacket`.
    type PerViewData: Sync + Send;

    /// All data associated with a particular `Entity`, `RenderObject`, and `RenderView`.
    type RenderObjectInstancePerViewData: Sync + Send;

    // TODO(dvd): see issue #29661 <https://github.com/rust-lang/rust/issues/29661> for more information
    // type FramePacket = GenericFramePacket<Self>;
    // type ViewPacket = GenericViewPacket<Self>;
}

/// Read documentation on `FramePacketData`.
pub struct FramePacket<FramePacketDataT: FramePacketData> {
    feature_index: RenderFeatureIndex,
    render_object_instance_ids: FnvHashMap<RenderObjectInstance, RenderObjectInstanceId>,

    pub(crate) per_frame_data: AtomicOnceCell<FramePacketDataT::PerFrameData>,
    pub(crate) render_object_instances: Vec<RenderObjectInstance>,
    pub(crate) render_object_instances_data:
        AtomicOnceCellArray<FramePacketDataT::RenderObjectInstanceData>,

    views: Vec<ViewPacket<FramePacketDataT>>,
}

impl<FramePacketDataT: FramePacketData> FramePacket<FramePacketDataT> {
    pub fn new(
        feature_index: RenderFeatureIndex,
        frame_packet_size: &FramePacketSize,
    ) -> Self {
        // TODO(dvd): 3 + 2 * N allocations here -- the vec of views, the per frame entities vec, the entity indices hash map, and two vecs * N views for objects / volumes.
        let mut views = Vec::with_capacity(frame_packet_size.view_packet_sizes.len());

        for view_packet_size in frame_packet_size.view_packet_sizes.iter() {
            let view_frame_index = views.len() as u32;
            view_packet_size
                .view
                .set_view_frame_index(feature_index, view_frame_index);
            views.push(ViewPacket::new(view_packet_size, view_frame_index));
        }

        Self {
            feature_index,
            per_frame_data: AtomicOnceCell::new(),
            render_object_instances: Vec::with_capacity(
                frame_packet_size.num_render_object_instances,
            ),
            render_object_instances_data: AtomicOnceCellArray::with_capacity(
                frame_packet_size.num_render_object_instances,
            ),
            render_object_instance_ids: FnvHashMap::with_capacity_and_hasher(
                frame_packet_size.num_render_object_instances,
                BuildHasherDefault::<FnvHasher>::default(),
            ),
            views,
        }
    }

    pub fn view_packets(&self) -> &Vec<ViewPacket<FramePacketDataT>> {
        &self.views
    }

    pub fn view_packet(
        &self,
        view_index: ViewFrameIndex,
    ) -> &ViewPacket<FramePacketDataT> {
        self.views.get(view_index as usize).unwrap_or_else(|| {
            panic!(
                "ViewPacket with ViewFrameIndex {} was not found in {}.",
                view_index,
                std::any::type_name::<FramePacketDataT>()
            )
        })
    }

    pub fn view_packet_mut(
        &mut self,
        view_index: ViewFrameIndex,
    ) -> &mut ViewPacket<FramePacketDataT> {
        self.views.get_mut(view_index as usize).unwrap_or_else(|| {
            panic!(
                "ViewPacket with ViewFrameIndex {} was not found in {}.",
                view_index,
                std::any::type_name::<FramePacketDataT>()
            )
        })
    }

    pub fn render_object_instances(&self) -> &Vec<RenderObjectInstance> {
        &self.render_object_instances
    }

    pub fn render_object_instances_data(
        &self
    ) -> &AtomicOnceCellArray<FramePacketDataT::RenderObjectInstanceData> {
        &self.render_object_instances_data
    }

    pub fn per_frame_data(&self) -> &AtomicOnceCell<FramePacketDataT::PerFrameData> {
        &self.per_frame_data
    }
}

impl<FramePacketDataT: 'static + Sync + Send + FramePacketData> RenderFeatureFramePacket
    for FramePacket<FramePacketDataT>
{
    fn get_or_push_render_object_instance(
        &mut self,
        render_object_instance: RenderObjectInstance,
    ) -> RenderObjectInstanceId {
        return if let Some(render_object_instance_id) =
            self.render_object_instance_ids.get(&render_object_instance)
        {
            *render_object_instance_id
        } else {
            let render_object_instance_id =
                self.render_object_instances.len() as RenderObjectInstanceId;

            self.render_object_instances.push(render_object_instance);
            self.render_object_instance_ids
                .insert(render_object_instance, render_object_instance_id);

            render_object_instance_id
        };
    }

    fn render_feature_view_packet(
        &self,
        view_index: ViewFrameIndex,
    ) -> &dyn RenderFeatureViewPacket {
        self.view_packet(view_index)
    }

    fn render_feature_view_packet_mut(
        &mut self,
        view_index: u32,
    ) -> &mut dyn RenderFeatureViewPacket {
        self.view_packet_mut(view_index)
    }

    fn feature_index(&self) -> RenderFeatureIndex {
        self.feature_index
    }
}

/// A specific `Entity` and `RenderObject` represented by the `ObjectId` and `RenderObjectId`. A
/// `RenderObject` is associated with a particular `RenderFeature` by the `RenderFeatureIndex`.
/// The `FramePacket` only contains unique `RenderObjectInstance`s.
#[derive(Copy, Eq, PartialEq, Hash, Clone, Debug)]
pub struct RenderObjectInstance {
    pub object_id: ObjectId,
    pub render_object_id: RenderObjectId,
    pub visibility_object_id: VisibilityObjectId,
}

impl RenderObjectInstance {
    pub fn new(
        object_id: ObjectId,
        render_object_id: RenderObjectId,
        visibility_object_id: VisibilityObjectId,
    ) -> Self {
        Self {
            object_id,
            render_object_id,
            visibility_object_id,
        }
    }
}