####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python ProximitySensorNoOverlap.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='ProximitySensorNoOverlap.x3d',name='title'),
    meta(content='Example ProximitySensor regions',name='description'),
    meta(content='Leonard Daly and Don Brutzman',name='creator'),
    meta(content='15 July 2006',name='created'),
    meta(content='20 October 2019',name='modified'),
    meta(content='ProximitySensorMultiple.x3d',name='reference'),
    meta(content='ProximitySensorOverlap.x3d',name='reference'),
    meta(content='ProximitySensorSingle.x3d',name='reference'),
    meta(content='https://X3dGraphics.com',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dResources.html',name='reference'),
    meta(content='Copyright Don Brutzman and Leonard Daly 2007',name='rights'),
    meta(content='X3D book, X3D graphics, X3D-Edit, http://www.x3dGraphics.com',name='subject'),
    meta(content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter12EnvironmentSensorSound/ProximitySensorNoOverlap.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=[
    WorldInfo(title='ProximitySensorNoOverlap.x3d'),
    ExternProtoDeclare(name='WhereAmI',url=["../Chapter14Prototypes/WhereAmIPrototype.x3d#WhereAmI","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/WhereAmIPrototype.x3d#WhereAmI","../Chapter14Prototypes/WhereAmIPrototype.wrl#WhereAmI","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/WhereAmI.wrl#WhereAmI"]),
    ProtoInstance(name='WhereAmI'),
    Viewpoint(description='Book Viewpoint',orientation=(0,1,0,-0.06),position=(0.05,0,8.71)),
    NavigationInfo(avatarSize=[0.05,1.6,0.75],type=["WALK","ANY"]),
    Background(skyColor=[(1,1,1)]),
    Collision(enabled=False,
      children=[
      Transform(DEF='SensorGroup',
        children=[
        Viewpoint(description='Inside proximity box 1',orientation=(0,1,0,-0.78),position=(0,0,0.5)),
        ProximitySensor(DEF='HereIAm1',size=(2,2,2)),
        Transform(DEF='SensorSize',
          children=[
          Shape(DEF='BoxOutline',
            appearance=Appearance(
              material=Material(emissiveColor=(0.8,0.8,0.8))),
            geometry=IndexedLineSet(coordIndex=[0,1,2,3,0,-1,4,5,6,7,4,-1,0,4,-1,1,5,-1,2,6,-1,3,7,-1],
              coord=Coordinate(point=[(1,1,1),(1,1,-1),(1,-1,-1),(1,-1,1),(-1,1,1),(-1,1,-1),(-1,-1,-1),(-1,-1,1)]))),
          Shape(DEF='BoxSurface',
            appearance=Appearance(
              material=Material(diffuseColor=(1,.5,0),transparency=.8)),
            geometry=Box(),)])])]),
    Collision(enabled=False,
      children=[
      Transform(rotation=(.707,.707,0,1),translation=(3,1,2),
        children=[
        Viewpoint(description='Inside proximity box 2',orientation=(0,1,0,-0.78),position=(0,0,0.5)),
        ProximitySensor(USE='HereIAm1'),
        Transform(USE='SensorSize')])]),
    Collision(enabled=False,
      children=[
      Transform(translation=(-1,.5,-2.1),
        children=[
        Viewpoint(description='Inside proximity box 3',orientation=(0,1,0,-0.78),position=(0,0,0.5)),
        ProximitySensor(USE='HereIAm1'),
        Transform(USE='SensorSize')])]),
    Collision(enabled=False,
      children=[
      Transform(translation=(-2.5,-1,1.5),
        children=[
        Viewpoint(description='Inside proximity box 4',orientation=(0,1,0,-0.78),position=(0,0,0.5)),
        ProximitySensor(USE='HereIAm1'),
        Transform(USE='SensorSize')])]),
    Script(DEF='LocationReport',url=["ProximitySensorSingleScriptLocationReport.js","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter12EnvironmentSensorSound/ProximitySensorSingleScriptLocationReport.js"],
      field=[
      field(accessType='inputOnly',name='position',type='SFVec3f'),
      field(accessType='inputOnly',name='orientation',type='SFRotation')],

    sourceCode="""
ecmascript:

"""),
    ROUTE(fromField='position_changed',fromNode='HereIAm1',toField='position',toNode='LocationReport'),
    ROUTE(fromField='orientation_changed',fromNode='HereIAm1',toField='orientation',toNode='LocationReport')])
)

### X3D model conversion complete ###

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

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