#################################################################################################### # # Invoking X3D model self-test: # # $ python MaterialModulatorExamples.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='MaterialModulatorExamples.x3d',name='title'), meta(content='Demonstrate multiple instances of an external prototype.',name='description'), meta(content='Learning suggestion for authors: try changing the modulation script so that it goes from [0 ... 1] and then [1 ... 0] alternating, rather than abruptly shifting from 1 immediately back to 0.',name='hint'), meta(content='Don Brutzman',name='creator'), meta(content='7 September 2017',name='created'), meta(content='2 January 2025',name='modified'), meta(content='X3D prototype instances DEF USE',name='subject'), meta(content='MaterialModulator.png',name='Image'), meta(content='MaterialModulatorExamples.png',name='Image'), meta(content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulatorExamples.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='MaterialModulatorExamples.x3d'), ExternProtoDeclare(appinfo='mimic a Material node and modulate the diffuseColor field as an animation effect',documentation='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulatorIndex.html',name='MaterialModulator',url=["MaterialModulator.x3d#MaterialModulator","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/MaterialModulator.x3d#MaterialModulator"], field=[ field(accessType='inputOutput',appinfo='default value true',name='enabled',type='SFBool'), field(accessType='inputOutput',appinfo='default value 0.8 0.8 0.8',name='diffuseColor',type='SFColor'), field(accessType='inputOutput',appinfo='default value 0 0 0',name='emissiveColor',type='SFColor'), field(accessType='inputOutput',appinfo='default value 0 0 0',name='specularColor',type='SFColor'), field(accessType='inputOutput',appinfo='default value 0.0',name='transparency',type='SFFloat'), field(accessType='inputOutput',appinfo='default value 0.2',name='shininess',type='SFFloat'), field(accessType='inputOutput',appinfo='default value 0.2',name='ambientIntensity',type='SFFloat')]), Comment('Rendered geometry for the ProtoInstance now follows external prototype declaration'), Transform(rotation=(-0.8,0.93923,0.18785,5.759586),translation=(-2,1,0), children=[ Shape(DEF='ModulatingBoxShape', geometry=Box(), appearance=Appearance( material=ProtoInstance(DEF='MaterialModulatorInstance',name='MaterialModulator', fieldValue=[ fieldValue(name='enabled',value=True), fieldValue(name='diffuseColor',value=(0.5,0.1,0.1)), # fieldValue declarations for other Material attributes can appear here ],)))]), Transform(rotation=(1,0,0,0.523599),translation=(2,1,0), children=[ Shape( geometry=Cylinder(), appearance=Appearance( # note that ProtoInstance USE does not require name='MaterialModulator' material=ProtoInstance(USE='MaterialModulatorInstance',name='MaterialModulator')))]), Transform(translation=(-2,3.5,0), children=[ Shape( geometry=Text(string=["DEF original"], fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],size=0.5,style_='BOLD')), appearance=Appearance(DEF='TextAppearance', material=Material(diffuseColor=(0.9,0.9,0.9))))]), Transform(translation=(2,3.5,0), children=[ Shape( geometry=Text(string=["USE copy"], fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],size=0.5,style_='BOLD')), appearance=Appearance(USE='TextAppearance'))]), Transform(translation=(0,-2,0), children=[ Shape( geometry=Text(string=["enable/disable","MaterialModulator"], fontStyle=FontStyle(family=["SANS"],justify=["MIDDLE","MIDDLE"],style_='BOLD')), appearance=Appearance(USE='TextAppearance')), Comment('Selectable Text design pattern has transparent Box and TouchSensor description as a tooltip'), Shape( geometry=Box(size=(8,2,.001)), appearance=Appearance( material=Material(transparency=1))), Comment('Toggle text to enable/disable MaterialModulator'), TouchSensor(DEF='TouchTextInterface',description='Select text to enable/disable MaterialModulator'), BooleanToggle(DEF='EventToggler'), ROUTE(fromField='isActive',fromNode='TouchTextInterface',toField='set_boolean',toNode='EventToggler'), ROUTE(fromField='toggle',fromNode='EventToggler',toField='enabled',toNode='MaterialModulatorInstance')])]) ) ### X3D model conversion complete ### #################################################################################################### # Self-test diagnostics #################################################################################################### print('Self-test diagnostics for MaterialModulatorExamples.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 MaterialModulatorExamples.py load and self-test diagnostics complete.")