More precise build guide for Matlab

parent 9d57d59d
...@@ -5,11 +5,26 @@ VAMatlab is a binding to the VA interface for Matlab. It uses the VA network con ...@@ -5,11 +5,26 @@ VAMatlab is a binding to the VA interface for Matlab. It uses the VA network con
### License ### License
See [LICENSE](LICENSE.md) file. Copyright 2015-2016 Institute of Technical Acoustics, RWTH Aachen University
Licensed under the Apache License, Version 2.0 (the "License");
you may not use files of this project except in compliance with the License.
You may obtain a copy of the License at
<http://www.apache.org/licenses/LICENSE-2.0>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Quick build guide ### Quick build guide
#### Visual Studio
Generate VA with the Matlab binding flag activated. It will generate the Matlab executable. You will then have to generate the itaVA Matlab facade class, see below.
#### Matlab executable #### Matlab executable
...@@ -23,12 +38,15 @@ To also include a lightweight Optitrack tracker connection using the NatNetSDK, ...@@ -23,12 +38,15 @@ To also include a lightweight Optitrack tracker connection using the NatNetSDK,
#### itaVA class #### itaVA class
To ease usage, a facade class called `itaVA` can be generated that will also add volatile help on the available functionality of VA. To ease usage, a facade class called `itaVA` can be generated that will also add volatile help on the available functionality of VA.
To create this Matlab class, run `itaVA_build.m`, which will create a class file `itaVA.m` based on stubs that are filled by calls to the VAMatlab executable, which has to be build prior. To create this Matlab class, run either `itaVA_build.m` after deploy of VA, or `itaVA_build_absolute.m` from the repository directory.
Both scripts will create a class file named `itaVA.m` based on stubs that are filled by calls to the VAMatlab executable, which has to be build prior.
> Make sure that Matlab will use the correct VA Matlab executable and not an older version of it which might have been added to the PATH of Matlab. > Make sure that Matlab will use the correct VA Matlab executable and not an older version of it which might have been added to the PATH of Matlab.
#### Deploy #### Deploy
If the deploy script is not used, manual deploy will include the following:
Deploying the Matlab executable will require to copy all necessary DLLs into a deploy directory (next to the VAMatlab executable file). Deploying the Matlab executable will require to copy all necessary DLLs into a deploy directory (next to the VAMatlab executable file).
On Windows platform, provide the following files On Windows platform, provide the following files
- VistaAspects.dll - VistaAspects.dll
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment