####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python NarragansettBayMerged.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.
#
# Project home page:    # X3D Python Scene Access Interface Library (X3DPSAIL)
#                       # https://www.web3d.org/x3d/stylesheets/python/python.html
# Conversion generator: # https://www.web3d.org/x3d/stylesheets/X3dToPython.xslt
#
####################################################################################################

from x3d import *

newModel=X3D(profile='Immersive',version='3.3',
  head=head(
    children=[
    component(level=2,name='Geospatial'),
    meta(content='NarragansettBayMerged.x3d',name='title'),
    meta(content='Byounghyun Yoo, Don Brutzman',name='creator'),
    meta(content='16 June 2008',name='created'),
    meta(content='13 September 2021',name='modified'),
    meta(content='Merged bathymetry + large-area terrain tiles + coordinate axes.',name='description'),
    meta(content='https://www.web3d.org/x3d/content/examples/Savage/Locations/NarragansettBayRhodeIslandBathymetry/NarragansettBayMerged.x3d',name='identifier'),
    meta(content='X3D-Edit, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='../../license.html',name='license')]),
  Scene=Scene(
    children=[
    Comment('make bathymetry 3m lower than actual, pending TODO ceiling adjustment by Rez within tiles when generating ocean surface'),
    WorldInfo(title='NarragansettBayMerged.x3d'),
    Switch(whichChoice=-1,
      children=[
      GeoViewpoint(description='Default Viewpoint NarragansettBayBathymetry',orientation=(-1,0,0,1.57),position=(41.500539965587954,-71.43945518210546,82007.5640554569),
        geoOrigin=GeoOrigin(DEF='ORIGIN',geoCoords=(41.5,-71.5,0),geoSystem=["GD"])),
      Comment('TODO: Determine why a GeoTransform and not a GeoLocation node'),
      GeoTransform(geoCenter=(41.487,-71.339,0),translation=(0,-3,0),
        geoOrigin=GeoOrigin(USE='ORIGIN'),
 # local bathymetry archive

 # local bathymetry

        Inline(url=["./tiles/0/newport0-0.x3d","https://www.web3d.org/x3d/content/examples/Savage/Locations/NarragansettBayRhodeIslandBathymetry/tiles/0/newport0-0.x3d"])])]),
    Comment('also add separate terrain archive, unmodified'),
    Inline(DEF='NarragansettBayRhodeIslandLarge',url=["../NarragansettBayRhodeIslandLarge/tiles/0/newport0-0.x3d","https://www.web3d.org/x3d/content/examples/Savage/Locations/NarragansettBayRhodeIslandLarge/tiles/0/newport0-0.x3d"]),
    Comment('This GeoLocation block shows how to geospatially reference regular nongeospatial shapes'),
    Comment('Only required to geo-reference a scene'),
    Comment('GeoLocation geoCoords=\'41.487 -71.339 0\' geoSystem=\'"GD" "WE"\'> <Transform scale=\'100 100 100\'> <Inline DEF=\'CoordinateAxesNSEW\' url=\'"../../Basic/course/CoordinateAxesNSEW.x3d" "CoordinateAxesNSEW.x3d" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter03Grouping/CoordinateAxes.x3d"\'/> </Transform> note: using the same GeoOrigin throughout all three file sets, to avoid Xj3D problem <GeoOrigin USE=\'ORIGIN\'/> </GeoLocation'),
    Comment('TODO experiment: replace PointLights with single geospatially referenced DirectionalLight'),
    Switch(DEF='LightSwitch',whichChoice=1,
      children=[
      Group(DEF='PointLights',
        children=[
        PointLight(location=(10000000000,0,0),radius=100000000000000.),
        PointLight(location=(-10000000000,0,0),radius=100000000000000.),
        PointLight(location=(0,10000000000,0),radius=100000000000000.),
        PointLight(location=(0,-10000000000,0),radius=100000000000000.),
        PointLight(location=(0,0,10000000000),radius=100000000000000.),
        PointLight(location=(0,0,-10000000000),radius=100000000000000.)]),
      Transform(DEF='DirectionalLights',rotation=(1,0,0,0.78),
        children=[
        DirectionalLight(),
        DirectionalLight(direction=(0,1,0)),
        DirectionalLight(direction=(0,0,1)),
        DirectionalLight(direction=(-1,0,0)),
        DirectionalLight(direction=(0,-1,0)),
        DirectionalLight(),]),
      GeoLocation(geoCoords=(41.56722223554018,-71.30572987125981,0),
        geoOrigin=GeoOrigin(USE='ORIGIN'),
        children=[
        DirectionalLight(direction=(0,-1,0),global_=True)])])])
)

### X3D model conversion complete ###

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

print('Self-test diagnostics for NarragansettBayMerged.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 NarragansettBayMerged.py load and self-test diagnostics complete.")