#################################################################################################### # # Invoking X3D model self-test: # # $ python ArchPrototype.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='ArchPrototype.x3d',name='title'), meta(content='Create an arch. Can modify general parameters: clearSpanWidth, riseHeight, depth, topAbutmentHeight, pierWidth, pierHeight. See the reference file ArchModelingDiagrams.pdf to find further information. See also ArchPrototypeScript_more_readable.js. Possibility to create shapes related to arch: ArchHalf; IntradosOnly; ArchFilled; ArchHalfFilled; Lintel. See the reference file ArchModelingDiagrams.pdf to find further information.',name='description'), meta(content='Michele Foti, Don Brutzman',name='creator'), meta(content='15 December 2014',name='created'), meta(content='16 June 2020',name='modified'), meta(content='debug local ProtoInstance',name='TODO'), meta(content='add test ArchPrototypeExample',name='TODO'), meta(content='Xj3D Player Issue, bogus error on line 243 of script regarding assignment to MFInt32 value',name='TODO'), meta(content='ArchModelingDiagrams.pdf',name='reference'), meta(content='https://en.wikipedia.org/wiki/Arch',name='reference'), meta(content='https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Buildings/ArchPrototype.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='ArchPrototype.x3d'), ProtoDeclare(appinfo='Create an arch. Can modify general parameters: clearSpanWidth, riseHeight, depth, topAbutmentHeight, pierWidth, pierHeight. - Possibility to create shapes related to an arch: ArchHalf; IntradosOnly; ArchFilled; ArchHalfFilled; Lintel. See the reference file ArchModelingDiagrams.pdf to find further information. See also ArchPrototypeScript_more_readable.js.js.',name='ArchPrototype', ProtoInterface=ProtoInterface( field=[ Comment('COLOR OF ARCH'), field(accessType='inputOutput',appinfo='color of arch',name='diffuseColor',type='SFColor',value=(0.2,0.8,0.8)), field(accessType='inputOutput',appinfo='color of arch',name='emissiveColor',type='SFColor',value=(0.2,0.8,0.8)), Comment('INPUT PARAMETERS'), Comment('General parameters: measures in meters'), field(accessType='initializeOnly',appinfo='clearSpanWidth: clearSpanWidth must be double of riseHeight to obtain an half circumference',name='clearSpanWidth',type='SFFloat',value=4), field(accessType='initializeOnly',appinfo='riseHeight: riseHeight must be half of clearSpanWidth to obtain an half circumference',name='riseHeight',type='SFFloat',value=2), field(accessType='initializeOnly',appinfo='depth',name='depth',type='SFFloat',value=3), field(accessType='initializeOnly',appinfo='topAbutmentHeight:topAbutmentHeight=0 means no topAbutment',name='topAbutmentHeight',type='SFFloat',value=0.5), field(accessType='initializeOnly',appinfo='pierWidth:pierWidtht=0 means no pierWidth',name='pierWidth',type='SFFloat',value=0.5), field(accessType='initializeOnly',appinfo='pierHeight: pierHeight=0 means no pierHeight',name='pierHeight',type='SFFloat',value=1), Comment('Parameters to create shapes related to arch: put true to apply'), field(accessType='initializeOnly',appinfo='archHalf: can modify also clearSpanWidth, riseHeight, depth, pierWidth, pierHeight, topAbutmentHeight, archHalfExtensionWidth at purpose, clearSpanWidth measure refers to a full arc, consider clearSpanWidth/2 for the archHalf width',name='archHalf',type='SFBool',value=False), field(accessType='initializeOnly',appinfo='archHalfExtensionWidth: measure in meters, use only if archHalf=true, it is the width of the etension of the abutment of the archHalf. See the reference file ArchModelingDiagrams.pdf to find further information.',name='archHalfExtensionWidth',type='SFFloat',value=0), field(accessType='initializeOnly',appinfo='onlyIntrados: note it is a flat curved surface, can modify also clearSpanWidth, riseHeight, depth at purpose, if needed apply archHalf=true.',name='onlyIntrados',type='SFBool',value=False), field(accessType='initializeOnly',appinfo='archFilled: note it is an half cylinder, can modify also clearSpanWidth, riseHeight, depth at purpose.',name='archFilled',type='SFBool',value=False), field(accessType='initializeOnly',appinfo='archHalfFilled: note it is a quarter cylinder, can modify also clearSpanWidth, riseHeight, depth at purpose, clearSpanWidth measure refers to a full arc, consider clearSpanWidth/2 for the archHalfFilled width.',name='archHalfFilled',type='SFBool',value=False), field(accessType='initializeOnly',appinfo='lintel: no arc is rendered, but a lintel: topAbutmentHeight on pierHeight, total height is pierHeight + topAbutmentHeight, if needed apply archHalf=true.',name='lintel',type='SFBool',value=False)]), ProtoBody=ProtoBody( children=[ Comment('First node determines node type of this prototype'), Comment('IndexedFaceset creates arch'), Transform(DEF='ArchTransform', children=[ Shape(DEF='Arch', # note that convex='false' (meaning concave geometry) is crucial for this IFS of a geometric chord to render properly geometry=IndexedFaceSet(DEF='ArchIndex',convex=False,solid=False, coord=Coordinate(DEF='ArchChord')), appearance=Appearance( material=Material(DEF='MaterialNode', IS=IS( connect=[ connect(nodeField='emissiveColor',protoField='emissiveColor'), connect(nodeField='diffuseColor',protoField='diffuseColor')]))))]), Comment('Subsequent nodes do not render, but still must be a valid X3D subgraph'), Comment('This embedded Script provides the X3D author with additional visibility and control over prototype inputs and outputs'), Script(DEF='ArchPrototypeScript',url=["ArchPrototypeScript.js","https://www.web3d.org/x3d/content/examples/X3dForAdvancedModeling/Buildings/ArchPrototypeScript.js"], field=[ Comment('INPUT PARAMETERS'), Comment('General parameters'), Comment('Parameters to create to create shapes related to arch: put true to apply'), Comment('OUTPUT PARAMETERS'), field(accessType='initializeOnly',appinfo='user or default input for clearSpanWidth parameter',name='clearSpanWidth',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for riseHeight parameter',name='riseHeight',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for depth parameter',name='depth',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for topAbutmentHeight parameter',name='topAbutmentHeight',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for pierWidth parameter',name='pierWidth',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for pierHeight parameter',name='pierHeight',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for archHalf parameter',name='archHalf',type='SFBool'), field(accessType='initializeOnly',appinfo='user or default input for archHalfExtensionWidth parameter',name='archHalfExtensionWidth',type='SFFloat'), field(accessType='initializeOnly',appinfo='user or default input for onlyIntrados parameter',name='onlyIntrados',type='SFBool'), field(accessType='initializeOnly',appinfo='user or default input for archFilled parameter',name='archFilled',type='SFBool'), field(accessType='initializeOnly',appinfo='user or default input for archHalfFilled parameter',name='archHalfFilled',type='SFBool'), field(accessType='initializeOnly',appinfo='user or default input for lintel parameter',name='lintel',type='SFBool'), field(accessType='outputOnly',appinfo='computedScale: modify scale field - NOTE it is not used to modify the whole arch, but to modify clearSpanWidth, riseHeight, depth. It does not affect topAbutmentHeight, pierWidth, pierHeight, archHalfExtensionWidth',name='computedScale',type='SFVec3f'), field(accessType='outputOnly',appinfo='send computed points to the Coordinate node',name='pointOut',type='MFVec3f'), field(accessType='outputOnly',appinfo='send computed indices to the IndexedFaceSet node',name='indexOut',type='MFInt32')], IS=IS( connect=[ connect(nodeField='clearSpanWidth',protoField='clearSpanWidth'), connect(nodeField='riseHeight',protoField='riseHeight'), connect(nodeField='depth',protoField='depth'), connect(nodeField='pierWidth',protoField='pierWidth'), connect(nodeField='topAbutmentHeight',protoField='topAbutmentHeight'), connect(nodeField='pierHeight',protoField='pierHeight'), connect(nodeField='archHalf',protoField='archHalf'), connect(nodeField='archHalfExtensionWidth',protoField='archHalfExtensionWidth'), connect(nodeField='onlyIntrados',protoField='onlyIntrados'), connect(nodeField='archFilled',protoField='archFilled'), connect(nodeField='archHalfFilled',protoField='archHalfFilled'), connect(nodeField='lintel',protoField='lintel')]), sourceCode=""" ecmascript: """), ROUTE(fromField='computedScale',fromNode='ArchPrototypeScript',toField='scale',toNode='ArchTransform'), ROUTE(fromField='pointOut',fromNode='ArchPrototypeScript',toField='point',toNode='ArchChord'), ROUTE(fromField='indexOut',fromNode='ArchPrototypeScript',toField='set_coordIndex',toNode='ArchIndex')])), ProtoInstance(DEF='ArchInstance',name='ArchPrototype', fieldValue=[ fieldValue(name='diffuseColor',value=(0.5,0.3,0.6)), fieldValue(name='emissiveColor',value=(0.5,0.3,0.6)), fieldValue(name='clearSpanWidth',value=5), fieldValue(name='riseHeight',value=2.5), fieldValue(name='depth',value=2), fieldValue(name='topAbutmentHeight',value=0.6), fieldValue(name='pierWidth',value=1), fieldValue(name='pierHeight',value=2)]), Shape( geometry=Text(string=["TODO: internal and external","prototype tests","ArchPrototype.x3d"], fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],style_='BOLD')), appearance=Appearance( material=Material(diffuseColor=(0.9,0.9,0.9)))), Comment('Add any ROUTEs here that connect ProtoInstance to/from prior nodes in Scene (and outside of ProtoDeclare)'), Inline(DEF='CoordinateAxes',url=["../../X3dForWebAuthors/Chapter03Grouping/CoordinateAxes.x3d","../../../Savage/Tools/Authoring/CoordinateAxes.x3d","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter03Grouping/CoordinateAxes.x3d","../../X3dForWebAuthors/Chapter03Grouping/CoordinateAxes.wrl","../../../Savage/Tools/Authoring/CoordinateAxes.wrl","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter03Grouping/CoordinateAxes.wrl","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/CoordinateAxes.x3d","https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/CoordinateAxes.wrl"])]) ) ### X3D model conversion complete ### #################################################################################################### # Self-test diagnostics #################################################################################################### print('Self-test diagnostics for ArchPrototype.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 ArchPrototype.py load and self-test diagnostics complete.")