#################################################################################################### # # Invoking X3D model self-test: # # $ python TSSRPairPrototypeWithDIS.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.0', head=head( children=[ component(level=1,name='DIS'), meta(content='TSSRPairPrototypeWithDIS.x3d',name='title'), meta(content='A pair of Tropo Satellite Support Radios (TSSR) used for short-range (< 20 miles) point-to-point SHF communication. The system designed to support remote equipment and users by replacing long cable runs.',name='description'), meta(content='Mike Hunsberger',name='creator'), meta(content='1 May 2001',name='created'), meta(content='20 October 2019',name='modified'), meta(content='upgrade ViewpointGroup',name='warning'), meta(content='https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/TSSR/TSSRPairPrototypeWithDIS.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=[ Comment('ExternProtoDeclare definitions must be included verbatim'), ExternProtoDeclare(appinfo='Produce wireframe or transparent beam cylinders. Typical uses include propeller/thruster water flow or line-of-sight sonar/radar/light beams. Negative range values invert base and apex at same relative location. Default: beam with apex at (0 0 0) and base of radius 1 in x-z plane at (1 0 0).',name='BeamCylinder',url=["../../CommunicationsAndSensors/Beam/BeamCylinderPrototype.x3d#BeamCylinder","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Beam/BeamCylinderPrototype.x3d#BeamCylinder","../../CommunicationsAndSensors/Beam/BeamCylinderPrototype.wrl#BeamCylinder","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/Beam/BeamCylinderPrototype.wrl#BeamCylinder"], field=[ field(accessType='initializeOnly',appinfo='Assigning a name to a BeamCylinder aids tracing',name='name',type='SFString'), Comment('eventIn, eventOut and field semantics must be retained due to exposedField not being allowed in VRML 97 scripts (unfortunately)'), 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='meters across vertical y axis',name='beamHeight',type='SFFloat'), field(accessType='initializeOnly',appinfo='meters across horizontal z axis',name='beamWidth',type='SFFloat'), 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')]), ExternProtoDeclare(appinfo='warning: developmental prototype for X3D v3.2 node do not override native support!',name='ViewpointGroup',url=["../../../Basic/development/ViewpointGroupPrototype.x3d#ViewpointGroup","https://www.web3d.org/x3d/content/examples/Basic/development/ViewpointGroupPrototype.x3d#ViewpointGroup","../../../Basic/development/ViewpointGroupPrototype.wrl#ViewpointGroup","https://www.web3d.org/x3d/content/examples/Basic/development/ViewpointGroupPrototype.wrl#ViewpointGroup"], field=[ field(accessType='inputOutput',appinfo='[Viewpoint | ViewpointGroup] only',name='children',type='MFNode'), field(accessType='inputOutput',appinfo='Text description or navigation hint to be displayed for this ViewpointGroup.',name='description',type='SFString'), field(accessType='inputOutput',appinfo='Whether this ViewpointGroup description is displayed in current viewpoint list.',name='displayed',type='SFBool'), field(accessType='inputOutput',appinfo='Position offset from origin of local coordinate system.',name='center',type='SFVec3f'), field(accessType='initializeOnly',appinfo='[0..infinity) Radius in meters of Proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list.',name='radius',type='SFFloat'), field(accessType='inputOnly',appinfo='[0..infinity) Radius in meters of Proximity box within which the ViewpointGroup is usable and displayed on the viewpoint list.',name='set_radius',type='SFFloat'), field(accessType='inputOutput',appinfo='Whether viewpoint needs to retain (true) or rezero (false) any prior user navigation offsets from defined viewpoint position orientation.',name='retainUserOffsets',type='SFBool')]), Comment('PROTO consists of two TSSRs for short range (< 5 mile) point-to-point communication. TSSRs eliminate the need for long cable runs. This PROTO allow specification for the initial placement of each TSSR. It automatically calculates the correct angle to complete the link.'), ProtoDeclare(name='TSSRPairDIS', ProtoInterface=ProtoInterface( field=[ field(accessType='initializeOnly',name='TSSR1Location',type='SFVec3f',value=(1,1,1)), field(accessType='initializeOnly',name='TSSR2Location',type='SFVec3f',value=(0,0,0))]), ProtoBody=ProtoBody( children=[ Group( children=[ Viewpoint(DEF='TSSRPairViewpoint',description='TSSR Pair Viewpoint'), LOD(range=[40000], children=[ Comment('TSSR 1 Two Transforms. One in the XZ plane, the second in the XY plane. Inlines for the TSSR body, stand, and the dome pattern.'), EspduTransform(DEF='TSSR1_TRANSFORM',address='224.2.181.145',port=62040, IS=IS( connect=[ connect(nodeField='translation',protoField='TSSR1Location')]), children=[ Transform(DEF='TSSR1_XY_TRANSFORM', children=[ Inline(DEF='TSSRBody',url=["../../CommunicationsAndSensors/TSSR/TSSRBody.x3d","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/TSSR/TSSRBody.x3d","../../CommunicationsAndSensors/TSSR/TSSRBody.wrl","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/TSSR/TSSRBody.wrl"]), Transform(translation=(-5,0,0), children=[ ReceiverPdu(DEF='TSSR1_RECEIVER',address='224.2.181.145',entityID=1,port=62040,readInterval=1,receivedPower=0.0)]), TransmitterPdu(DEF='TSSR1_TRANSMITTER',address='224.2.181.145',antennaLocation=(-5,0,0),entityID=5,port=62040,readInterval=1,relativeAntennaLocation=(0,0,0),transmitFrequencyBandwidth=0.0), Transform(DEF='TSSR1Cone',translation=(1,0,1), children=[ Transform(translation=(2,2,0), children=[ Shape( geometry=Text(string=["Near End Transmitter to Far End Receiver Link"]), appearance=Appearance(DEF='TextAppearance', material=Material(diffuseColor=(1,0.937255,0.121569))))]), ProtoInstance(DEF='TSSR1_BEAMCYLINDER',name='BeamCylinder', fieldValue=[ fieldValue(name='defaultRange',value=10), fieldValue(name='beamHeight',value=1), fieldValue(name='beamWidth',value=1), fieldValue(name='transparency',value=0.2), fieldValue(name='wireframe',value=True), fieldValue(name='solid',value=True), fieldValue(name='contactColor',value=(.3,.5,.5)), fieldValue(name='noContactColor',value=(.8,.1,.1))]), LOD(range=[100], children=[ ProtoInstance(name='ViewpointGroup', fieldValue=[ fieldValue(name='description',value='100m from TSSR1'), fieldValue(name='radius',value=100), fieldValue(name='children', children=[ Viewpoint(description='TSSR1 side view')])]), WorldInfo(info=["null node for no rendering when distant"])])])]), Transform( children=[ Inline(DEF='TSSRStand',url=["../../CommunicationsAndSensors/TSSR/TSSRTripod.x3d","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/TSSR/TSSRTripod.x3d","../../CommunicationsAndSensors/TSSR/TSSRTripod.wrl","https://www.web3d.org/x3d/content/examples/Savage/CommunicationsAndSensors/TSSR/TSSRTripod.wrl"])])]), WorldInfo(info=["null node for no rendering when distant"])]), LOD(range=[40000], children=[ Comment('TSSR 2 Two Transforms. One in the XZ plane, the second in the XY plane. Inlines for the TSSR body, stand, and the dome pattern.'), EspduTransform(DEF='TSSR2_TRANSFORM',address='224.2.181.145',port=62040, IS=IS( connect=[ connect(nodeField='translation',protoField='TSSR2Location')]), children=[ Transform(DEF='TSSR2_XY_TRANSFORM', children=[ Inline(USE='TSSRBody'), Transform(translation=(-5,0,0), children=[ ReceiverPdu(DEF='TSSR2_RECEIVER',address='224.2.181.145',entityID=2,port=62040,readInterval=1,receivedPower=0.0)]), TransmitterPdu(DEF='TSSR2_TRANSMITTER',address='224.2.181.145',antennaLocation=(-5,0,0),entityID=6,port=62040,readInterval=1,relativeAntennaLocation=(0,0,0),transmitFrequencyBandwidth=0.0), Transform(DEF='TSSR2Cone',translation=(1,0,1), children=[ Transform(translation=(2,2,0), children=[ Shape( geometry=Text(string=["Near End Transmitter to Far End Receiver Link"]), appearance=Appearance(USE='TextAppearance'))]), ProtoInstance(DEF='TSSR2_BEAMCYLINDER',name='BeamCylinder', fieldValue=[ fieldValue(name='defaultRange',value=10), fieldValue(name='beamHeight',value=1), fieldValue(name='beamWidth',value=1), fieldValue(name='transparency',value=0.2), fieldValue(name='wireframe',value=True), fieldValue(name='solid',value=True), fieldValue(name='contactColor',value=(.3,.5,.5)), fieldValue(name='noContactColor',value=(.8,.1,.1))]), LOD(range=[100], children=[ ProtoInstance(name='ViewpointGroup', fieldValue=[ fieldValue(name='description',value='100m from TSSR2'), fieldValue(name='radius',value=100), fieldValue(name='children', children=[ Viewpoint(description='TSSR2 side view',orientation=(0,1,0,3.14),position=(0,0,-10))])]), WorldInfo(info=["null node for no rendering when distant"])])])]), Transform( children=[ Inline(USE='TSSRStand')])]), WorldInfo(info=["null node for no rendering when distant"])]), Script(DEF='TransmitScript', field=[ field(accessType='inputOnly',name='transState',type='SFInt32'), field(accessType='outputOnly',name='size',type='SFVec3f')], sourceCode=""" ecmascript: function initialize () { size = new SFVec3f(100, 100, 100) ; Browser.println ('TransmitScript initialize() complete') ; } // function name matches eventIn variable name ('hour') // hourValue captures the new value of the ROUTE hour event // minutes is just the current field value function transState (newValue, timestamp) { transmitState = newValue ; if (transmitState == 3) { size = new SFVec3f(10, 10, 10) ; } else { size = new SFVec3f(100, 100, 100) ; } Browser.println ('size = ' + size) ; } """), Script(DEF='TransmitScript2', field=[ field(accessType='inputOnly',name='transState',type='SFInt32'), field(accessType='outputOnly',name='size',type='SFVec3f')], sourceCode=""" ecmascript: function initialize () { size = new SFVec3f(100, 100, 100) ; Browser.println ('TransmitScript initialize() complete') ; } // function name matches eventIn variable name ('hour') // hourValue captures the new value of the ROUTE hour event // minutes is just the current field value function transState (newValue, timestamp) { transmitState = newValue ; if (transmitState == 3) { size = new SFVec3f(10, 10, 10) ; } else { size = new SFVec3f(100, 100, 100) ; } Browser.println ('size = ' + size) ; } """), Comment('This script is used to calculate the corresponding rotation angles so the TSSRs will be pointed at each other'), Script(DEF='CalculateAngleScript', field=[ field(accessType='initializeOnly',name='TSSR1Location',type='SFVec3f'), field(accessType='initializeOnly',name='TSSR2Location',type='SFVec3f'), field(accessType='outputOnly',name='TSSR1_XZangle',type='SFRotation'), field(accessType='outputOnly',name='TSSR2_XZangle',type='SFRotation'), field(accessType='outputOnly',name='beamScale',type='SFVec3f'), field(accessType='outputOnly',name='beamLengthLink1',type='SFFloat'), field(accessType='outputOnly',name='beamLengthLink2',type='SFFloat'), field(accessType='outputOnly',name='TSSR1_XYangle',type='SFRotation'), field(accessType='outputOnly',name='TSSR2_XYangle',type='SFRotation'), field(accessType='outputOnly',name='TSSR1ToTSSR2Link',type='SFBool'), field(accessType='outputOnly',name='TSSR2ToTSSR1Link',type='SFBool'), field(accessType='outputOnly',name='ViewpointLocation',type='SFVec3f'), field(accessType='outputOnly',name='ViewpointAngle',type='SFRotation'), field(accessType='inputOnly',name='TSSR1_receiverState',type='SFInt32'), field(accessType='inputOnly',name='TSSR2_receiverState',type='SFInt32'), field(accessType='inputOnly',name='TSSR1_transmitState',type='SFInt32'), field(accessType='inputOnly',name='TSSR2_transmitState',type='SFInt32')], IS=IS( connect=[ connect(nodeField='TSSR1Location',protoField='TSSR1Location'), connect(nodeField='TSSR2Location',protoField='TSSR2Location')]), sourceCode=""" ecmascript: function initialize () { Browser.println ('TSSR1 =' + TSSR1Location) ; Browser.println ('TSSR2 =' + TSSR2Location) ; Browser.println ('TransmitScript initialize() complete') ; active = true ; TSSR1_XZangle = new SFRotation(0, 1, 0, 0) ; TSSR2_XZangle = new SFRotation(0, 1, 0, 0) ; TSSR1_XYangle = new SFRotation(0, 0, 1, 0) ; TSSR2_XYangle = new SFRotation(0, 0, 1, 0) ; beamScale = new SFVec3f ( ) ; ViewpointLocation = new SFVec3f ( ) ; ViewpointAngle = new SFRotation(0, 1, 0, 0) ; TSSR1_RXState = 0 ; TSSR1_TXState = 2 ; TSSR2_RXState = 0 ; TSSR2_TXState = 1 ; TSSR1ToTSSR2Link = true; TSSR2ToTSSR1Link = true; DistanceAcceptable = true ; compute(active) ; } function TSSR1_receiverState(newValue, timestamp) { TSSR1_RXState = newValue ; computeLink( ) ; } function TSSR2_transmitState(newValue, timestamp) { TSSR2_TXState = newValue ; computeLink( ) ; } function TSSR2_receiverState(newValue, timestamp) { TSSR2_RXState = newValue ; computeLink( ) ; } function TSSR1_transmitState(newValue, timestamp) { TSSR1_TXState = newValue ; computeLink( ) ; } function computeLink( ) { if ((TSSR2_TXState ==2) && (DistanceAcceptable)) { beamLengthLink2 = distance - 2 ; if (TSSR1_RXState == 2) { TSSR2ToTSSR1Link = true ; } else { TSSR2ToTSSR1Link = false ; } } else if ((TSSR2_TXState < 2) && (DistanceAcceptable)) { beamLengthLink2 = 5 ; TSSR2ToTSSR1Link = false ; } if ((TSSR1_TXState ==2) && (DistanceAcceptable)) { beamLengthLink1 = distance - 2 ; if (TSSR2_RXState == 2) { TSSR1ToTSSR2Link = true ; } else { TSSR1ToTSSR2Link = false ; } } else if ((TSSR1_TXState < 2) && (DistanceAcceptable)) { beamLengthLink1 = 5 ; TSSR1ToTSSR2Link = false ; } } function compute ( ) { computeDistance( ) ; computeXZangle( ); ViewpointLocation[0] = TSSR1Location[0] ; ViewpointLocation[1] = TSSR1Location[1] + 4; ViewpointLocation[2] = TSSR1Location[2] ; Browser.println ('ViewpointLocation =' + ViewpointLocation) ; ViewpointAngle[3] = TSSR1_XZangle[3] - Math.PI/2; Browser.println ('ViewpointAngle =' + ViewpointAngle) ; computeXYangle( ) ; } function computeDistance( ) { Browser.println ('TSSR1 =' + TSSR1Location) ; Browser.println ('TSSR2 =' + TSSR2Location) ; deltaX = (TSSR2Location[0] - TSSR1Location[0]) ; deltaY = (TSSR2Location[1] - TSSR1Location[1]) ; deltaZ = (TSSR2Location[2] - TSSR1Location[2]) ; distanceSquared = deltaX * deltaX + deltaY * deltaY + deltaZ * deltaZ ; Browser.println ('Distance Squared =' + distanceSquared) ; distance = Math.sqrt(distanceSquared) ; Browser.println ('Distance =' + distance) ; beamScale[0] = distance/10; beamScale[1] = 5; beamScale[2] = 5; Browser.println ('BeamScale =' + beamScale) ; if (distance > 5000/.6) { DistanceAcceptable = false; beamLength = 5000; } else { DistanceAcceptable = true ; } } function computeXZangle( ) { if (deltaZ == 0) { deltaZ = .00000001 ; } angle = Math.atan(deltaX/deltaZ) ; if (deltaZ < 0) { TSSR1_XZangle[3] = angle + Math.PI/2; } else { TSSR1_XZangle[3] = angle - Math.PI/2; } TSSR2_XZangle[3] = TSSR1_XZangle[3] + Math.PI; Browser.println ('Angle =' + TSSR1_XZangle[3]) ; Browser.println ('Angle2 =' + TSSR2_XZangle[3]) ; } function computeXYangle( ) { angle = Math.asin(deltaY/distance) ; TSSR1_XYangle[3] = angle ; TSSR2_XYangle[3] = - TSSR1_XYangle[3]; Browser.println ('AngleXY =' + TSSR1_XYangle[3]) ; Browser.println ('Angle2XY =' + TSSR2_XYangle[3]) ; } """)]), ROUTE(fromField='TSSR1_XZangle',fromNode='CalculateAngleScript',toField='rotation',toNode='TSSR1_TRANSFORM'), ROUTE(fromField='TSSR2_XZangle',fromNode='CalculateAngleScript',toField='rotation',toNode='TSSR2_TRANSFORM'), ROUTE(fromField='beamLengthLink1',fromNode='CalculateAngleScript',toField='range',toNode='TSSR1_BEAMCYLINDER'), ROUTE(fromField='beamLengthLink2',fromNode='CalculateAngleScript',toField='range',toNode='TSSR2_BEAMCYLINDER'), ROUTE(fromField='TSSR1_XYangle',fromNode='CalculateAngleScript',toField='rotation',toNode='TSSR1_XY_TRANSFORM'), ROUTE(fromField='TSSR2_XYangle',fromNode='CalculateAngleScript',toField='rotation',toNode='TSSR2_XY_TRANSFORM'), ROUTE(fromField='TSSR1ToTSSR2Link',fromNode='CalculateAngleScript',toField='contact',toNode='TSSR1_BEAMCYLINDER'), ROUTE(fromField='TSSR2ToTSSR1Link',fromNode='CalculateAngleScript',toField='contact',toNode='TSSR2_BEAMCYLINDER'), ROUTE(fromField='ViewpointLocation',fromNode='CalculateAngleScript',toField='position',toNode='TSSRPairViewpoint'), ROUTE(fromField='ViewpointAngle',fromNode='CalculateAngleScript',toField='orientation',toNode='TSSRPairViewpoint'), ROUTE(fromField='transmitState',fromNode='TSSR2_TRANSMITTER',toField='TSSR2_transmitState',toNode='CalculateAngleScript'), ROUTE(fromField='transmitState',fromNode='TSSR1_TRANSMITTER',toField='TSSR1_transmitState',toNode='CalculateAngleScript'), ROUTE(fromField='receiverState',fromNode='TSSR1_RECEIVER',toField='TSSR1_receiverState',toNode='CalculateAngleScript'), ROUTE(fromField='receiverState',fromNode='TSSR2_RECEIVER',toField='TSSR2_receiverState',toNode='CalculateAngleScript')])), WorldInfo(info=["Authors: Mike Hunsberger","Revised: 30 April 2001","Purpose: Pair of TSSRs","Browser: CosmoPlayer"],title='AntennaWorld'), ProtoInstance(name='TSSRPairDIS', fieldValue=[ fieldValue(name='TSSR1Location',value=(0,0,0)), fieldValue(name='TSSR2Location',value=(50,0,50))]), Background(groundAngle=[1.57079],groundColor=[(1,0.8,0.6),(0.6,0.4,0.2)],skyAngle=[0.2],skyColor=[(1,1,1),(0.2,0.2,1)])]) ) ### X3D model conversion complete ### #################################################################################################### # Self-test diagnostics #################################################################################################### print('Self-test diagnostics for TSSRPairPrototypeWithDIS.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 TSSRPairPrototypeWithDIS.py load and self-test diagnostics complete.")