####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python CoordinateInterpolator2dExample.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=3,name='Interpolation'),
    meta(content='CoordinateInterpolator2dExample.x3d',name='title'),
    meta(content='Example to interpolate using CoordinateInterpolator2D - select and hold geometry for a user-controlled animation loop.',name='description'),
    meta(content='Don Brutzman, Jeff Weekley, Jane Wu',name='creator'),
    meta(content='9 October 2001',name='created'),
    meta(content='31 August 2023',name='modified'),
    meta(content='CoordinateInterpolator2D',name='subject'),
    meta(content='CoordinateInterpolator2dExamplePhoneTouchScreenImage.png',name='Image'),
    meta(content='[x3d-public] TimeSensor Control https://web3d.org/pipermail/x3d-public_web3d.org/2023-August/019468.html',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation/CoordinateInterpolator2dExample.x3d',name='identifier'),
    meta(content='https://www.web3d.org/x3d/content/examples/Basic/development/CoordinateInterpolator2dExample.x3d',name='reference'),
    meta(content='X3D-Edit 3.3, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='../license.html',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(title='CoordinateInterpolator2dExample.x3d'),
    Viewpoint(description='Click to activate animation',orientation=(1,0,0,-0.4),position=(0,4,10)),
    TimeSensor(DEF='Clock',cycleInterval=5,enabled=False,loop=True),
    CoordinateInterpolator2D(DEF='InterpolateCrossSection',key=[0,0.45,0.9,1],keyValue=[(1,1),(1,-1),(-1,-1),(-1,1),(1,1),(2,2),(2,-2),(-1,-1),(-1,1),(2,2),(1,1),(1,-1),(-1,-1),(-1,1),(1,1),(1,1),(1,-1),(-1,-1),(-1,1),(1,1)]),
    ROUTE(fromField='fraction_changed',fromNode='Clock',toField='set_fraction',toNode='InterpolateCrossSection'),
    Transform(translation=(1.15,1,0),
      children=[
      Comment('& is the XML escape character code for ampersand character'),
      TouchSensor(DEF='Toucher',description='select & hold shape to animate Extrusion'),
      ROUTE(fromField='isActive',fromNode='Toucher',toField='enabled',toNode='Clock'),
      Comment('also reset clock to restart'),
      ROUTE(fromField='touchTime',fromNode='Toucher',toField='startTime',toNode='Clock'),
      Shape(
        appearance=Appearance(
          material=Material(diffuseColor=(0.2,0.8,0.4),emissiveColor=(0.05,0.2,0.1))),
        geometry=Extrusion(DEF='AnimatedCrossSectionExtrusion',spine=[(-4,0,-2),(-1,0,-2),(2,0,1),(2,0,4)]),
        # default Extrusion crossSection='1 1 1 -1 -1 -1 -1 1 1 1' is a square
),
      ROUTE(fromField='value_changed',fromNode='InterpolateCrossSection',toField='set_crossSection',toNode='AnimatedCrossSectionExtrusion')]),
    Transform(translation=(-1.5,-1,2),
      children=[
      Billboard(axisOfRotation=(0,0,0),
        children=[
        Shape(
          geometry=Text(string=["select & hold shape","to animate Extrusion"],
            fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],size=0.8)),
          appearance=Appearance(
            material=Material(diffuseColor=(0.8,0.4,0.2))))])])])
)

### X3D model conversion complete ###

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

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