pyThreeD.py

# -*- coding: utf-8 -*-

# pylint: disable=trailing-whitespace,bad-whitespace,invalid-name
# pylint: disable=anomalous-backslash-in-string,bad-continuation
# pylint: disable=multiple-statements,redefined-outer-name,global-statement

"""
FILE:  pyThreeD.py
DATE:  06 DEC 2023
AUTH:  G. E. Deschaines
DESC:  Three dimensional (3D) drawing of missile/target engagement trajectory
       objects defined as collections of polygons.
REFS:
     
  [1] This Python script was translated from threeD.c available at:
      https://github.com/gedeschaines/threeD/blob/master/src/threeD.c


Disclaimer:  See DISCLAIMER file.

"""

import sys
import warnings

warnings.simplefilter(action='ignore', category=FutureWarning)

try:
    import matplotlib.pyplot as plt
except ImportError:
    print("* Error: Matplotlib package required.")
    print("         Suggest installing the SciPy stack.")
    sys.exit()

from draw3D import Draw3D

global theFigure  # Instantiated matplotlib pyplot figure
global theDraw3D  # Instantiated Draw3D object
global started    # Draw3D.MainLoop method started flag

started = False


def onClick(event):
    """
    Mouse button pressed handler
    """
    global theFigure
    global theDraw3D
    global started
    
    #b = event.button
    #x = event.xdata
    #y = event.ydata
    if not started:
        started = True
        theDraw3D.MainLoop()
        if theDraw3D.doneflag:
            theFigure.clear()
            plt.close(theFigure)
            sys.exit()
        started = False
       

if __name__ == "__main__":
    
    # Set image save flag and rate (FPS).
    
    img_Save = False  # Save rendered images as PNG files
    img_FPS = 50;     # (semi-colon is hold over from threeD.c)
    
    # Process command line arguments.
    
    CaseId = None  # TXYZ.OUT.CaseId
    
    if len(sys.argv) > 2:
        CaseId   = sys.argv[1]
        img_Save = False if sys.argv[2] == "0" else True
    else:
        print("usage:  python3 pyThreeD.py CaseId [0|1]")
        print("where:  CaseId - read trajectory data from ./out/TXYZ.OUT.CaseId")
        print("        [0|1]  - save rendered image flag (0=False, 1=True)")
        sys.exit()
        
    File  = "./out/TXYZ.OUT." + CaseId
    title = "pyThreeD - " + File
      
    # Instantiate the matplotlib pyplot figure for display of
    # engagement rendering animation.

    # For 100 dots-per-inch (dpi):
    #figsize=(6.0,6.0)     # 465x462 viewport
    figsize=(8.0,6.0)      # 620x462 viewport
    #figsize=(8.0,8.0)     # 620x616 viewport
    #figsize=(7.74,7.78)   # 600x599 viewport
    #figsize=(10.0,8.0)    # 775x616 viewport
    #figsize=(10.32,7.80)  # 800x601 viewport

    theFigure = plt.figure(figsize=figsize, dpi=100.0)

    try:
        theFigure.set_tight_layout(True)
    except:
        theFigure.set_layout_engine('tight')
        
    # Specify plotting layout and parameters.
    
    ax = theFigure.add_subplot(111, autoscale_on=False, animated=False)
    ax.set_title(title)
    ax.set_xticks([])
    ax.set_yticks([])
    ax.set_aspect('equal')
    bbox = ax.bbox.get_points()
    w = round(bbox[1,0] - bbox[0,0])
    h = round(bbox[1,1] - bbox[0,1])
    #print("w= %d, h= %d" % (w, h))
    ax.set_xlim(0.0, w)
    ax.set_ylim(h, 0.0)
    ax.set_facecolor('#d8dcd6')  # light gray
    theFigure.canvas.draw()
    
    # Instantiate the Draw3D object to perform missile/target
    # engagement rendering.
    
    msltyp = int(CaseId)//1000
    theDraw3D = Draw3D(txyzFile=File, mslType=msltyp,
                       w=w, h=h, fig=theFigure, ax=ax,
                       imgSave=img_Save, imgFPS=img_FPS)
    
    # Load object shape polygon data.
    
    theDraw3D.ReadPolyData()
    
    # Assign mouse button press handler.
    
    cidbtn = theFigure.canvas.mpl_connect('button_press_event', onClick)
    
    # Assign key press event handler.
    
    cidkey = theFigure.canvas.mpl_connect('key_press_event', theDraw3D.onPress)
    
    # Present instructions, then display figure window for rendering. 
    
    print("With cursor in the displayed Figure, press a mouse button")
    print("to initiate threeD animation. If animation is exited or has")
    print("completed, close figure to terminate this program or press")
    print("a mouse button to restart animation. During threeD program")
    print("animation the following key presses are recognized:\n")
    
    print("Press T key to toggle field-of-view towards target.")
    print("Press M key to toggle field-of-view towards missile.")
    print("Press H key to toggle field-of-view along missile heading.")
    print("Press Z key to reset zoom to one.")
    print("Press Up Arrow key to increase zoom.")
    print("Press Down Arrow key to decrease zoom.")
    print("Press 0 (zero) key to reset animation step delay to zero.")
    print("Press Left Arrow key to slow animation down by 10 msec increments.")
    print("Press Right Arrow key to speed animation up by 10 msec increments.")
    print("Press Space key to toggle pause/unpause.")
    print("Press X key to exit animation (press a mouse button to restart).")
    print("Press Q key to close figure (should only press after X key press).")
    print("Press Esc key to exit program (should only press before X key press).")

    plt.show(block=True)
    
    # Execution terminated, delete the Draw3D object and exit.
    
    del theDraw3D