Difference between revisions of "AnyWave:BuildSDK"

From WikiMEG
Jump to: navigation, search
(Created page with "College will be among the most spectacular, important, and influential moments of your life time and is something that all people should seriously consider. This article will ...")
 
(Created page with "Before developing a plug-in for AnyWave, the developer must download and build the SDK.<br /> The SDK is available here: https://github.com/anywave/aw-sdk<br /> Note that you ...")
Line 1: Line 1:
−
College will be among the most spectacular, important, and influential moments of your life time and is something that all people should seriously consider. This article will provide you with some helpful advice about living the college life and getting through all those exams and lectures. This is good stuff! Pay attention!<br><br>When preparing to attend college, sit down and write a list of all the items you'll need to bring. Even if you are attending school close to home, it is much more convenient to have everything with you rather than calling your parents to deliver things. This is even more important if you will be attending school out of state.<br><br>Make sure you are familiar with you schedule as well as the location of your classes before school starts. Determine how long it takes you to travel from one spot to the next, and map a route. Mark your classes as well as other important locations, such as the library, on a map for easy reference until you learn them.<br><br>During college, become involved in lots of activities. The more activities you're interested and participated in, the better that resume will end up looking. Do not do so much that your grades suffer, however.<br><br>The environment in which you study can make a world of difference. Your dorm room is rarely a great place to study. Find a quiet area, like the library, to do your work. If you beloved this article so you would like to receive more info about online phlebotomy classes ([http://Ptm.uthm.Edu.my/s/8YA click through the next web page]) i implore you to visit our own web site. You should opt for the library. When all else fails, use headphones with noise-cancelling abilities.<br><br>When it comes to succeeding in college, there are many influential factors. In fact, even your choice of seat can make a difference. Rather than arriving to class right on the dot and being forced to sit in the back, arrive early and sit in the front. This shows your professor that you are involved and serious about your education.<br><br>Take the time to apply for an intern position during your college stay. An internship gives you a chance to experience what life can be like after you graduate from college. You could possibly get offered a job because of it. All schools have an internship program, so take advantage of it.<br><br>If you have debts with a credit card company, pay them off monthly. This is the only way to avoid penalties and late fees. Credit cards should only be used in certain situations. Sometimes you may want to use it, but you should refrain and use the cash that you have. Financial issues can distract you.<br><br>Have a good relationship with professors. Professors represent an incredible resource and have lots of help to offer students. Also, ask questions if you are unsure of a certain topic. Creating a relationship with your professor will help you to get ahead in many ways, both during and after college.<br><br>If you must carry a credit card, make sure you pay the balance monthly. This keeps you from paying interest. Credit cards should only be used in certain situations. Although you may want to use it for luxuries or socializing, be strict with yourself about your finances. You don't want to add any more than necessary to your college-related debts.<br><br>If coffee is your passion, try not to purchase it each and every day. The cost really adds up! Brew up your own coffee. You are going to save a lot of cash, even if it isn't as convenient as buying it. The amount of money you save will allow you to purchase a great coffee machine.<br><br>It can be hard to go to college for the first time. It is not very easy to go to college and start your new life away from home, this article can help.
+
Before developing a plug-in for AnyWave, the developer must download and build the SDK.<br />
 +
The SDK is available here: https://github.com/anywave/aw-sdk<br />
 +
Note that you can also try to build the complete AnyWave software which includes the SDK.<br />
 +
AnyWave git repository is available here: https://github.com/anywave/anywave<br />
 +
 
 +
=Clone the SDK repository=
 +
We suggest cloning the repository in a folder named '''AwSDK_src''' (for example) to make a clear difference between source folder and build folder.
 +
 
 +
* On Linux or Mac systems this can be done in a terminal with the following command: '''git clone https://github.com/anywave/sdk AwSDK_src'''
 +
* On Windows, we strongly suggest to install the TortoiseGit Software, freely available at https://code.google.com/p/tortoisegit/wiki/Download
 +
 
 +
=Software requirements=
 +
A C/C++ compiler is required. Linux and Mac versions of AnyWave were built using the gcc/g++ compiler which is the most common compiler on these platforms.<br />
 +
 
 +
The Windows version was built with '''Visual Studio 2008''', so it is strongly advised to use the same IDE to build plug-ins that will run with the Windows version of AnyWave.<br />
 +
However, it is possible to rebuild the complete AnyWave application using another C++ compiler and to set that version as the SDK to build plug-ins.<br />
 +
This choice will raise a binary incompatibility with the distributed Windows package and the developed plug-ins. See AnyWave compatibility section.
 +
 
 +
On Mac OS X, '''XCode''' must be installed to provide access to the gcc/g++ compiler.<br />
 +
'''XCode.app''' is freely available on the App Store.
 +
 
 +
To successfully build the SDK, at least three software must be installed on the computer:
 +
* The Qt4 framework
 +
* The VTK library (version 5.4.2 to 5.8 will work)
 +
* CMake 2.8 or greater.
 +
 
 +
==The Qt Framework==
 +
Mac Developers can download the Qt framework here: [http://meg.univ-amu.fr/AnyWave/qt-mac-opensource-4.8.5.dmg Qt Framework for Mac]
 +
 
 +
Linux developers can install the Qt frameworks by installing the qt4-dev-tools package.
 +
 
 +
Windows developers can download source versions of Qt here: http://download.qt.io/archive/qt/4.8/4.8.6/
 +
 
 +
Build Qt from source with Visual Studio to match the binary version of AnyWave.
 +
 
 +
==The VTK Library==
 +
Have a look at the [http://www.vtk.org/Wiki/VTK/Configure_and_Build#On_Unix-like_operating_systems VTK Wiki page] to build VTK for your system.
 +
 
 +
Note that you must build the VTK versions 5.4 to 5.8.
 +
 
 +
Versions 6.x are not compatible with the current version of AnyWave.
 +
 
 +
==AnyWave compatibility==
 +
When building a plug-in, the developer has two choices:
 +
* Build for the currently distributed binary version of AnyWave.
 +
* Build for its own AnyWave version built from the sources available on github.
 +
 
 +
===Plug-ins for the binary distributed package of AnyWave===
 +
Pay attention that if the plug-in must work with the distributed binary versions of AnyWave it must match more requirements:
 +
* Qt4 must be 4.8.2 to work with the Linux debian packaged version of AnyWave.
 +
* Qt4 must be 4.8.1 to 4.8.5 to work with the Mac OS X version.
 +
* Qt4 must be 4.8.1 to 4.8.6 to work with the Windows versions. (Note that the Windows version will soon only support 64bit systems)
 +
* VTK library must be 5.4.2 to 5.8.xx (VTK 6.x will not work)
 +
 
 +
The Linux and Mac versions have been built with the gcc compiler and therefore will use the glibc library.<br />
 +
On Mac systems, the XCode software must be installed to get access to the gcc compiler.
 +
 
 +
'''ATTENTION:''' The Windows version of AnyWave was built with Visual Studio 2008. Therefore, the plug-in must also be built using Visual Studio 2008 for binary compatibility.
 +
 
 +
===Plug-ins for the developer version of AnyWave===
 +
If a developer plans to build plug-ins that will stay private, it is up to him/her not to match the requirements previously mentioned.
 +
 
 +
=Building AnyWave from sources and use it as the SDK=
 +
As mentioned before, the developer is free to use the complete AnyWave source code as SDK.<br />
 +
The requirements to build AnyWave are the same than for the SDK.<br />
 +
Follow the instructions available when cloning [https://github.com/anywave/anywave the anywave repository] to build AnyWave.
 +
 
 +
=Choose the SDK folder=
 +
The first thing to do is to create a build folder with an explicit name, for example: '''AwSDK''', that will be the root of the SDK.<br />
 +
 
 +
We will consider for the following explanations that the folder is named '''AwSDK''' and is located in '''/home/user/Dev/AwSDK'''<br />
 +
We will consider that the git repository was cloned in a folder named '''AwSDK_src'''
 +
 
 +
==Run cmake==
 +
Open a terminal and go to the SDK folder:<br />
 +
''cd /home/user/Dev/AwSDK''
 +
 
 +
Launch cmake from the source repository:<br />
 +
''cmake ../AwSDK_src''
 +
 
 +
If Qt and VTK were successfully detected, then type:<br />
 +
''make install''
 +
 
 +
This will build install headers and libraries in the AwSDK folder.<br />
 +
You are ready to build a plug-in.

Revision as of 12:03, 23 March 2015

Before developing a plug-in for AnyWave, the developer must download and build the SDK.
The SDK is available here: https://github.com/anywave/aw-sdk
Note that you can also try to build the complete AnyWave software which includes the SDK.
AnyWave git repository is available here: https://github.com/anywave/anywave

Clone the SDK repository

We suggest cloning the repository in a folder named AwSDK_src (for example) to make a clear difference between source folder and build folder.

Software requirements

A C/C++ compiler is required. Linux and Mac versions of AnyWave were built using the gcc/g++ compiler which is the most common compiler on these platforms.

The Windows version was built with Visual Studio 2008, so it is strongly advised to use the same IDE to build plug-ins that will run with the Windows version of AnyWave.
However, it is possible to rebuild the complete AnyWave application using another C++ compiler and to set that version as the SDK to build plug-ins.
This choice will raise a binary incompatibility with the distributed Windows package and the developed plug-ins. See AnyWave compatibility section.

On Mac OS X, XCode must be installed to provide access to the gcc/g++ compiler.
XCode.app is freely available on the App Store.

To successfully build the SDK, at least three software must be installed on the computer:

  • The Qt4 framework
  • The VTK library (version 5.4.2 to 5.8 will work)
  • CMake 2.8 or greater.

The Qt Framework

Mac Developers can download the Qt framework here: Qt Framework for Mac

Linux developers can install the Qt frameworks by installing the qt4-dev-tools package.

Windows developers can download source versions of Qt here: http://download.qt.io/archive/qt/4.8/4.8.6/

Build Qt from source with Visual Studio to match the binary version of AnyWave.

The VTK Library

Have a look at the VTK Wiki page to build VTK for your system.

Note that you must build the VTK versions 5.4 to 5.8.

Versions 6.x are not compatible with the current version of AnyWave.

AnyWave compatibility

When building a plug-in, the developer has two choices:

  • Build for the currently distributed binary version of AnyWave.
  • Build for its own AnyWave version built from the sources available on github.

Plug-ins for the binary distributed package of AnyWave

Pay attention that if the plug-in must work with the distributed binary versions of AnyWave it must match more requirements:

  • Qt4 must be 4.8.2 to work with the Linux debian packaged version of AnyWave.
  • Qt4 must be 4.8.1 to 4.8.5 to work with the Mac OS X version.
  • Qt4 must be 4.8.1 to 4.8.6 to work with the Windows versions. (Note that the Windows version will soon only support 64bit systems)
  • VTK library must be 5.4.2 to 5.8.xx (VTK 6.x will not work)

The Linux and Mac versions have been built with the gcc compiler and therefore will use the glibc library.
On Mac systems, the XCode software must be installed to get access to the gcc compiler.

ATTENTION: The Windows version of AnyWave was built with Visual Studio 2008. Therefore, the plug-in must also be built using Visual Studio 2008 for binary compatibility.

Plug-ins for the developer version of AnyWave

If a developer plans to build plug-ins that will stay private, it is up to him/her not to match the requirements previously mentioned.

Building AnyWave from sources and use it as the SDK

As mentioned before, the developer is free to use the complete AnyWave source code as SDK.
The requirements to build AnyWave are the same than for the SDK.
Follow the instructions available when cloning the anywave repository to build AnyWave.

Choose the SDK folder

The first thing to do is to create a build folder with an explicit name, for example: AwSDK, that will be the root of the SDK.

We will consider for the following explanations that the folder is named AwSDK and is located in /home/user/Dev/AwSDK
We will consider that the git repository was cloned in a folder named AwSDK_src

Run cmake

Open a terminal and go to the SDK folder:
cd /home/user/Dev/AwSDK

Launch cmake from the source repository:
cmake ../AwSDK_src

If Qt and VTK were successfully detected, then type:
make install

This will build install headers and libraries in the AwSDK folder.
You are ready to build a plug-in.

Retrieved from "https://meg.univ-amu.fr/index.php?title=AnyWave:BuildSDK&oldid=24266"