####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python VisibleShapesTest.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='4.0',
  head=head(
    children=[
    meta(content='VisibleShapesTest.x3d',name='title'),
    meta(content='Test scene with BooleanSequencer animation of visible field on several X3DBoundedObject nodes, triggering a new feature in X3D4.',name='description'),
    meta(content='18 January 2020',name='created'),
    meta(content='1 June 2024',name='modified'),
    meta(content='Don Brutzman',name='creator'),
    meta(content='X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 10 Grouping component, 10.3.1 X3DBoundedObject',name='specificationSection'),
    meta(content='https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject',name='specificationUrl'),
    meta(content='X3D 4.0 Architecture, ISO/IEC 19775-1:2023, 12 Shape component, 12.3.5 X3DShapeNode',name='specificationSection'),
    meta(content='https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html#X3DShapeNode',name='specificationUrl'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Animation/VisibleShapesTest.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='VisibleShapesTest.x3d'),
    Viewpoint(DEF='EntryView',description='Visible Shapes Test',position=(0,0,12)),
    Transform(DEF='BoxGroupingNode',translation=(-3,1.5,0),
      children=[
      Shape(DEF='BoxShape',
        geometry=Box(),
        appearance=Appearance(
          material=Material(DEF='Red',diffuseColor=(1,0,0)))),
      Transform(translation=(0,-2,0),
        children=[
        Shape(DEF='BoxVisibleText',
          geometry=Text(string=["Box visible"],
            fontStyle=FontStyle(DEF='TextStyle',family=["SANS"],justify=["MIDDLE","MIDDLE"],style_='BOLD')),
          appearance=Appearance(
            material=Material(USE='Red')))]),
      BooleanSequencer(DEF='Pulsar1',key=[0,0.25,0.5,0.75,1],keyValue=[True,False,True,True,True]),
      ROUTE(fromField='value_changed',fromNode='Pulsar1',toField='visible',toNode='BoxGroupingNode')]),
    Transform(DEF='SphereGroupingNode',translation=(0,1.5,0),
      children=[
      Shape(DEF='SphereShape',
        geometry=Sphere(),
        appearance=Appearance(
          material=Material(DEF='Green',diffuseColor=(0,1,0)))),
      Transform(translation=(0,-3,0),
        children=[
        Shape(DEF='SphereVisibleText',
          geometry=Text(string=["Sphere visible"],
            fontStyle=FontStyle(USE='TextStyle')),
          appearance=Appearance(
            material=Material(USE='Green')))]),
      BooleanSequencer(DEF='Pulsar2',key=[0,0.25,0.5,0.75,1],keyValue=[True,True,False,True,True]),
      ROUTE(fromField='value_changed',fromNode='Pulsar2',toField='visible',toNode='SphereShape'),
      ROUTE(fromField='value_changed',fromNode='Pulsar2',toField='visible',toNode='SphereVisibleText')]),
    Transform(DEF='CylinderGroupingNode',translation=(3,1.5,0),
      children=[
      Shape(DEF='CylinderShape',
        geometry=Cylinder(),
        appearance=Appearance(
          material=Material(DEF='Blue',diffuseColor=(0.4,0.4,1)))),
      Transform(translation=(0,-4,0),
        children=[
        Shape(DEF='CylinderVisibleText',
          geometry=Text(string=["Cylinder visible"],
            fontStyle=FontStyle(USE='TextStyle')),
          appearance=Appearance(
            material=Material(USE='Blue')))]),
      BooleanSequencer(DEF='Pulsar3',key=[0,0.25,0.5,0.75,1],keyValue=[True,True,True,False,True]),
      ROUTE(fromField='value_changed',fromNode='Pulsar3',toField='visible',toNode='CylinderShape'),
      ROUTE(fromField='value_changed',fromNode='Pulsar3',toField='visible',toNode='CylinderVisibleText')]),
    TimeSensor(DEF='SequencerClock',cycleInterval=8,loop=True),
    ROUTE(fromField='fraction_changed',fromNode='SequencerClock',toField='set_fraction',toNode='Pulsar1'),
    ROUTE(fromField='fraction_changed',fromNode='SequencerClock',toField='set_fraction',toNode='Pulsar2'),
    ROUTE(fromField='fraction_changed',fromNode='SequencerClock',toField='set_fraction',toNode='Pulsar3')])
)

### X3D model conversion complete ###

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

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