Lecture 2 Advanced Scripting of DesignModeler

Transcription

1 Lecture 2 Advanced Scripting of DesignModeler 1

2 Contents Supported API s of DesignModeler Attaching Debugger to DesignModeler Advanced scripting API s of DesignModeler Handlers Tree, Graphics, File, Event (Feature) List View details Finding command of DM example (File >> Import) Summary 2

3 Documented Scripting API s in DM Scripting language used Jscript Also support xml and html for wizard creations Jscript can be read from File Run Script in DM Basic API s are useful for Recording and Editing of sketch functions... Creating new Planes and Sketches Using features like extrude/ revolve to create geometries Above functionality is not sufficient to work with complicated models Ex: Using CAD import, clean the geometry and modify it for meshing in automated way? 3

4 Use of Debugger? Documented API s are useful to create geometries which are simple in creation methodology. But for complicated geometries we need further commands to work with... Is there any why we can get these commands to use them in scripts...? Yes, by attaching debugger to DesignModeler application We can find internal commands used for different operations What operations can be done here Geometry creation Modifications and Decomposition Geometry clean-up 4

5 Attach Debugger to DesignModeler To see the script in action, attach debugger to the DesignModeler Process Using Visual Studio Professional Approach: Open DesignModeler Start Visual Studio (VS) Go to Tools Attach to Process... Select the suitable "AnsysWBU.exe Note that the "Script" option under "Type" (column 4 in the window) is available If it is not picked up by default, try to use the "Select" option (button on the right of "Attach to" in the window) 5! Note: If other session of DesignModeler is already open, there may be multiple AnsysWBU.exe processes

6 Attach Debugger to DesignModeler (2) Press the "Attach" button In the VS window, select Debug Break All Go back to DesignModeler application window and click at any location This will pop up the VS window with the JScript in it 6

7 Attach Debugger to DesignModeler (3) All events fired from DM are handled through ageventhandler function Search for ageventhandler function and attach a Break Point Press Continue (F5) This will not do anything (for now) In DM session, create a Box primitive (as usual) This takes the control back to VS, where you have attached the break point 7

8 Attach Debugger to DesignModeler (4) Step Into (F11) the function This will take to the function: ageventhandler (eventname, eventid) Add variables to Watch window to check eventname eventid Go line by line Step Over (F10) till you reach the function that uses the specific eventid Step Into (F11) the function Look for the specific case using this eventid In the case: agfeaturehandler (eventname, eventid) 8

9 Attach Debugger to DesignModeler (5) Step Into (F11) the function Go line by line Step Over (F10) till you reach the specific case using this eventid Go line by line Step Over (F10) to see what more is happening inside the function You will notice few more function calls used! You may like to add feature to the Watch window to see what it contains (just after you step over it)! 9

10 Attach Debugger to DesignModeler (6) You may Step Into (F11) the functions to see what is happening there Add a Watch for ag.tree.selecteditem Attributes of the selected Item can be accessed Example: Text (Name of the Object) Visible state etc. Continue press Step Over (F10) till control goes back to DM session! Note: Item values are non editable using the above route. Feature manger ag.fm can be used to edit item values such as Name etc.. 10

11 Attach Debugger to DesignModeler (7) Select Operation in the list view item This will take control back to VS Add a Watch for ag.listview.selecteditem Attributes of the selected Item can be accessed Example: Value When done, you can use Continue (F5) And detach the debugger Debug Detach All! Note: Item values are non editable using the above route. Slide-12 and 13 shows the way to edit these values. 11

12 List view and Tree view Items in list view provides the details of created features/nodes Example: List view for primitives Changing the operation, changing the Base plane etc Items in tree are features/object s and these are referred to as nodes Example: Select a plane and create a sketch Select Solid bodies for Boolean operation Collapse or expand tree nodes List view Items Tree view Items Functions for selecting list view items can be located in aglistview.js file in AGPages/scripts Functions for selecting tree view items can be located in agtreeview.js file in AGPages/scripts 12

13 List view (Editing) Each Item has a Value Example: Direction is item and values could be Normal or Reversed or Sample Task: Create an Extrusion operation and change the operation to Add Frozen Steps: Create Extrude object Select Extrude object from tree Activate the item Operation in the list view ag.listview.activateitem("operation"); Changing the item value ag.listview.itemvalue = "Add Frozen"; Create a JS macro file (e.g. listview_selection.js) Run the Macro Items Value 13! Note: ItemValue takes a string argument (even for number!)

14 Example: List view (Editing) ag.gui.createextrusion(); ag.listview.activateitem( "Extrude" ); ag.listview.itemvalue = "Extrude_temp"; ag.listview.activateitem( "Geometry" ); select_node("sketch1"); //This is explained in later slides ag.listview.itemvalue = "Apply"; ag.listview.activateitem( "Operation" ); ag.listview.itemvalue = "Add Material"; ag.listview.activateitem( "Direction Vector" ); ag.listview.itemvalue = "Apply"; ag.listview.activateitem( "Direction" ); ag.listview.itemvalue = "Normal"; ag.listview.activateitem( "Extent Type" ); ag.listview.itemvalue = "Fixed"; ag.listview.activateitem( "FD1, Depth (>0)" ); ag.listview.itemvalue = 40; ag.listview.activateitem( "As Thin/Surface?" ); ag.listview.itemvalue = "No"; ag.listview.activateitem( "Merge Topology?" ); ag.listview.itemvalue = "Yes"; agb.regen(); 14

