####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python KelpTankWaterSurface.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='Interchange',version='3.3',
  head=head(
    children=[
    meta(content='KelpTankWaterSurface.x3d',name='title'),
    meta(content='Moving water surface for KelpTank - initial view is perpendicular, rotate viewpoint up to see motion. Cycle time is 5.5 seconds to match pump, with slight time lag to indicate inertia of quasi-steady-state equilibrium..',name='description'),
    meta(content='Todd Gagnon',name='creator'),
    meta(content='Xeena VRML importer, X3D-Edit 3.1, https://www.web3d.org/x3d/content/README.X3D-Edit.html',name='translator'),
    meta(content='9 June 1998',name='created'),
    meta(content='20 December 2002',name='translated'),
    meta(content='20 October 2019',name='modified'),
    meta(content='KelpTank.x3d',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/KelpTankWaterSurface.x3d',name='identifier'),
    meta(content='X3D-Edit 3.3, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='Vrml97ToX3dNist, http://ovrt.nist.gov/v2_x3d.html',name='generator'),
    meta(content='../license.html',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(info=["DTG of last update: 091030Jun98 Added: Updated: comment out PointLight Modeled by: Todd Gagnon"],title='surface1.4.wrl'),
    Group(
      children=[
      Transform(
        children=[
        Shape(
          appearance=Appearance(
            material=Material(ambientIntensity=1.0,diffuseColor=(0.03,0.12,0.24),emissiveColor=(0.0,0.16,0.36),shininess=0.35,specularColor=(0.2,0.5,0.8),transparency=0.15)),
          geometry=IndexedFaceSet(coordIndex=[0,1,6,7,-1,1,2,5,6,-1,2,3,4,5,-1,11,12,9,10,-1,12,13,8,9,-1,13,0,7,8,-1],solid=False,
            coord=Coordinate(DEF='SURFACE',point=[(0.0,0.0,0.0),(2.5,0.0,1.0),(4.5,0.0,3.0),(7.625,0.0,3.0),(10.25,0.0,0.375),(10.25,0.0,-4.375),(6.375,0.0,-8.0),(0.0,0.0,-8.0),(-5.5,0.0,-8.0),(-10.5,0.0,-2.875),(-10.5,0.0,0.25),(-7.625,0.0,3.0),(-4.5,0.0,3.0),(-2.5,0.0,1.0)])))])]),
    TimeSensor(DEF='SURFACEClock',cycleInterval=5.5,loop=True),
    CoordinateInterpolator(DEF='SURFACEHeight',key=[0.0,0.2,0.45,0.7,0.95],keyValue=[(0.0,0.0,0.0),(2.5,0.05,1.0),(4.5,0.1,3.0),(7.625,0.15,3.0),(10.25,0.15,0.375),(10.25,0.15,-4.375),(6.375,0.1,-8.0),(0.0,0.0,-8.0),(-5.5,-0.1,-8.0),(-10.5,-0.15,-2.875),(-10.5,-0.15,0.25),(-7.625,-0.15,3.0),(-4.5,-0.1,3.0),(-2.5,-0.05,1.0),(0.0,0.0,0.0),(2.5,0.0,1.0),(4.5,0.0,3.0),(7.625,0.0,3.0),(10.25,0.0,0.375),(10.25,0.0,-4.375),(6.375,0.0,-8.0),(0.0,0.0,-8.0),(-5.5,0.0,-8.0),(-10.5,0.0,-2.875),(-10.5,0.0,0.25),(-7.625,0.0,3.0),(-4.5,0.0,3.0),(-2.5,0.0,1.0),(0.0,-0.0,0.0),(2.5,-0.05,1.0),(4.5,-0.1,3.0),(7.625,-0.15,3.0),(10.25,-0.15,0.375),(10.25,-0.15,-4.375),(6.375,-0.1,-8.0),(0.0,-0.0,-8.0),(-5.5,0.1,-8.0),(-10.5,0.15,-2.875),(-10.5,0.15,0.25),(-7.625,0.15,3.0),(-4.5,0.1,3.0),(-2.5,0.05,1.0),(0.0,0.0,0.0),(2.5,0.0,1.0),(4.5,0.0,3.0),(7.625,0.0,3.0),(10.25,0.0,0.375),(10.25,0.0,-4.375),(6.375,0.0,-8.0),(0.0,0.0,-8.0),(-5.5,0.0,-8.0),(-10.5,0.0,-2.875),(-10.5,0.0,0.25),(-7.625,0.0,3.0),(-4.5,0.0,3.0),(-2.5,0.0,1.0),(0.0,0.0,0.0),(2.5,0.05,1.0),(4.5,0.1,3.0),(7.625,0.15,3.0),(10.25,0.15,0.375),(10.25,0.15,-4.375),(6.375,0.1,-8.0),(0.0,0.0,-8.0),(-5.5,-0.1,-8.0),(-10.5,-0.15,-2.875),(-10.5,-0.15,0.25),(-7.625,-0.15,3.0),(-4.5,-0.1,3.0),(-2.5,-0.05,1.0)]),
    ROUTE(fromField='fraction_changed',fromNode='SURFACEClock',toField='set_fraction',toNode='SURFACEHeight'),
    ROUTE(fromField='value_changed',fromNode='SURFACEHeight',toField='set_point',toNode='SURFACE')])
)

### X3D model conversion complete ###

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

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