####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python MobiusExtrusion.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='MobiusExtrusion.x3d',name='title'),
    meta(content='Mobius (or Mobius) is a surface with only one side and only one boundary component.',name='description'),
    meta(content='Don Brutzman',name='creator'),
    meta(content='14 January 2012',name='created'),
    meta(content='20 October 2019',name='modified'),
    meta(content='MobiusStrip-01.png',name='Image'),
    meta(content='MobiusExtrusionsInternalLighting.png',name='Image'),
    meta(content='properly handle special characters in "Möbius" during catalog creation',name='TODO'),
    meta(content='https://en.wikipedia.org/wiki/M%C3%B6bius_strip',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/Basic/NURBS/MobiusNurbs.x3d',name='reference'),
    meta(content='Mobius strip modeled with Extrusion',name='subject'),
    meta(content='Development of this scene added new features to X3D-Edit',name='info'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dResources.html',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/GeometricShapes/MobiusExtrusion.x3d',name='identifier'),
    meta(content='X3D-Edit 3.3, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='../license.html',name='license')]),
  Scene=Scene(
    children=[
    Comment('TODO clockwise or counterclockwise'),
    WorldInfo(title='MobiusExtrusion.x3d'),
    Background(skyColor=[(0,0.6784314,0.8)]),
    Viewpoint(description='Mobius strip extrusion, plus cross-sectional view',orientation=(1,0,0,-0.46365),position=(0,5,10)),
    Viewpoint(description='Mobius strip from above',orientation=(1,0,0,-1.5707999),position=(0,10,0)),
    Viewpoint(description='Mobius strip from side'),
    Transform(DEF='MobiusStrip',scale=(2,2,2),translation=(-3,2,0),
      children=[
      PointLight(DEF='InteriorLight',global_=False),
      Shape(
        geometry=Extrusion(creaseAngle=0.7854,crossSection=[(-0.2,-0.1),(0.2,-0.1),(0.2,0.1),(-0.2,0.1),(-0.2,-0.1)],orientation=[(0,1,0,-1.5707999),(0,1,0,-1.309),(0,1,0,-1.0472),(0,1,0,-0.7854),(0,1,0,-0.5236),(0,1,0,-0.2618),(0,1,0,0),(0,1,0,0.2618),(0,1,0,0.5236),(0,1,0,0.7854),(0,1,0,1.0472),(0,1,0,1.309),(0,1,0,1.5707999),(0,1,0,1.8326),(0,1,0,2.0943999),(0,1,0,2.3562),(0,1,0,2.618),(0,1,0,2.8798001),(0,1,0,3.1415999),(0,1,0,3.4033999),(0,1,0,3.6652),(0,1,0,3.927),(0,1,0,4.1887999),(0,1,0,4.4506001),(0,1,0,4.7124)],solid=False,spine=[(0,0,1),(0.259,0,0.966),(0.5,0,0.866),(0.707,0,0.707),(0.866,0,0.5),(0.966,0,0.259),(1,0,0),(0.966,0,-0.259),(0.866,0,-0.5),(0.707,0,-0.707),(0.5,0,-0.866),(0.259,0,-0.966),(0,0,-1),(-0.259,0,-0.966),(-0.5,0,-0.866),(-0.707,0,-0.707),(-0.866,0,-0.5),(-0.966,0,-0.259),(-1,0,-0),(-0.966,0,0.259),(-0.866,0,0.5),(-0.707,0,0.707),(-0.5,0,0.866),(-0.259,0,0.966),(0,0,1)]),
        # illustrated by follow-on ExtrusionCrossSection visualization

        appearance=Appearance(
          material=Material(diffuseColor=(0.4431373,0.1803922,1)),
          # TODO add ruled ImageTexture
))]),
    ExternProtoDeclare(appinfo='Shape prototype for Extrusion node that also draws spine line plus oriented scaled cross sections at each spine point',documentation='https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionCrossSectionPrototype.x3d',name='ExtrusionCrossSection',url=["../../Basic/course/ExtrusionCrossSectionPrototype.x3d#ExtrusionCrossSection","https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionCrossSectionPrototype.x3d#ExtrusionCrossSection"],
      field=[
      field(accessType='initializeOnly',appinfo='Extrusion name',name='name',type='SFString'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='crossSection',type='MFVec2f'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='spine',type='MFVec3f'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='scale',type='MFVec2f'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='orientation',type='MFRotation'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='beginCap',type='SFBool'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='endCap',type='SFBool'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='ccw',type='SFBool'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='convex',type='SFBool'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='creaseAngle',type='SFFloat'),
      field(accessType='initializeOnly',appinfo='Extrusion field',name='solid',type='SFBool'),
      field(accessType='inputOutput',appinfo='emissiveColor of spine',name='spineColor',type='SFColor'),
      field(accessType='inputOutput',appinfo='diffuseColor of crossSection',name='crossSectionColor',type='SFColor'),
      field(accessType='inputOutput',appinfo='transparency of crossSection',name='crossSectionTransparency',type='SFFloat'),
      field(accessType='inputOutput',appinfo='diffuseColor of extrusion hull',name='extrusionColor',type='SFColor'),
      field(accessType='inputOutput',appinfo='transparency of extrusion hull',name='extrusionTransparency',type='SFFloat'),
      field(accessType='initializeOnly',appinfo='Image to apply to Extrusion',name='extrusionImageTexture',type='SFNode'),
      field(accessType='initializeOnly',appinfo='TextureTransform coordinates of image applied to Extrusion',name='extrusionTextureTransform',type='SFNode'),
      field(accessType='inputOnly',appinfo='Extrusion field',name='set_crossSection',type='MFVec2f'),
      field(accessType='inputOnly',appinfo='Extrusion field',name='set_spine',type='MFVec3f'),
      field(accessType='inputOnly',appinfo='Extrusion field',name='set_scale',type='MFVec2f'),
      field(accessType='inputOnly',appinfo='Extrusion field',name='set_orientation',type='MFRotation'),
      field(accessType='initializeOnly',appinfo='Whether to provide initialization trace statements showing node construction',name='traceEnabled',type='SFBool')]),
    Transform(DEF='MobiusStripExploded',scale=(2,2,2),translation=(3,2,0),
      children=[
      PointLight(USE='InteriorLight'),
      Comment('===================='),
      Switch(whichChoice=0,
        children=[
        ProtoInstance(name='ExtrusionCrossSection',
          fieldValue=[
          fieldValue(name='name',value='MobiusStrip'),
          fieldValue(name='crossSection',value=[(-0.2,-0.1),(0.2,-0.1),(0.2,0.1),(-0.2,0.1),(-0.2,-0.1)]),
          fieldValue(name='spine',value=[(0,0,1),(0.259,0,0.966),(0.5,0,0.866),(0.707,0,0.707),(0.866,0,0.5),(0.966,0,0.259),(1,0,0),(0.966,0,-0.259),(0.866,0,-0.5),(0.707,0,-0.707),(0.5,0,-0.866),(0.259,0,-0.966),(0,0,-1),(-0.259,0,-0.966),(-0.5,0,-0.866),(-0.707,0,-0.707),(-0.866,0,-0.5),(-0.966,0,-0.259),(-1,0,-0),(-0.966,0,0.259),(-0.866,0,0.5),(-0.707,0,0.707),(-0.5,0,0.866),(-0.259,0,0.966),(0,0,1)]),
          fieldValue(name='scale',value=[(1,1)]),
          fieldValue(name='orientation',value=[(0,1,0,-1.5707999),(0,1,0,-1.309),(0,1,0,-1.0472),(0,1,0,-0.7854),(0,1,0,-0.5236),(0,1,0,-0.2618),(0,1,0,0),(0,1,0,0.2618),(0,1,0,0.5236),(0,1,0,0.7854),(0,1,0,1.0472),(0,1,0,1.309),(0,1,0,1.5707999),(0,1,0,1.8326),(0,1,0,2.0943999),(0,1,0,2.3562),(0,1,0,2.618),(0,1,0,2.8798001),(0,1,0,3.1415999),(0,1,0,3.4033999),(0,1,0,3.6652),(0,1,0,3.927),(0,1,0,4.1887999),(0,1,0,4.4506001),(0,1,0,4.7124)]),
          fieldValue(name='beginCap',value=True),
          fieldValue(name='endCap',value=True),
          fieldValue(name='ccw',value=True),
          fieldValue(name='convex',value=True),
          fieldValue(name='creaseAngle',value=0.524),
          fieldValue(name='solid',value=False),
          fieldValue(name='spineColor',value=(1,0.8,0.0)),
          fieldValue(name='crossSectionColor',value=(0.5,0.5,0.5)),
          fieldValue(name='crossSectionTransparency',value=0.26666668),
          fieldValue(name='extrusionColor',value=(0.8,0.6,0.0)),
          fieldValue(name='extrusionTransparency',value=0.8),
          fieldValue(name='traceEnabled',value=False)]),
        Comment('Add any ROUTEs here that connect ProtoInstance to/from prior nodes in Scene'),
        Comment('Example use: https://www.web3d.org/x3d/content/examples/Basic/course/ExtrusionCrossSectionExample.x3d'),],),
      Comment('===================='),],),
    Transform(DEF='UntwistedStrip',scale=(2,2,2),translation=(-3,-2,0),
      children=[
      PointLight(USE='InteriorLight'),
      Shape(
        geometry=Extrusion(creaseAngle=0.524,crossSection=[(-0.2,-0.1),(0.2,-0.1),(0.2,0.1),(-0.2,0.1),(-0.2,-0.1)],solid=False,spine=[(0,0,1),(0.259,0,0.966),(0.5,0,0.866),(0.707,0,0.707),(0.866,0,0.5),(0.966,0,0.259),(1,0,0),(0.966,0,-0.259),(0.866,0,-0.5),(0.707,0,-0.707),(0.5,0,-0.866),(0.259,0,-0.966),(0,0,-1),(-0.259,0,-0.966),(-0.5,0,-0.866),(-0.707,0,-0.707),(-0.866,0,-0.5),(-0.966,0,-0.259),(-1,0,-0),(-0.966,0,0.259),(-0.866,0,0.5),(-0.707,0,0.707),(-0.5,0,0.866),(-0.259,0,0.966),(0,0,1)]),
        # illustrated by follow-on ExtrusionCrossSection visualization

        appearance=Appearance(
          material=Material(diffuseColor=(0,0.1490196,0.9411765)),
          # TODO add ruled ImageTexture
))]),
    Transform(DEF='UntwistedStripExploded',scale=(2,2,2),translation=(3,-2,0),
      children=[
      PointLight(USE='InteriorLight'),
      ProtoInstance(name='ExtrusionCrossSection',
        fieldValue=[
        fieldValue(name='name',value='UntwistedStrip'),
        fieldValue(name='crossSection',value=[(-0.2,-0.1),(0.2,-0.1),(0.2,0.1),(-0.2,0.1),(-0.2,-0.1)]),
        fieldValue(name='spine',value=[(0,0,1),(0.259,0,0.966),(0.5,0,0.866),(0.707,0,0.707),(0.866,0,0.5),(0.966,0,0.259),(1,0,0),(0.966,0,-0.259),(0.866,0,-0.5),(0.707,0,-0.707),(0.5,0,-0.866),(0.259,0,-0.966),(0,0,-1),(-0.259,0,-0.966),(-0.5,0,-0.866),(-0.707,0,-0.707),(-0.866,0,-0.5),(-0.966,0,-0.259),(-1,0,-0),(-0.966,0,0.259),(-0.866,0,0.5),(-0.707,0,0.707),(-0.5,0,0.866),(-0.259,0,0.966),(0,0,1)]),
        fieldValue(name='scale',value=[(1,1)]),
        fieldValue(name='beginCap',value=True),
        fieldValue(name='endCap',value=True),
        fieldValue(name='ccw',value=True),
        fieldValue(name='convex',value=True),
        fieldValue(name='creaseAngle',value=0.524),
        fieldValue(name='solid',value=False),
        fieldValue(name='spineColor',value=(1,0.8,0.0)),
        fieldValue(name='crossSectionColor',value=(0,0.1490196,0.9411765)),
        fieldValue(name='crossSectionTransparency',value=0.26666668),
        fieldValue(name='extrusionColor',value=(0.8,0.6,0.0)),
        fieldValue(name='extrusionTransparency',value=0.8),
        fieldValue(name='traceEnabled',value=False)])])])
)

### X3D model conversion complete ###

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

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