####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python WorldInfoExampleMetadataSetX3D3.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=[
    meta(content='WorldInfoExampleMetadataSetX3D3.x3d',name='title'),
    meta(content='This X3D3 scene contains MetadataSet with a non-null metadata field and multiple value nodes. Also provides a test target for python x3d package development, can x3d.py package generate this valid X3D file?',name='description'),
    meta(content='Metadata nodes at root level of scene are not allowed in VRML97 or X3D3, but are allowed in X3D4.',name='info'),
    meta(content='Metadata node as WorldInfo metadata field are not allowed in VRML97, but are allowed in X3D3 or X3D4.',name='info'),
    meta(content='WorldInfoExampleMetadataSetX3D4.x3d',name='reference'),
    meta(content='Original name MetadataSetWithMetadata.x3d',name='info'),
    meta(content='Vincent Marchetti',name='creator'),
    meta(content='Don Brutzman',name='creator'),
    meta(content='16 November 2021',name='created'),
    meta(content='7 April 2024',name='modified'),
    meta(content='X3D encodings, ISO/IEC 19776-1, Part 1: XML encoding, Annex B.6.1 x3d-4.0.xsd',name='specificationSection'),
    meta(content='https://web3d.org/specifications/X3Dv4Draft/ISO-IEC19776-1v4.0-WD1/Part01/Schema.html#Version4.0Schema',name='specificationUrl'),
    meta(content='X3D-Edit 4.0, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.x3d',name='identifier'),
    meta(content='https://creativecommons.org/licenses/by/4.0',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(title='WorldInfoExampleMetadataSetX3D3.x3d Example Scene',
      # WorldInfo single available child field of interest is 'metadata' and so contained MetadataSet must have containerField='metadata' which IS the default in X3D3

      metadata=MetadataSet(name='birthday',reference='https://www.archives.gov/legislative/features/washington',
        # Next field is 'metadata' and so contained MetadataString node must have containerField='metadata' which is default in X3D3, but not the default in X3D4

        metadata=MetadataString(name='calendar',reference='this node describes nature of parent node, and is not intended as a data value',value=["Julian"]),
        # MetadataSet next fields of interest are 'value' and so contained Metadata nodes must have containerField='value' which is not the default in X3D3 but is the default in X3D4

        MetadataString(name='name',value=["George","Washington"]),
        MetadataInteger(name='day',value=[11]),
        MetadataInteger(name='month',value=[2]),
        MetadataInteger(name='year',value=[1731]),
        MetadataString(name='birthplace',value=["Popes Creek","Virginia"])])),
    Background(skyColor=[(0,0.439216,0.760784)]),
    Viewpoint(description='View scene source to see metadata examples',position=(0,0,12)),
    Anchor(description='Load scene index page',parameter=["target=_blank"],url=["WorldInfoExampleMetadataSetX3D3.html","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.html"],
      children=[
      Shape(
        geometry=Text(string=["View scene source","to see","WorldInfoExampleMetadataSetX3D3"],
          fontStyle=FontStyle(justify=["MIDDLE","MIDDLE"],size=0.9,spacing=1.5)),
        appearance=Appearance(
          material=Material(diffuseColor=(1,0.39216,0.992157))))])])
)

### X3D model conversion complete ###

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

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