Low poly primitive pyramid 🔺 for agent visualisation 🔥🔥

[zeyus]

• Intro
• Specs
• Using the model
• Screenshots
• License
• Download

Intro

I only have a GTX1070, and my simulation is going to have a lot of agents, obviously the visualization part isn't necessary, but it's very nice to have, also for figures in the paper.

Anyway, as such, I made the most simple 3D agent model I could imagine in blender, and anyone is welcome to use it if they would like.

Specs

Property	Value
Vertices	4
Edges	6
Faces/polygons	4
Face corners	12

Using the model

Extract the primitive_pyramid.obj file to somewhere you can reference from your code, and then as per the flamegpu agent model documentation, just call the AgentVis::setModel function of your initialised AgentVis class.

Example:

import pyflamegpu

model: pyflamegpu.ModelDescription = pyflamegpu.ModelDescription('test_model')
agent: pyflamegpu.AgentDescription = model.newAgent('test_agent')
env: pyflamegpu.EnvironmentDescription = model.Environment()
simulation: pyflamegpu.CUDASimulation = pyflamegpu.CUDASimulation(model)
visualisation: pyflamegpu.ModelVis = simulation.getVisualisation()
vis_agent: pyflamegpu.AgentVis = visualisation.addAgent('test_agent')

# specify the custom low poly model
vis_agent.setModel('./path/to/primitive_pyramid.obj')
# populate simulation etc
# ...
simulation.simulate()

Screenshots

Model in blender:

Screenshot from a flamegpu simulation:

Updated version with actual equilateral triangular pyramid + arrowhead (for directional indication):

Licence

The MIT License (MIT)

Copyright (c) 2022 zeyus (https://github.com/zeyus)

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.

Download

Download updated version with an arrowhead model and a (proper) equilateral triangular pyramid (including blender file and exported .obj):
pyramids_equi_and_arrow.zip

Download original eyeballed triangular pyramid model (including blender file and exported .obj): Primitive_Pyramid.zip

[Robadob]

Great idea creating a 4 triangle model, not something I had considered. If you want it merged put a PR into the visualiser's repo

• A copy of the .obj would go in resources/
• Add the path of the new .obj file to src/CMakeLists.txt:316
• Add it's resource path to include/flamegpu/visualiser/config/Stock.h (you should credit yourself here in the comment, and possibly worth stating it's orientation).

I think that's all which is required to properly integrate it, but you may also want to update the userguide:

• Add it to the list at src/guide/visualisation/visualising-agents.rst:39

There could be an argument for making a none-equilateral version, so it more clearly shows it's orientation (like an arrow-head).

[zeyus]

yeah I actually thought about the non-equilateral version myself but for my sim direction doesn't matter. I'll make a PR and I can create a second version that has a "front" (also, to be honest, it's not perfectly equilateral, I just eyeballed it, but I'll make a proper equilateral version). I just made it so Z+ was up, but I'll make sure to note it.

Expect an incoming PR within the next few hours (obviously no pressure to merge anytime soon).