Difference between revisions of "User Guide"
| Line 18: | Line 18: | ||
===Example 1=== | ===Example 1=== | ||
| − | First of all, a Python script is just a plain ASCII text file with a ''.py'' extension. To create one simple open up your favorite text editor. Notepad will do if you have nothing else but I suggest a freeware text editor like [http://www.pspad.com/ PSPad]. | + | First of all, a Python script is just a plain ASCII text file with a ''.py'' extension. To create one simple open up your favorite text editor. Notepad will do if you have nothing else but I suggest a freeware text editor like [http://www.pspad.com/ PSPad]. Code that goes into the python script will be displayed like so: |
| − | All Python code will be shown in a box like this one. | + | # All Python code will be shown in a box like this one. |
| + | # Lines begining with '#' character are comments | ||
In this example, we will create a simple 2x2 plain weave model with a Python script. Its time to dive in and see some actual Python code. At this point if you are completely lost please refer back to the resources on Python programming. The first step is to create an instance of the <code>CTextileWeave2D</code> class and give it a name, <code>weave</code>: | In this example, we will create a simple 2x2 plain weave model with a Python script. Its time to dive in and see some actual Python code. At this point if you are completely lost please refer back to the resources on Python programming. The first step is to create an instance of the <code>CTextileWeave2D</code> class and give it a name, <code>weave</code>: | ||
| + | # Create a 2D weave textile | ||
weave = CTextileWeave2D(2, 2, 1, 0.2, True) | weave = CTextileWeave2D(2, 2, 1, 0.2, True) | ||
| Line 39: | Line 41: | ||
Let's set the weave pattern, this determines whether a warp or weft yarn will appear on top at a particular cross over. Cross overs are arranged in 2d grid where the size of the grid depends on the number of warp and weft yarns created. To swap the positions of the weft and warp yarns, we call the function <code>SwapPosition</code> with the grid coordinates of the cross over. In order to create a plain weave we need to do this on two diagonally opposite cross overs like so: | Let's set the weave pattern, this determines whether a warp or weft yarn will appear on top at a particular cross over. Cross overs are arranged in 2d grid where the size of the grid depends on the number of warp and weft yarns created. To swap the positions of the weft and warp yarns, we call the function <code>SwapPosition</code> with the grid coordinates of the cross over. In order to create a plain weave we need to do this on two diagonally opposite cross overs like so: | ||
| + | # Set the weave pattern | ||
weave.SwapPosition(0, 0) | weave.SwapPosition(0, 0) | ||
weave.SwapPosition(1, 1) | weave.SwapPosition(1, 1) | ||
| Line 44: | Line 47: | ||
Now lets add our <code>weave</code> model to the database of models so that TexGen can render it: | Now lets add our <code>weave</code> model to the database of models so that TexGen can render it: | ||
| + | # Add the textile | ||
AddTextile(weave) | AddTextile(weave) | ||
Thats it! This is a very simple script but it will generate a plain weave model. To recap your Python script should look like this: | Thats it! This is a very simple script but it will generate a plain weave model. To recap your Python script should look like this: | ||
| + | # Create a 2D weave textile | ||
weave = CTextileWeave2D(2, 2, 1, 0.2, True) | weave = CTextileWeave2D(2, 2, 1, 0.2, True) | ||
| + | |||
| + | # Set the weave pattern | ||
weave.SwapPosition(0, 0) | weave.SwapPosition(0, 0) | ||
weave.SwapPosition(1, 1) | weave.SwapPosition(1, 1) | ||
| + | |||
| + | # Add the textile | ||
AddTextile(weave) | AddTextile(weave) | ||
Revision as of 10:38, 22 November 2006
Introduction
There are several ways to interface with TexGen. A little bit of technical information is necessary to understand how this all fits together. The core TexGen functionality has been written in C++, on top of this a Python interface exists that has access to all the C++ functions of TexGen. There are many advantages of a Python interface that may not be immediatly obvious to the end user.
A user friendly Graphical User Interface has been built on top of the Python interface to provide a quick and easy method to interface with TexGen. But the real power comes with writing small Python scripts which will be discussed later.
Graphical User Interface
...
Python Interface
Python is a high level interpreted programming language. In this case it is used as a scripting language to allow easy access to TexGen functionality. Python has been embedded in the TexGen GUI which allows the GUI to run python scripts. It is not the goal of this tutorial to teach Python programming. There are many resources online for that. A few of them are listed below:
- Learn Python in 10 minutes - Quick introduction to Python for competent programmers.
- Python Tutorial - Official Python tutorial (requires some programming knowledge).
- How to Think Like a Computer Scientist: Learning with Python - Book on Python programming for beginners. HTML Version
- Dive Into Python - In depth book covering advanced subjects in a comprehensive manner. HTML Version
An advanced knowledge of Python is not needed in order to write simple TexGen scripts. However, bear in mind that Python is a very powerful language with many libraries included for performing common tasks. I suggest you try to follow through the examples below and if you get stuck refer to one of the documents above.
Example 1
First of all, a Python script is just a plain ASCII text file with a .py extension. To create one simple open up your favorite text editor. Notepad will do if you have nothing else but I suggest a freeware text editor like PSPad. Code that goes into the python script will be displayed like so:
# All Python code will be shown in a box like this one. # Lines begining with '#' character are comments
In this example, we will create a simple 2x2 plain weave model with a Python script. Its time to dive in and see some actual Python code. At this point if you are completely lost please refer back to the resources on Python programming. The first step is to create an instance of the CTextileWeave2D class and give it a name, weave:
# Create a 2D weave textile weave = CTextileWeave2D(2, 2, 1, 0.2, True)
The CTextileWeave2D class takes 5 parameters in the order shown below:
- Number of weft yarns in the unit cell
- Number of warp yarns in the unit cell
- Spacing between the yarns
- Thickness of the fabrics
- Refine model (True/False)
The only parameter that really needs an explanation here is the Refine model option, this controls whether or not the interference correction algorithm will be applied to keep the yarn volumes from intersecting which is a common problem. The interference correction algorithm generally does a good job but is not instantaneous so sometimes it can be beneficial to switch it off.
This is the bare minimum information necessary to create a 2D woven fabric. In the following steps we will add more information to create the model the way we want it.
Let's set the weave pattern, this determines whether a warp or weft yarn will appear on top at a particular cross over. Cross overs are arranged in 2d grid where the size of the grid depends on the number of warp and weft yarns created. To swap the positions of the weft and warp yarns, we call the function SwapPosition with the grid coordinates of the cross over. In order to create a plain weave we need to do this on two diagonally opposite cross overs like so:
# Set the weave pattern weave.SwapPosition(0, 0) weave.SwapPosition(1, 1)
Now lets add our weave model to the database of models so that TexGen can render it:
# Add the textile AddTextile(weave)
Thats it! This is a very simple script but it will generate a plain weave model. To recap your Python script should look like this:
# Create a 2D weave textile weave = CTextileWeave2D(2, 2, 1, 0.2, True)
# Set the weave pattern weave.SwapPosition(0, 0) weave.SwapPosition(1, 1)
# Add the textile AddTextile(weave)
Save it to disk as PlainWeave.py or give it whatever name you want as long as it has a .py extension.
In order to test the Script we need to load it into TexGen. So start up the TexGen GUI and from the Python menu select Run Script. Select the file you have just saved and click ok. With a bit of luck you should see a 2d plain weave on screen.
Congratulations you have created your first TexGen Python script!
Example 2
In the first example we made use of the CTextileWeave2D which is the reason the script is so compact. This was great for creating a 2D Weave, but what if we want to create something other than a 2D Weave? In this example we will create yarns directly rather than through one of the textile sub-classes.
First we will define a general textile and call it Textile:
# Create a textile Textile = CTextile()
The CTextile class doesn't take any parameters, instead yarns will be created and added to it. Next we will create 4 yarns to go inside our textile, it is convenient to make use of the python lists to do this. Create a list called Yarns with 4 elements, each one an instance of the class CYarn:
# Create a python list containing 4 yarns Yarns = [CYarn(), CYarn(), CYarn(), CYarn()]
Yarns now contains 4 empty yarns. Note that the yarns are not currently associated with the Textile, first we must fill in the details then make them a part of the textile. The first thing to do is define their paths with nodes. This is done like so:
# Add nodes to the yarns to describe their paths Yarns[0].AddNode(CNode(XYZ(0, 0, 0))) Yarns[0].AddNode(CNode(XYZ(0.22, 0, 0.05))) Yarns[0].AddNode(CNode(XYZ(0.44, 0, 0)))
Yarns[1].AddNode(CNode(XYZ(0, 0.22, 0.05))) Yarns[1].AddNode(CNode(XYZ(0.22, 0.22, 0))) Yarns[1].AddNode(CNode(XYZ(0.44, 0.22, 0.05)))
Yarns[2].AddNode(CNode(XYZ(0, 0, 0.05))) Yarns[2].AddNode(CNode(XYZ(0, 0.22, 0))) Yarns[2].AddNode(CNode(XYZ(0, 0.44, 0.05)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0, 0))) Yarns[3].AddNode(CNode(XYZ(0.22, 0.22, 0.05))) Yarns[3].AddNode(CNode(XYZ(0.22, 0.44, 0)))
We have added 3 nodes to each yarn creating a woven pattern. The number in the square brackets after Yarns refers to a particular yarn in the list. The function AddNode is then called for the yarn. The parameter to the function takes an instance of the class CNode. The class CNode in turn is constructed with an instance of the class XYZ which represents the position of the node. The class XYZ is constructed with 3 numbers representing the X, Y and Z coordinates of the point.
...
# Create a textile Textile = CTextile()
# Create a python list containing 4 yarns Yarns = [CYarn(), CYarn(), CYarn(), CYarn()]
# Add nodes to the yarns to describe their paths Yarns[0].AddNode(CNode(XYZ(0, 0, 0))) Yarns[0].AddNode(CNode(XYZ(0.22, 0, 0.05))) Yarns[0].AddNode(CNode(XYZ(0.44, 0, 0)))
Yarns[1].AddNode(CNode(XYZ(0, 0.22, 0.05))) Yarns[1].AddNode(CNode(XYZ(0.22, 0.22, 0))) Yarns[1].AddNode(CNode(XYZ(0.44, 0.22, 0.05)))
Yarns[2].AddNode(CNode(XYZ(0, 0, 0.05))) Yarns[2].AddNode(CNode(XYZ(0, 0.22, 0))) Yarns[2].AddNode(CNode(XYZ(0, 0.44, 0.05)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0, 0))) Yarns[3].AddNode(CNode(XYZ(0.22, 0.22, 0.05))) Yarns[3].AddNode(CNode(XYZ(0.22, 0.44, 0)))
# We want the same interpolation and section shape for all the yarns so loop over them all
for Yarn in Yarns:
# Set the interpolation function
Yarn.AssignInterpolation(CInterpolationCubic())
# Assign a constant cross-section all along the yarn of lenticular shape
Yarn.AssignSection(CYarnSectionConstant(CSectionEllipse(0.18, 0.04)))
# Set the resolution of the surface mesh created
Yarn.SetResolution(20)
# Add repeat vectors to the yarn
Yarn.AddRepeat(XYZ(0.44, 0, 0))
Yarn.AddRepeat(XYZ(0, 0.44, 0))
# Add the yarn to our textile
Textile.AddYarn(Yarn)
# Create a domain and assign it to the textile Textile.AssignDomain(CDomainPlanes(XYZ(0, 0, -0.02), XYZ(0.44, 0.44, 0.07)))
# Add the textile with the name "polyester"
AddTextile("polyester", Textile)
