####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python X3D4PhysicallyBasedRenderingTests.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=[
    component(level=3,name='EnvironmentalEffects'),
    component(level=3,name='Shape'),
    meta(content='X3D4PhysicallyBasedRenderingTests.x3d',name='title'),
    meta(content='Test X3D version 4 nodes supporting Physically Based Rendering.',name='description'),
    meta(content='3 September 2025',name='created'),
    meta(content='4 September 2025',name='modified'),
    meta(content='Don Brutzman',name='creator'),
    meta(content='This model is under development and will be used to support X3D-Edit testing.',name='TODO'),
    meta(content='X3D 4.1 Architecture, ISO/IEC 19775-1:202x draft, clause 12 Shape Component',name='specificationSection'),
    meta(content='https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4.1-CD/Part01/components/shape.html',name='specificationUrl'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/TextureMapping/X3D4PhysicallyBasedRenderingTests.x3d',name='identifier'),
    meta(content='X3D-Edit 4.0, https://savage.nps.edu/X3D-Edit',name='generator'),
    meta(content='https://www.web3d.org/x3d/content/examples/license.html',name='license')]),
  Scene=Scene(
    #  Example scene to illustrate X3D nodes and fields (XML elements and attributes) 
    children=[
    WorldInfo(title='X3D4PhysicallyBasedRenderingTests.x3d'),
    NavigationInfo(),
    Viewpoint(DEF='WelcomeView',description='Test model for nodes, containerField relationships',position=(0,0,8)),
    TextureBackground(
      backTexture=ImageTexture(DEF='TestImage',description='test texture',url=["images/imageSmallSolidGreyBackground.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/TextureMapping/images/imageSmallSolidGreyBackground.png"]),
      frontTexture=ImageTexture(USE='TestImage'),
      leftTexture=ImageTexture(USE='TestImage'),
      rightTexture=ImageTexture(USE='TestImage'),
      topTexture=ImageTexture(USE='TestImage'),
      bottomTexture=ImageTexture(USE='TestImage')),
    Transform(translation=(-3,0,0),
      children=[
      Shape(
        geometry=Text(DEF='MaterialText',string=["Material"],
          fontStyle=FontStyle(DEF='ConsistentFont',justify=["MIDDLE","MIDDLE"],size=0.4)),
        appearance=Appearance(
          #  default containerField='material' 
          material=Material(DEF='FrontMaterialDefaultContainerField'),
          Material(DEF='BackMaterial')
          texture=ImageTexture(DEF='EarthTexture',description='unclouded earth',url=["images/earth-topo.png","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/TextureMapping/images/earth-topo.png"])))]),
    Transform(
      children=[
      Shape(
        geometry=Text(DEF='PhysicalMaterialText',string=["Physical","Material"],
          fontStyle=FontStyle(USE='ConsistentFont')),
        appearance=Appearance(
          #  default containerField='material' 
          material=PhysicalMaterial(
            baseTexture=ImageTexture(USE='EarthTexture'),
            emissiveTexture=ImageTexture(USE='EarthTexture'),
            metallicRoughnessTexture=ImageTexture(USE='EarthTexture'),
            normalTexture=ImageTexture(USE='EarthTexture'),
            occlusionTexture=ImageTexture(USE='EarthTexture')),
          PhysicalMaterial(),))]),
    Transform(translation=(3,0,0),
      children=[
      Shape(
        geometry=Text(DEF='UnlitMaterialText',string=["Unlit","Material"],
          fontStyle=FontStyle(USE='ConsistentFont')),
        appearance=Appearance(
          #  default containerField='material' 
          material=UnlitMaterial(emissiveColor=(1,1,1),normalScale=0,
            emissiveTexture=ImageTexture(USE='EarthTexture'),
            normalTexture=ImageTexture(USE='EarthTexture')),
          UnlitMaterial(emissiveColor=(1,1,1),normalScale=0)))]),
    Transform(translation=(0,-2,0),
      children=[
      Shape(
        geometry=Text(DEF='TwoSidedMaterialText',string=["TwoSidedMaterial","(deprecated)"],
          fontStyle=FontStyle(USE='ConsistentFont')),
        appearance=Appearance(
          material=TwoSidedMaterial(),))])])
) # X3D model complete

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

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