Struct dzahui::simulation::dzahui_window::DzahuiWindow

pub struct DzahuiWindow {

    context: ContextWrapper<PossiblyCurrent, Window>,
    pub(crate) geometry_shader: Shader,
    event_loop: Option<EventLoop<()>>,
    mouse_coordinates: Point2<f32>,
    initial_time_step: Option<f64>,
    character_set: CharacterSet,
    integration_iteration: usize,
    pub(crate) height: u32,
    pub(crate) width: u32,
    vertex_selector: Cone,
    text_shader: Shader,
    window_text_scale: f32,
    pub timer: Instant,
    camera: Camera,
    solver: Solver,
    time_step: f64,
    mesh: Mesh,
    write_location: String,
    file_prefix: String,
}

General Information

DzahuiWindow holds every important component to create an instancec of a simulator. Only one instance should be active at once.

Fields

• context - Holds an instance of OpenGL. This normally means that all configuration associated with rendering is stored here. Only one context is allowed
• geometry_shader - Geometry_shaders to compile and use. Responsible for mesh drawing
• event_loop - To obtain user input in window and refresh window
• mouse_coordinates - Current coordinates of mouse
• initial_time_step - When solving a time-dependent problem and not specifiying a time, an initial time should be given while enough information is collected to use framerate
• character_set - Set of characters to draw on screen
• integration_iteration - Amount of terms to approximate integral
• height - Height of window created
• width - Width of window created
• vertex_selector - A cone to interact with the screen using the mouse
• text_shader - Text shaders to compile and use. Responsible for text rendering
• window_text_scale - Scale of text in front of window. This text does not change with camera view
• timer - Gives current time since creation of window. Call with timer.elapsed()
• camera - Camera configuration creates view and projetion matrices, which directly tells OpenGL what to and not to render
• solver - Solver enum representing the kind of equation to simmulate
• time_step - How much to forward a time-dependent solution
• mesh - A mesh to draw to screen. Represents an object tessellated into triangles/traingular prisms
• write_location - Where to write values from solved equation of needed
• file_prefix- If writing files require a prefix to identify them

Fields

context: ContextWrapper<PossiblyCurrent, Window>

geometry_shader: Shader

event_loop: Option<EventLoop<()>>

mouse_coordinates: Point2<f32>

initial_time_step: Option<f64>

character_set: CharacterSet

integration_iteration: usize

height: u32

width: u32

vertex_selector: Cone

text_shader: Shader

window_text_scale: f32

timer: Instant

camera: Camera

solver: Solver

time_step: f64

mesh: Mesh

write_location: String

file_prefix: String

Implementations

impl DzahuiWindow

pub fn builder<F>(location: F) -> DzahuiWindowBuilderwhere
    F: AsRef<str>,

Creates a new default builder.

pub fn restart_timer(&mut self)

To restart timer of window in case is needed.

pub fn update_mouse_coordinates(&mut self, x: f32, y: f32)

Callback to change mouse coordinates.

fn activate_view_change(&mut self, state: ElementState)

Callback that changes wether camera can be edited by user input or not.

fn get_selected_vertex(&mut self) -> Result<(), Error>

Callback to obtain vertex intersection with click produced cone.

fn change_camera_view(&mut self, x: f32, y: f32)

Callback to change camera view matrix based on user motion.

fn resize_window(&mut self, new_size: PhysicalSize<u32>)

Callback to resize window.

fn send_vertex_info(&self, info: Vec<f64>, sender: &SyncSender<Vec<f64>>)

Send information of vertices to be written

pub fn run(self)

General Information

Run window with a mesh and an event loop. Consumes every object. Generates actual solver based on solver enum. Sets mesh and text.

Parameters

• mut self - A window instance.