####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python CopperRockfishPlacardViewer.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='Interactive',version='3.3',
  head=head(
    children=[
    meta(content='CopperRockfishPlacardViewer.x3d',name='title'),
    meta(content='Viewer for tank placards - needs photo on one side, placard on other, and conversion into prototype once ready.',name='description'),
    meta(content='1 April 2002',name='created'),
    meta(content='20 October 2019',name='modified'),
    meta(content='Todd Gagnon and Mark A. Boyd',name='creator'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/CopperRockfishPlacardViewer.x3d',name='identifier'),
    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='CopperRockfishPlacardViewer.x3d'),
    Viewpoint(DEF='CopperRockfish',description='Copper Rockfish',position=(0.0,0.0,4.0)),
    Group(
      children=[
      TouchSensor(DEF='BlueRockfishTouchSensor',description='touch to rotate'),
      TimeSensor(DEF='BLUEROCKFISHCLOCK',cycleInterval=2.0),
      OrientationInterpolator(DEF='BlueRockfishPathInterpolator',key=[0.0,0.5,1.0],keyValue=[(0.0,1.0,0.0,0.0),(0.0,1.0,0.0,1.57),(0.0,1.0,0.0,3.14)]),
      Transform(DEF='BLUEROCKFISH_TRANSFORM',
        children=[
        Shape(
          appearance=Appearance(
            texture=ImageTexture(DEF='CopperRockfishImage',url=["CopperRockfishPlacard.jpg","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/CopperRockfishPlacard.jpg"]),
            textureTransform=TextureTransform(scale=(1,2))),
          geometry=IndexedFaceSet(coordIndex=[0,1,2,3,0,-1],
            coord=Coordinate(point=[(-2,-1,0),(2,-1,0),(2,1,0),(-2,1,0)])))]),
      Group(
        children=[
        Transform(DEF='BUTTON_TRANSFORM',translation=(1.0,2.0,0.0),
          children=[
          Shape(
            appearance=Appearance(
              material=Material(diffuseColor=(0.0,1.0,0.0))),
            geometry=Sphere(radius=0.5))]),
        TouchSensor(DEF='FrontTouchSensor',description='touch to rotate'),
        TimeSensor(DEF='FRONTTOUCHSENSORCLOCK',cycleInterval=2.0),
        OrientationInterpolator(DEF='PlaqueToPictureInterpolator',key=[0.0,0.5,1.0],keyValue=[(0.0,1.0,0.0,3.14),(0.0,1.0,0.0,1.57),(0.0,1.0,0.0,0.0)])]),
      Group(
        children=[
        Transform(DEF='BUTTON_TRANSFORM2',translation=(-1.0,2.0,0.0),
          children=[
          Shape(
            appearance=Appearance(
              material=Material(diffuseColor=(1.0,0.0,0.0))),
            geometry=Sphere(radius=0.5))]),
        TouchSensor(DEF='PictureTouchSensor',description='touch to rotate')]),
      Group(
        children=[
        Transform(DEF='BASE_TRANSFORM',translation=(0.0,0.0,-0.3),
          children=[
          Shape(
            appearance=Appearance(
              material=Material(diffuseColor=(0.3,0.3,0.6))),
            geometry=Box(size=(8.0,6.0,0.3)))]),
        Group(
          children=[
          Transform(translation=(0.0,-2.6,0.0),
            children=[
            Shape(
              appearance=Appearance(
                material=Material(diffuseColor=(0.8,0.8,0.2))),
              geometry=Box(size=(8.0,1.0,1.0)))])]),
        Group(
          children=[
          Transform(translation=(0.0,2.6,0.0),
            children=[
            Shape(
              appearance=Appearance(
                material=Material(diffuseColor=(0.8,0.8,0.2))),
              geometry=Box(size=(8.0,1.0,1.0)))])]),
        Group(
          children=[
          Transform(rotation=(0.0,0.0,1.0,1.58),translation=(3.6,0.0,0.0),
            children=[
            Shape(
              appearance=Appearance(
                material=Material(diffuseColor=(0.8,0.8,0.2))),
              geometry=Box(size=(6.2,1.0,1.0)))])]),
        Group(
          children=[
          Transform(rotation=(0.0,0.0,1.0,1.58),translation=(-3.6,0.0,0.0),
            children=[
            Shape(
              appearance=Appearance(
                material=Material(diffuseColor=(0.8,0.8,0.2))),
              geometry=Box(size=(6.2,1.0,1.0)))])])])]),
    ROUTE(fromField='touchTime',fromNode='BlueRockfishTouchSensor',toField='set_startTime',toNode='BLUEROCKFISHCLOCK'),
    ROUTE(fromField='fraction_changed',fromNode='BLUEROCKFISHCLOCK',toField='set_fraction',toNode='BlueRockfishPathInterpolator'),
    ROUTE(fromField='value_changed',fromNode='BlueRockfishPathInterpolator',toField='set_rotation',toNode='BLUEROCKFISH_TRANSFORM'),
    ROUTE(fromField='touchTime',fromNode='FrontTouchSensor',toField='set_startTime',toNode='FRONTTOUCHSENSORCLOCK'),
    ROUTE(fromField='fraction_changed',fromNode='FRONTTOUCHSENSORCLOCK',toField='set_fraction',toNode='PlaqueToPictureInterpolator'),
    ROUTE(fromField='value_changed',fromNode='PlaqueToPictureInterpolator',toField='set_rotation',toNode='BLUEROCKFISH_TRANSFORM'),
    ROUTE(fromField='touchTime',fromNode='PictureTouchSensor',toField='set_startTime',toNode='BLUEROCKFISHCLOCK')])
)

### X3D model conversion complete ###

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

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