Skip to content

RichardMatzko/UnrealMulticell3D

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 

Repository files navigation

UnrealMulticell3D

UM3D_Demo_compressed.gif

Software: UnrealMulticell3D (UM3D) version "SimplestCell".

Author: Richard Oliver Matzko

License: CC-BY

Attribute via reference to:

https://www.mdpi.com/2073-4425/14/1/154

This is an update on the original conference paper:

https://link.springer.com/chapter/10.1007/978-3-031-07802-6_17

WARNING: Please be aware that using this incomplete software is at your own risk. The cells will not stop proliferating by themselves, you must close the application or press the reset button in a timely fashion. This version was focused towards performance optimization.

If you can demonstrate improved performance for this work and set of functions please contact me and let me know how you achieved it.

About

This project was conceived of for Synthetic Biology CAD as a PhD candidate.

This is a simplified version of UnrealMulticell3D for performance testing. It removes many features and demonstrates performance of cells in terms of proliferation (growth and cell division). The full version (unreleased) possesses a Cell Editor and more parameters. The above preview may differ from this released version.

Key functions present in this version:

  • Cell Spawn Transforms
  • Cell Growth
  • Cell Division
  • Color Oscillation

Note: Some variables might not be in use in this version and might be artifacts.

For more information please read https://www.mdpi.com/2073-4425/14/1/154 (the older conference paper can still be found at https://link.springer.com/chapter/10.1007/978-3-031-07802-6_17).

Installation

This software was developed in Windows 10/11. Projects may be cross compatible with other operating systems. This has not been confirmed.

This project utilized (UE4) Unreal Engine version 4.26.2 and should be opened using the UE4 editor.

On Windows, follow these steps:

  1. Download UM3D_Vers_SimplestCell.zip
  2. Install Epic Games Launcher https://store.epicgames.com/en-US/download
  3. Register and log in.
  4. Go to Unreal Engine (UE) -> Library in Epic Games Launcher
  5. Install UE version 4.26.2
  6. Your documents folder should have a folder called "Unreal Projects". If not create it and extract the UM3D_Vers_SimplestCell folder from UM3D_Vers_SimplestCell.zip into Documents/Unreal Projects.
  7. Navigate back to your Unreal Engine Library in Epic Games Launcher.
  8. Double click the project: UM3D_Vers_SimplestCell
  9. When building the project for the first time, the editor appears to reinstate 600 megabytes worth of deleted starter content to the project.
  10. The project may say that modules are missing and you will need to build the project the first time which should take only a few minutes.

To run the program press the play button in the editor menu. Use the small arrow to select Standalone Game, where performance is superior to the editor.

Basic Controls:

  • Navigation: Mouse, Left Click and WASD keyboard
  • R: Toggles the camera on/off

On Screen Controls:

  • Reset: Resets and stops the Simulation
  • Start: Starts the Simulation
  • Count: Counts the current number of cells

Advanced details:

The physics constraint mode is set to a monolayer (xy plane), which can be adjusted in the "SimplestCell" blueprint.

Behaviours can be modified through blueprinting or even custom C++ functions, and parameter adjustment of existing functions.

Releases

No releases published

Packages

No packages published