####################################################################################################
#
# Invoking X3D model self-test:
#
#   $ python BollardHydraulicSecurityExample.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.1',
  head=head(
    children=[
    meta(content='BollardHydraulicSecurityExample.x3d',name='title'),
    meta(content='Rising/retractable security bollard: example use, showing multiple copies of a single triggered bollard.',name='description'),
    meta(content='Don Brutzman and MV4205 Advanced XML class',name='creator'),
    meta(content='5 September 2007',name='created'),
    meta(content='20 October 2019',name='modified'),
    meta(content="USE copies of the DEF'ed bollard are not animating. Shouldn't they?",name='warning'),
    meta(content='http://www.atgaccess.com',name='reference'),
    meta(content='BollardHydraulicSecurityPrototype.x3d',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/Savage/Buildings/SecurityPerimeter/BollardHydraulicSecurityPrototype.x3d',name='reference'),
    meta(content='https://www.web3d.org/x3d/content/examples/Savage/Buildings/SecurityPerimeter/BollardHydraulicSecurityExample.x3d',name='identifier'),
    meta(content='X3D-Edit 3.2, https://www.web3d.org/x3d/tools/X3D-Edit',name='generator'),
    meta(content='../../license.html',name='license')]),
  Scene=Scene(
    children=[
    WorldInfo(title='BollardHydraulicSecurityExample.x3d'),
    ExternProtoDeclare(appinfo='A security bollard can be raised or lowered to prevent vehicle access by blocking a road. Usually multiple bollards are installed side by side raised and lowered together.',name='BollardHydraulicSecurity',url=["BollardHydraulicSecurityPrototype.x3d#BollardHydraulicSecurity","../../../Savage/Buildings/SecurityPerimeter/BollardHydraulicSecurityPrototype.x3d#BollardHydraulicSecurity","https://www.web3d.org/x3d/content/examples/Savage/Buildings/SecurityPerimeter/BollardHydraulicSecurityPrototype.x3d#BollardHydraulicSecurity","BollardHydraulicSecurityPrototype.wrl#BollardHydraulicSecurity","../../../Savage/Buildings/SecurityPerimeter/BollardHydraulicSecurityPrototype.wrl#BollardHydraulicSecurity","https://www.web3d.org/x3d/content/examples/Savage/Buildings/SecurityPerimeter/BollardHydraulicSecurityPrototype.wrl#BollardHydraulicSecurity"],
      field=[
      field(accessType='initializeOnly',name='radius',type='SFFloat'),
      field(accessType='initializeOnly',name='height',type='SFFloat'),
      field(accessType='inputOutput',name='textureUrl',type='MFString'),
      field(accessType='inputOutput',name='diffuseColor',type='SFColor'),
      field(accessType='inputOnly',appinfo='Command to raise the bollard.',name='raise',type='SFBool'),
      field(accessType='inputOnly',appinfo='Command to lower the bollard.',name='lower',type='SFBool'),
      Comment('TODO: add TimeDelaySensor nodes to report completion by the following output fields'),
      field(accessType='outputOnly',appinfo='Notification event sent when bollard is fully raised.',name='isRaised',type='SFBool'),
      field(accessType='outputOnly',appinfo='Notification event sent when bollard is fully lowered.',name='isLowered',type='SFBool')]),
    Comment('===================='),
    Viewpoint(description='Bollard view',position=(0,0,6)),
    Comment('test locally during development, once complete we split this out into a separate Example scene.'),
    ProtoInstance(DEF='Bollard',name='BollardHydraulicSecurity',
      fieldValue=[
      fieldValue(name='height',value=0.85),
      fieldValue(name='radius',value=0.2),
      fieldValue(name='textureUrl',value=["fan.png"])]),
    Transform(DEF='RightBollard',translation=(2,0,0),
      children=[
      ProtoInstance(name='BollardHydraulicSecurity')]),
    Transform(DEF='LeftBollard',translation=(-2,0,0),
      children=[
      ProtoInstance(name='BollardHydraulicSecurity')]),
    Shape(DEF='GroundLevel',
      geometry=Box(size=(10,0.01,10))),
    Transform(DEF='RaiseInterface',translation=(-2,-1.5,0),
      children=[
      Shape(
        geometry=Text(string=["Click to","raise"],
          fontStyle=FontStyle(justify=["MIDDLE","MIDDLE"],size=0.3))),
      Shape(
        geometry=Box(size=(3,2,0.01)),
        appearance=Appearance(
          material=Material(transparency=1))),
      TouchSensor(DEF='ClickToRaiseBollard',description='click to raise bollard'),
      ROUTE(fromField='isActive',fromNode='ClickToRaiseBollard',toField='raise',toNode='Bollard')]),
    Transform(DEF='LowerInterface',translation=(2,-1.5,0),
      children=[
      Shape(
        geometry=Text(string=["Click to","lower"],
          fontStyle=FontStyle(justify=["MIDDLE","MIDDLE"],size=0.3))),
      Shape(
        geometry=Box(size=(3,2,0.01)),
        appearance=Appearance(
          material=Material(transparency=1))),
      TouchSensor(DEF='ClickToLowerBollard',description='click tolower bollard'),
      ROUTE(fromField='isActive',fromNode='ClickToLowerBollard',toField='lower',toNode='Bollard')])])
)

### X3D model conversion complete ###

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

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