####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python MetadataRootNodeTest.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='MetadataRootNodeTest.x3d',name='title'),
    meta(content='The MetadataSet node is allowed as a root node in X3D4, following development and evaluation of examples considered in this demonstration scene. Original inquiry: is a Metadata node legal as the root node in a scene? X3D model metadata sets need to be portable since they might be saved and reused via multiple files.',name='description'),
    meta(content='Don Brutzman and X3D Working Group',name='creator'),
    meta(content='8 December 2016',name='created'),
    meta(content='31 August 2024',name='modified'),
    meta(content='X3D 4.0 Architecture, ISO/IEC 19775-1:2023, clause 4 Concepts, 4.3.2 Root nodes',name='specificationSection'),
    meta(content='https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#Rootnodes',name='specificationUrl'),
    meta(content='http://web3d.org/pipermail/x3d-public_web3d.org/2016-December/005680.html',name='reference'),
    meta(content='X3D Specification Mantis Issue (member access required) https://www.web3d.org/member-only/mantis/view.php?id=1092',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/AdditiveManufacturing/MetadataRootNodeTest.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=[
    Comment('============================='),
    Comment('Option 1: root node of scene'),
    MetadataSet(DEF='MetadataHolderOption1',name='MetadataCollection1',
      # can enter other Metadata nodes here
),
    Background(skyColor=[(0.498,1,0.8314)]),
    Comment('============================='),
    Comment('Option 2: contained within WorldInfo, though direct translation to VRML97 is not valid'),
    WorldInfo(DEF='MetadataHolderOption2',title='Test scene for containing X3D Metadata* nodes, with no other content',
      metadata=MetadataSet(name='MetadataCollection2',
        # can enter other Metadata nodes here
)),
    Comment('============================='),
    Comment('Option 3: contained within top-level Group, scope for all contained nodes is unambiguous'),
    Group(DEF='MetadataHolderOption3',
      metadata=MetadataSet(name='MetadataCollection3',
        # can enter other Metadata nodes here
)),
    Comment('============================='),
    Comment('Viewing a Mantis issue first requires Web3D Consortium member login'),
    Anchor(description='Web3D Consortium members can select text to view Mantis issue 1092',parameter=["target=blank"],url=["https://www.web3d.org/member-only/mantis/view.php?id=1092"],
      children=[
      Comment('Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip'),
      Group(
        children=[
        Shape(
          geometry=Text(string=["Metadata nodes","tested as children","of scene root","(mantis issue 1092)"],
            fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],style_='BOLD')),
          appearance=Appearance(
            material=Material(diffuseColor=(0,0.502,0.1098)))),
        Shape(
          # Author adjustment: resize transparent Box as text-selection assist, set width and height to match size, then set transparency='1' to make invisible.

          geometry=Box(size=(8,4,0.001)),
          appearance=Appearance(
            material=Material(transparency=1)))])])])
)

### X3D model conversion complete ###

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

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