####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python X3dMeshDesignPattern.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='Interchange',version='4.0',
  head=head(
    children=[
    component(level=1,name='Text'),
    component(level=2,name='Grouping'),
    component(level=3,name='Navigation'),
    meta(content='X3dMeshDesignPattern.x3d',name='title'),
    meta(content='Candidate design pattern for 3D scanner outputs to consistently define the elements of an X3D mesh.',name='description'),
    meta(content='Don Brutzman, Vince Marchetti, Roy Walmsley, Nicholas Polys',name='creator'),
    meta(content='4 June 2017',name='created'),
    meta(content='13 October 2023',name='modified'),
    meta(content='Upgrade and verify X3D v4.0 XML DTD and Schema to validate',name='TODO'),
    meta(content='X3dMeshDesignPattern.txt',name='reference'),
    meta(content='X3dMeshDesignPattern.png',name='Image'),
    meta(content='Under development. Note that proposed design pattern for Normal inside PointSet or LineSet/IndexedLineSet is accepted in X3D 4.0 but is not allowed in X3D v3.3.',name='warning'),
    meta(content='Web3D 2017 Workshop on 3D Scanning: Use Cases, Workflow and Profile Requirements for X3D',name='reference'),
    meta(content='http://web3d2017.web3d.org/program',name='reference'),
    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/X3dForAdvancedModeling/Scanning/X3dMeshDesignPattern.x3d',name='identifier'),
    meta(content='../license.html',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(title='X3dMeshDesignPattern.x3d'),
    Group(
      metadata=MetadataSet(name='X3dMesh',
        #  enter other Metadata nodes and values here, vocabulary TBD 
        ),
      children=[
      Switch(whichChoice=2,
        children=[
        Shape(
          geometry=PointSet(
            #  Currently invalid in X3D DTD: Normal node must be first to be allowed inside IndexedLineSet or LineSet 
            #  Of note: MeshLab allows assigning normals to a point cloud 
            normal=Normal(DEF='VertexNormals'),
            color=Color(DEF='VertexColors',color=[(1,0,0),(0,1,0),(0,0,1),(1,1,1)]),
            coord=Coordinate(DEF='VertexValues',point=[(1,1,0),(1,-1,0),(-1,-1,0),(-1,1,0)]),
            #  Currently invalid in X3D v3.3: Normal node not allowed inside PointSet 
            )),
        Shape(
          geometry=IndexedLineSet(coordIndex=[0,1,2,3,0,-1],
            #  Currently invalid in X3D DTD: Normal node must be first to be allowed inside IndexedLineSet or LineSet 
            normal=Normal(USE='VertexNormals'),
            coord=Coordinate(USE='VertexValues'),
            color=Color(USE='VertexColors'))),
        Shape(
          geometry=IndexedFaceSet(coordIndex=[0,1,2,3,0,-1],solid=False,
            coord=Coordinate(USE='VertexValues'),
            color=Color(USE='VertexColors'),
            normal=Normal(USE='VertexNormals')))]),
      ViewpointGroup(description='Viewpoints at appropriate distance from model',
        children=[
        Viewpoint(description='Front view',position=(0,0,4))])]),
    #  Default scene display 
    Background(skyColor=[(1,1,1)]),
    Transform(DEF='AvoidCoplanarAliasing',translation=(0,0,0.1),
      children=[
      Shape(
        geometry=Text(string=["X3D","Mesh","Design","Pattern"],
          fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],size=0.4,style_='BOLD')),
        appearance=Appearance(
          material=Material(diffuseColor=(0.3,0.7,0.7))))])])
) # X3D model complete

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

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