15 Recipe for Finding scripts for all GUI events All GUI events can be located in ageventhandler.js file in in AGPages/scripts GUI events are categorized with specific handlers aggraphicshandler agfeaturehandler agfilehandler agtreehandler All functions in the script needs to be refereed using the ag.* route Examples: ag.gui.createprimitive(4) ag.gui.zoomfit() Alternatively, functions can be also called using the ag.agapplet route ag.agapplet.guimodeler.createprimitive(4) ag.agapplet.guimodeler.zoomfit() 15

16 aggraphicshandler All graphics related operations can be located in aggraphicshandler function All methods related to graphics handling can be also referred using ag.agapplet.guimodeler identifier Operations Rotate, Pan, Zoom, Boxzoom Fit, Undo view, Redo view Reset Sample Task Zoom fit the DM graphics window. Search for fit in aggraphicshandler function Locate the function Create a JS macro file (e.g. zoomfit.js) Add a line: ag.gui.zoomfit(); OR: ag.agapplet.guimodeler.zoomfit(); Save the file Run the JS macro file File Run Macro 16

17 agfeaturehandler All operations related to creation of objects and creation of other features can be located in agfeaturehandler function Operations Creation of Primitive objects Body operations Boolean operations etc.. Sample Task Create a Cylinder from primitive objects. Search for cylinder in agfeaturehandler function Locate the relevant function Create a JS macro file (e.g. createcylinder.js) Add a line: ag.gui.createprimitive(4) ; OR: ag.agapplet.guimodeler.createprimitive(4); Save the file Run the JS macro file File Run Macro 17

18 agfeaturehandler (2) Features can be Accessed/Modified using ag.agapplet.featuremgr identifier ag.agapplet.featuremgr.bodycount Returns the number of bodies in the model ag.agapplet.featuremgr.featurecount Returns number of features in model Example: Change the Name of the Box Primitive var box = ag.agapplet.featuremgr.feature(i); box.name = Box1 ; Changing name of first body var body = ag.agapplet.featuremgr.body(i); body.name = solid_plate ; 18

19 agfeaturehandler (3) Feature object/node Accessed using ag.agapplet.featuremgr Some useful methods box.isdeleteable(); Returns 1 if Feature is deleteable else 0 box.iseditable(); Returns 1 if Feature is editable else 0 box.isgenerated(); Returns 1 if Feature is generated else 0 box.issuppressed(); Returns 1 if Feature is suppressed else 0 box.issuppressible(); Returns 1 if Feature is suppressible else 0 box.setparameter(...); Command used to set the WB parameter 19

20 agfeaturehandler (4) Body Object Accessed using ag.agapplet.featuremgr Some useful methods body.getfrozenstatus(); body.getmaterialname(); body.getsuppression(); body.getvisibility(); Returns 0 if body is frozen Returns material name assigned to body Returns 1 if body is suppressed Returns 1 if body is visible in graphics window body.getcentroid(0); To get X, Y and Z centroid values pass 0, 1 and 2 body.setsuppression(true); body.setsuppression(false); body.setvisibility(true); body.setvisibility(false); To suppress body To un-suppress body To show body in graphics To hide body in graphics 20

21 agfilehandler All operations related to file menu can be located in agfilehandler function Operations File Save/Open Project Save/Open Sample Task Save the workbench project. Search for saveproject in agfilehandler function Locate the relevant function, it is aginteropsaveproject() 21

22 agfilehandler (2) All functions which have interop in their name can be located in aginterop.js file in in AGPages/scripts Open aginterop.js search with string aginteropsaveproject Create a JS macro file (e.g. saveproject.js) Add a line: ag.m.interop.saveproject(); OR: ag.agapplet.modeler.interop.saveproject() Save the file Run the JS macro file File Run Macro 22

23 agtreehandler All operations related to selection of objects or items in the DesignModeler tree Selection of plane Selection of bodies Adding new items to Tree Clearing all the items in the Tree Refreshing tree items for new additions Example: agtreefastrefresh(), agtreenodesclear(), agtreeupdatenode() Task: Select the XYPlane in the tree Tree items are referred as nodes in the script Search for selectnode in agtreeview.js Locate the function agtree_selectnode agtree_selectnode function requires two arguments Node Multiflag (optional, default = false) 23! Note: Refreshing tree items is important when you add new items using the scripts

24 agtreehandler (2) To be able to select a specific node based on its name, a function can be written using the agtree_selectnode function. Target = Name of the tree item for selection Loop over all the nodes to find the target If the name is not unique, it will select the 1 st matching node in the tree! The XYPlane in the tree can be selected now as: selectnode( XYPlane ) 24

