####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python HelloPortugal.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='4.0',
  head=head(
    children=[
    meta(content='HelloPortugal.x3d',name='title'),
    meta(content='HelloPortugal example scene to show Portuguese special characters, built for Web3D 2024 Conference Tutorial.',name='description'),
    meta(content='Don Brutzman',name='creator'),
    meta(content='24 September 2024',name='created'),
    meta(content='28 December 2024',name='modified'),
    meta(content='Hello World, Portugal',name='subject'),
    meta(content='https://en.wikipedia.org/wiki/Portugal',name='reference'),
    meta(content='https://en.wikipedia.org/wiki/Portugal#/media/File:Flag_of_Portugal.svg',name='Image'),
    meta(content='https://upload.wikimedia.org/wikipedia/commons/thumb/5/5c/Flag_of_Portugal.svg/600px-Flag_of_Portugal.svg.png',name='Image'),
    meta(content='images/HelloPortugalCastleModelViewer.png',name='Image'),
    meta(content='images/HelloPortugalFreeWRL.png',name='Image'),
    meta(content='images/HelloPortugalH3DViewer.png',name='Image'),
    meta(content='images/HelloPortugalInstantReality.png',name='Image'),
    meta(content='images/HelloPortugalOctaga.png',name='Image'),
    meta(content='Completed https://github.com/castle-engine/view3dscene/issues/30#issuecomment-630715046',name='reference'),
    meta(content='images/HelloPortugalXj3d.png',name='Image'),
    meta(content='images/HelloPortugalX_ITE.png',name='Image'),
    meta(content='images/HelloPortugalX_ITE-FlagRotating.png',name='Image'),
    meta(content='images/HelloPortugalX_ITEPlayground.png',name='Image'),
    meta(content='images/HelloPortugalX3DOM.png',name='Image'),
    meta(content='images/HelloPortugalX3DOMEditor.png',name='Image'),
    meta(content='https://www.w3.org/International',name='reference'),
    meta(content='https://de.wikipedia.org/wiki/Liste_von_Hallo-Welt-Programmen/H%C3%B6here_Programmiersprachen',name='reference'),
    meta(content='https://en.wikipedia.org/wiki/Percent-encoding',name='reference'),
    meta(content='https://helloworldcollection.de/#VRML',name='reference'),
    meta(content='https://en.wiktionary.org/wiki/Hello_World',name='reference'),
    meta(content='https://en.wikipedia.org/wiki/%22Hello,%20World!%22_program',name='reference'),
    meta(content='https://en.wikibooks.org/w/index.php?title=Computer_Programming/Hello_world',name='reference'),
    meta(content='https://www.youtube.com/channel/UCSOnGlgAFxkWg8ilg-JEbAQ',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/HelloWorldScenes/HelloPortugal.x3d',name='identifier'),
    meta(content='X3D-Edit 4.0, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='../license.html',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(title='HelloPortugal.x3d'),
    Background(skyColor=[(1,0.84,0.26)]),
    NavigationInfo(type=["EXAMINE","LOOKAT","ANY"]),
    Viewpoint(DEF='ViewpointEntry',description='Olá Portugal! Divirta-se com o X3D!'),
    Viewpoint(DEF='ViewpointRotation',description='rotate the flag'),
    Anchor(description='Wikipedia: Tourism in Portugal',url=["https://en.wikipedia.org/wiki/Tourism_in_Portugal"],
      children=[
      Transform(translation=(0,-2,0),
        children=[
        Transform(translation=(0,4.8,0),
          children=[
          Shape(DEF='OlaShape',
            geometry=Text(string=["Olá Portugal!"],
              #  https://translate.google.com/?sl=auto&tl=pt-PT&text=Hello%20Portugal!&op=translate 
              fontStyle=FontStyle(DEF='CenteredFontStyle',justify=["MIDDLE","MIDDLE"])),
            appearance=Appearance(DEF='BlackAppearance',
              material=Material(diffuseColor=(0.01,0.4,0.01))))]),
        Shape(
          geometry=Text(string=["Divirta-se com o X3D!","Have fun with X3D!"],
            fontStyle=FontStyle(USE='CenteredFontStyle')),
          appearance=Appearance(USE='BlackAppearance')),
        Transform(DEF='PortugueseFlagTransform',scale=(0.8,0.8,0.8),translation=(0,2.6,0),
          children=[
          Shape(
            #  image is 600px x 400px 
            geometry=Box(size=(6,4,0.01)),
            appearance=Appearance(
              material=Material(),
              #  https://upload.wikimedia.org/wikipedia/commons/thumb/5/5c/Flag_of_Portugal.svg/600px-Flag_of_Portugal.svg.png 
              #  although not specified by X3D 4.0, SVG is an allowable format and so it can be included in the list 
              texture=ImageTexture(DEF='FlagOfPortugalImage',description='Flag of Portugal',url=["Flag_of_Portugal.svg","Flag_of_Portugal.svg.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/HelloWorldScenes/Flag_of_Portugal.svg","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/HelloWorldScenes/Flag_of_Portugal.svg.png"])))])])]),
    OrientationInterpolator(DEF='SpinInterpolator',key=[0,0.3333,0.6667,1],keyValue=[(0,1,0,0),(0,1,0,2.094395),(0,1,0,4.18879),(0,1,0,0)]),
    TimeSensor(DEF='SpinClock',cycleInterval=4,enabled=False,loop=True),
    ROUTE(fromField='isBound',fromNode='ViewpointRotation',toField='enabled',toNode='SpinClock'),
    ROUTE(fromField='fraction_changed',fromNode='SpinClock',toField='set_fraction',toNode='SpinInterpolator'),
    ROUTE(fromField='value_changed',fromNode='SpinInterpolator',toField='set_rotation',toNode='PortugueseFlagTransform')])
) # X3D model complete

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

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