####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python HoistGreekFlag.py
#
# Python package x3d.py package is available on PyPI for import.
#   This approach simplifies Python X3D deployment and use.
#   https://pypi.org/project/x3d
#
# Installation:
#       pip install x3d
# or
#       python -m pip install x3d
#
# Developer options for loading x3d package in other Python programs:
#
#    from x3d import *  # preferred approach, terser source that avoids x3d.* class prefixes
#
# or
#    import x3d         # traditional way to subclass x3d package, all classes require x3d.* prefix,
#                       # but python source is very verbose, for example x3d.Material x3d.Shape etc.
#                       # X3dToPython.xslt stylesheet insertPackagePrefix=true supports this option.
#
####################################################################################################

from x3d import *

newModel=X3D(profile='Immersive',version='3.0',
  head=head(
    children=[
    meta(content='HoistGreekFlag.x3d',name='title'),
    meta(content='Hoist the greek flag',name='description'),
    meta(content='Copyright [2001] By George Stavritis',name='creator'),
    meta(content='28 February 2001',name='created'),
    meta(content='20 October 2019',name='modified'),
    meta(content='https://savage.nps.edu/Savage/ShipsMilitary/FrigateGreece/HoistGreekFlag.x3d',name='identifier'),
    meta(content='X3D-Edit 3.2, https://savage.nps.edu/X3D-Edit',name='generator'),
    meta(content='../../license.html',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(title='HoistGreekFlag.x3d'),
    Viewpoint(position=(0,2,15)),
    Transform(DEF='BOUNCINGBOXTRANSFORM',
      children=[
      Inline(url=["greekflag.x3d","https://savage.nps.edu/Savage/ShipsMilitary/FrigateGreece/greekflag.x3d","greekflag.wrl","https://savage.nps.edu/Savage/ShipsMilitary/FrigateGreece/greekflag.wrl"]),
      TimeSensor(DEF='CLOCK',cycleInterval=5,loop=True),
      PositionInterpolator(DEF='CUBEPATH',key=[0.00,0.25,0.50,0.75,0.85,1.00],keyValue=[(0,3.9,0),(0,3.8,0),(0,4,0),(0,3.8,0),(0,3.9,0),(0,4.0,0)])]),
    ROUTE(fromField='fraction_changed',fromNode='CLOCK',toField='set_fraction',toNode='CUBEPATH'),
    ROUTE(fromField='value_changed',fromNode='CUBEPATH',toField='set_translation',toNode='BOUNCINGBOXTRANSFORM')])
) # X3D model complete

####################################################################################################
# Self-test diagnostics
####################################################################################################

print('Self-test diagnostics for HoistGreekFlag.py:')
if        metaDiagnostics(newModel): # built-in utility method in X3D class
    print(metaDiagnostics(newModel)) # display meta info, hint, warning, error, TODO values in this model
# print('check newModel.XML() serialization...')
newModelXML= newModel.XML() # test export method XML() for exceptions during export
newModel.XMLvalidate()
# print(newModelXML) # diagnostic

try:
#   print('check newModel.VRML() serialization...')
    newModelVRML=newModel.VRML() # test export method VRML() for exceptions during export
    # print(prependLineNumbers(newModelVRML)) # debug
    print("Python-to-VRML export of VRML output successful", flush=True)
except Exception as err: # usually BaseException
    # https://stackoverflow.com/questions/18176602/how-to-get-the-name-of-an-exception-that-was-caught-in-python
    print("*** Python-to-VRML export of VRML output failed:", type(err).__name__, err)
    if newModelVRML: # may have failed to generate
        print(prependLineNumbers(newModelVRML, err.lineno))

try:
#   print('check newModel.JSON() serialization...')
    newModelJSON=newModel.JSON() # test export method JSON() for exceptions during export
#   print(prependLineNumbers(newModelJSON)) # debug
    print("Python-to-JSON export of JSON output successful (under development)")
except Exception as err: # usually SyntaxError
    print("*** Python-to-JSON export of JSON output failed:", type(err).__name__, err)
    if newModelJSON: # may have failed to generate
        print(prependLineNumbers(newModelJSON,err.lineno))

print("python HoistGreekFlag.py load and self-test diagnostics complete.")