25 SelectionMgr object in DM ag.m.selectionmgr Pointer to access selection manager Ex: SM.ClearSelection() //Clears selection SM.IsSelectedFace() //Returns 1 if face is selected else 0 SM.IsSelectedFeature() //Returns 1 if feature is selected else 0 SM.IsSelectedSolidBody() //Returns 1 if solid body is selected else 0 25

26 Useful methods of ag.m ag.m.bodiesexist(); ag.m.getbodysellistsize(); ag.m.getbodysellistindex(i); ag.m.getfacesellistsize(); ag.m.getfacesellistindex(i); ag.m.getedge3dsellistsize(); ag.m.getedge3dsellistindex(i); ag.m.hiddenbodiesexist(); ag.m.hiddenfacesexist(); //Returns 1 if bodies exist in active session //Returns number of selected bodies //Returns indexed Body object //Returns number of selected faces //Returns indexed Face object //Returns number of selected edges //Returns indexed Edge object //Returns 1 if any of the body is hidden //Returns 1 if any of the face is hidden 26

27 Useful methods of ag.m ag.m.hideallotherbodies(); ag.m.showallbodies(); //Hides bodies which are not selected //Show all unsuppressed bodies ag.m.hideallotherfaces(); ag.m.showallfaces(); //Hides faces which are not selected //Show all faces ag.m.hidebody(); ag.m.showbody(); //Hides selected bodies //Show selected body ag.m.hidefaces(); //Hides selected faces 27

28 Example: Importing External Geometry File Using the debugger we will trace the function for importing external geometry The main steps are: Attach the debugger to DM process Attach a Break Point at ageventhandler In DM, click on File Import External Geometry Watch the eventid and proceed to the relevant functions In this case eventid is 1005 The function call for this event is: agfilehanlder() 28

29 Importing External Geometry (2) Enter into this function Locate the case for this eventid The function call for this event is: agmenufileimport() Enter into this function You will notice that if the filename is undefined, it pops up a file browser 29

30 Importing External Geometry (3) Once a file is selected, it moves on to CreateImport(fName) Add watch to find out fname fname is filename of the geometry file with absolute path This is the function we were looking for! Exit debugger Create a java script file cadimport.js Type the command ag.gui.createimport(path) OR, ag.agapplet.script.agmenufileimport(path) Replace path with the filename and path Example: D:\\Temp\\box.stp Run the java script in DM (File Run Script) You will notice that a Generate call is required to complete the process! All the functions available in AGPages/scripts folder can be called this way! Automatic generation can be achieved by adding a line at the end of your file agb.regen() 30

31 Example: Accessing existing body and tracing its feature till edges Using the feature manager we will trace attributes of existing body Attributes of faces Attributes of edges The main steps are: Accessing the existing body Finding its label Selecting all faces of body Accessing individual attributes of faces Accessing information related to individual edges of faces! Note: When multiple bodies are present in the model, individual bodies or entities can be selected using the Label of the entities using ag.m.findentity(0, 0, Label, 0); Last argument is for multiple selection. Making it 1 will add to previous selection. 31

32 Step-1 Accessing body and Finding its Label Start with existing Model which has one body Enquire number of bodies ag.agapplet.featuremgr.bodycount Access the existing body Use ag.agapplet.featuremgr.body(0) to find all attributes of the body Ex: ag.agapplet.featuremgr.body(0).label returns the label of body Ex: ag.agapplet.featuremgr.body(0).faces returns the number of faces Store the Label Bodies can be traced out using the Label Alternatively refer the code below! Note: You can select and access body by it s index when multiple bodies are present in the model 32

33 Step-2 Accessing the faces/edges of selected body Access the faces of the body In order to access the faces of the body, we need to find the Label of the body first Steps the access faces Clear existing selections Selection the body with the help of stored label ag.m.findentity(0, 0, Label, 0); To select all faces of selected body use following command ag.m.selectionmgr.showtopologicalconnections(0); Access the number of faces selected and store value using variable var FC = ag.m.getfacesellistsize() FC returns number of faces in selection manager Access attributes of each face var FC1 = ag.m.getfacesellistindex(0) FC1 returns attributes of 1 st face FC1.Label returns the Label of the face FC1.Edges.Item(1) returns the attributes of 1 st edge! Note: Index starts at 0 for ag.m.getfacesellistindex() Index starts at 1 for Edges.Item() 33

34 Step-3 Accessing Edges from Selected face Clear all selections and Select the face using it s Label stored previously and hide all other faces To Selection the face with the help of stored label ag.m.findentity(0, 0, Label, 0); To select all edges of selected face use following command ag.m.selectionmgr.showtopologicalconnections(0); Access the Edge length and Label Length of edge can be access using ag.m.getedge3dsellistindex(0).length Edge Label can be accessed from ag.m.getedge3dsellistindex(0).label 34

35 Summary DesignModeler supports JScript for scripting/customization All script files can be run from File Run Script API s that are documented can be located in the documentation: //DesignModeler // Scripting API Other functions can be located in the Aisol\AGP\AGPages\scripts Functions for GUI operations can be traced by attaching a debugger to the DM process Almost all manual DesignModeler processes can be customized 35