####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python BeamHemisphereExample.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='3.3',
  head=head(
    children=[
    meta(content='BeamHemisphereExample.x3d',name='title'),
    meta(content='Don Brutzman',name='creator'),
    meta(content='29 January 2003',name='created'),
    meta(content='20 October 2019',name='modified'),
    meta(content='Produce wireframe or transparent beam hemispheres.',name='description'),
    meta(content='https://savage.nps.edu/Savage/CommunicationsAndSensors/Beam/BeamHemisphereExample.x3d',name='identifier'),
    meta(content='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit',name='generator'),
    meta(content='../../license.html',name='license')]),
  Scene=Scene(
    children=[
    Background(groundAngle=[1.57079],groundColor=[(0,0.15,0.25),(0,0.15,0.25)],skyColor=[(0,0.3,0.5)]),
    WorldInfo(info=["Produce wireframe or transparent beam hemisphere"],title='BeamHemispherePrototype'),
    Viewpoint(description='BeamHemisphere example'),
    Viewpoint(description='BeamHemisphere example from above',orientation=(1,0,0,-1.570796),position=(0,10,0)),
    ExternProtoDeclare(appinfo='Produce wireframe or transparent beam hemisphere. Typical uses include sonar/radar/light beams. Negative range values invert base and apex at same relative location. Default: hemisphere with centroid at (0 0 0) and radius 1 atop x-z plane.',name='BeamHemisphere',url=["BeamHemispherePrototype.x3d#BeamHemisphere","https://savage.nps.edu/Savage/CommunicationsAndSensors/Beam/BeamHemispherePrototype.x3d#BeamHemisphere","BeamHemispherePrototype.wrl#BeamHemisphere","https://savage.nps.edu/Savage/CommunicationsAndSensors/Beam/BeamHemispherePrototype.wrl#BeamHemisphere"],
      field=[
      field(accessType='initializeOnly',appinfo='Assigning a name to a BeamHemisphere aids tracing',name='name',type='SFString'),
      field(accessType='inputOnly',appinfo='(communications) is transmitted signal in contact with receiver or (sensor) is a target return detected?',name='contact',type='SFBool'),
      field(accessType='inputOnly',appinfo='distance in meters along x axis',name='range',type='SFFloat'),
      field(accessType='initializeOnly',appinfo='distance in meters used until eventIn range sent',name='defaultRange',type='SFFloat'),
      field(accessType='initializeOnly',appinfo='whether wireframe beam is drawn',name='wireframe',type='SFBool'),
      field(accessType='initializeOnly',appinfo='whether solid beam is drawn',name='solid',type='SFBool'),
      field(accessType='initializeOnly',appinfo='rendering color when contact=true',name='contactColor',type='SFColor'),
      field(accessType='initializeOnly',appinfo='rendering color when contact=false',name='noContactColor',type='SFColor'),
      field(accessType='inputOutput',appinfo='1 = fully transparent wireframe only',name='transparency',type='SFFloat')]),
    #  Viewable geometry for this scene 
    Group(
      children=[
      ProtoInstance(DEF='BeamHemisphereInstance',name='BeamHemisphere',
        fieldValue=[
        fieldValue(name='name',value='BeamHemisphereInstance'),
        fieldValue(name='defaultRange',value=10),
        fieldValue(name='transparency',value=0.2),
        fieldValue(name='wireframe',value=True),
        fieldValue(name='solid',value=True)]),
      Transform(translation=(0,-3,0),
        children=[
        Billboard(
          children=[
          Shape(
            appearance=Appearance(
              material=Material(diffuseColor=(.8,.8,0))),
            geometry=Text(string=["touch text to toggle contact-mode rendering"],
              fontStyle=FontStyle(justify=["MIDDLE","MIDDLE"],size=0.6))),
          Shape(
            #  transparent Box as text-selection assist 
            geometry=Box(size=(9,1,.001)),
            appearance=Appearance(
              material=Material(transparency=1))),
          TouchSensor(DEF='TextTouch',description='Hover over text to activate contact mode'),
          ROUTE(fromField='isOver',fromNode='TextTouch',toField='contact',toNode='BeamHemisphereInstance')])])]),
    Group(DEF='AnimationGroup',
      children=[
      TimeSensor(DEF='Clock',cycleInterval=10,loop=True),
      ScalarInterpolator(DEF='RangeInterpolator',key=[0,.4,.4,.5,.5,.9,.9,1],keyValue=[0.01,4,0,0,-0.01,-4,0,0]),
      ROUTE(fromField='fraction_changed',fromNode='Clock',toField='set_fraction',toNode='RangeInterpolator'),
      ROUTE(fromField='value_changed',fromNode='RangeInterpolator',toField='range',toNode='BeamHemisphereInstance'),
      #  ========== 
      ScalarInterpolator(DEF='TransparencyInterpolator',key=[0,.4,.4,.5,.5,.9,.9,1],keyValue=[0,1,1,1,0,1,1,1]),
      ROUTE(fromField='fraction_changed',fromNode='Clock',toField='set_fraction',toNode='TransparencyInterpolator'),
      ROUTE(fromField='value_changed',fromNode='TransparencyInterpolator',toField='transparency',toNode='BeamHemisphereInstance')])])
) # X3D model complete

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

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