Difference between revisions of "NatNet: Sample Projects"

(NatNet Sample Projects)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
  [[Main Page|Back to the Main page]] → [[NatNet SDK|Back to the NatNet SDK page]]
+
  [[Main Page|Main page]] → [[NatNet SDK 3.0|NatNet SDK]] → [[NatNet: Sample Projects]]
 
----
 
----
  
Line 15: Line 15:
 
=NatNet Sample Projects=
 
=NatNet Sample Projects=
 
----
 
----
 
 
The following projects are located in the <code>NatNet SDK\Samples</code> folder.
 
The following projects are located in the <code>NatNet SDK\Samples</code> folder.
  
 
+
====NatNet SDK Samples====
'''NatNet SDK Samples'''
+
  
 
:The following sample projects utilizes NatNet SDK library for obtaining tracking data from a connected server application.
 
:The following sample projects utilizes NatNet SDK library for obtaining tracking data from a connected server application.
Line 30: Line 28:
 
|style = "padding: 1em;"|[[#Running_the_Matlab_Sample|Matlab]]
 
|style = "padding: 1em;"|[[#Running_the_Matlab_Sample|Matlab]]
 
|style = "padding: 1em;"|Managed: Matlab
 
|style = "padding: 1em;"|Managed: Matlab
|style = "padding: 1em;"|Sample MATLAB code file (.m) for using MATLAB with the NatNet managed assembly (NatNetML.dll).
+
|style = "padding: 1em;"|Sample MATLAB code file (.m) for using MATLAB with the NatNet managed assembly (NatNetML.dll) using the provided [[NatNet:_Matlab_Wrapper|natnet.p wrapper]] class.  
|-
+
|style = "padding: 1em;"|[[NatNet: Matlab Wrapper|MatlabWrapper]]
+
|style = "padding: 1em;"|Managed: Matlab
+
|style = "padding: 1em;"|Wrapper class for the NatNetML assembly members, allowing command line access to the client object.
+
 
|-
 
|-
|style = "padding: 1em;"|RebroadcastMotiveData
+
|style = "padding: 1em;"|[[NatNet: RebroadcastMotiveData Sample|RebroadcastMotiveData]]
 
|style = "padding: 1em;"|Native: C++
 
|style = "padding: 1em;"|Native: C++
 
|style = "padding: 1em;"|Sample application that receives tracking data from the NatNet Server and redistributing it in other forms. Currently there are two protocols supported for pipelining tracking data into Unity via compatible XML packets and into Previzion software via serial port interface.
 
|style = "padding: 1em;"|Sample application that receives tracking data from the NatNet Server and redistributing it in other forms. Currently there are two protocols supported for pipelining tracking data into Unity via compatible XML packets and into Previzion software via serial port interface.
Line 56: Line 50:
 
|style = "padding: 1em;"|SampleClientML
 
|style = "padding: 1em;"|SampleClientML
 
|style = "padding: 1em;"|Managed: .NET (C#)
 
|style = "padding: 1em;"|Managed: .NET (C#)
|style = "padding: 1em;"|Sample NatNet C# console appication that connects to a NatNet server on the local IP address, receives data stream, and outputs the received data.
+
|style = "padding: 1em;"|Sample NatNet C# console appication that connects to a NatNet server on the local IP address, receives data stream, and outputs the received data. '''Note: [[Data Streaming pane#Streaming SEttings|Skeleton As Rigid Bodies]] must be set to false.'''
 
|-
 
|-
 
|style = "padding: 1em;"|TimingClient
 
|style = "padding: 1em;"|TimingClient
 
|style = "padding: 1em;"|Native: C++
 
|style = "padding: 1em;"|Native: C++
 
|style = "padding: 1em;"|This program connects to a NatNet server and can be used as a quick check to determine packet timing information.
 
|style = "padding: 1em;"|This program connects to a NatNet server and can be used as a quick check to determine packet timing information.
|-
 
|style = "padding: 1em;"|[[#Running the Unity3D Sample|Unity3D]]
 
|style = "padding: 1em;"|Native: C++
 
|style = "padding: 1em;"|This program demonstrates streaming rigid body and skeleton tracking data from Motive into Unity via UDP. This application encodes skeleton data into the XML format for streaming into Unity.
 
 
|-
 
|-
 
|style = "padding: 1em;"|[[#Running_the_.NET_Sample|WinFormsSample]]
 
|style = "padding: 1em;"|[[#Running_the_.NET_Sample|WinFormsSample]]
 
|style = "padding: 1em;"|Managed: C# .NET
 
|style = "padding: 1em;"|Managed: C# .NET
|style = "padding: 1em;"|Simple C# .NET sample showing how to use the NatNet managed assembly (NatNETML.dll).  This sample also demonstrates how to send and receive the NatNet commands.
+
|style = "padding: 1em;"|Simple C# .NET sample showing how to use the NatNet managed assembly (NatNetML.dll).  This sample also demonstrates how to send and receive the NatNet commands.
 
|}
 
|}
  
 
+
====Direct Depacketization Samples====
 
+
 
+
'''Direct Depacketization Samples'''
+
  
 
:The following sample projects do not use the NatNet SDK library. Client/Server connection is established at a low-level by creating sockets and threads within the program, and the streamed data are depacketized directly from the bit-stream syntax. The following sample approaches should be used only when the use of NatNet SDK library is not applicable (e.g. streaming into UNIX clients).
 
:The following sample projects do not use the NatNet SDK library. Client/Server connection is established at a low-level by creating sockets and threads within the program, and the streamed data are depacketized directly from the bit-stream syntax. The following sample approaches should be used only when the use of NatNet SDK library is not applicable (e.g. streaming into UNIX clients).
Line 93: Line 80:
  
  
'''XML trigger broadcast'''
+
====XML trigger broadcast====
  
 
:The following samples demonstrate how to use remote triggering in Motive using the [[Data Streaming#Remote Triggering|XML formatted UDP broadcase packets]].
 
:The following samples demonstrate how to use remote triggering in Motive using the [[Data Streaming#Remote Triggering|XML formatted UDP broadcase packets]].
Line 111: Line 98:
 
|}
 
|}
  
 +
==Running the Console Output Sample (Sample Client)==
  
<div style="padding-left:2em>
+
<div class="padded">
=Running the Console Output Sample (Sample Client)=
+
 
+
<div style="padding-left:2em;">
+
 
===On Windows===
 
===On Windows===
<div style="padding-left:2em;">
+
<div class="padded">
 
'''1. [Motive]''' Start the Optitrack Server (e.g. Motive) and begin streaming data via the Streaming Panel.
 
'''1. [Motive]''' Start the Optitrack Server (e.g. Motive) and begin streaming data via the Streaming Panel.
  
  
'''2. [Command Prompt]''' Start the client from the windows command prompt:''' <code>SampleClient.exe [ClientIPAddress] [ServerIPAddress] [OutputFilename.txt]</code>
+
'''2. [SampleClient]''' Start the client application from the command prompt or directly from the <code>NatNet SDK/Samples/bin</code> folder.
  
[[Image:SampleClient.png|thumb|700 px|center|Running the SampleClient project from the windows command prompt.]]
 
  
 +
'''3. [SampleClient]''' Once the sample application starts up, it will search the local network and list out IP addresses of available tracking servers where tracking data is streamed from. Select a server address by pressing the corresponding number key.
  
'''3. [Command Prompt]''' You should begin to see data streaming in the client window or to text file.'''
+
[[Image:NatNet_SampleClient_30.png|thumb|700 px|center|Motive is streaming to the local loopback address, and it is detected by the SampleClient application.]]
  
[[Image:SampleClient2.png|thumb|700 px|center|Running the SampleClient project from the windows command prompt.]]
 
</div>
 
  
 +
'''4. [SampleClient]''' The client application is connected to the local loopback address (127.0.0.1) and receiving tracking data.
  
===On Linux===
+
[[Image:NatNet_SampleClient2_30.png|thumb|700 px|center|Running the SampleClient project from the windows command prompt.]]
 +
</div>
  
For building and running the SampleClient application, the Linux machine must have gcc/g++ compiler installed. Also, this project links against a third party library named ''ncurses'' at both build and run-time. Make sure the required compiler and the third-party library is installed on the machine.
 
 
<div style="padding-left:2em;">
 
'''1. [Server]''' Start an Optitrack Server (e.g. Motive from another machine) and begin streaming data via the Streaming Panel.
 
 
'''2. [Linux]'''  Open a shell prompt and set the directory to the <code>samples/SampleClient</code> folder in the uncompressed NatNet SDK directory.
 
 
'''3. [Linux]'''  In the shell, enter <code>make clean all</code> and compile the sample.
 
 
'''4. [Linux]'''  Change the directory to the build folder.
 
 
'''5. [Linux]'''  To run the compiled sample, the directory of the NatNet library must be specified. To do this, enter <code>export LD_LIBRARY_PATH=$LD_LIBRARY_PATH: ''{lib folder directory}''</code> as shown in the image below.
 
 
'''6. [Linux]'''  Now Start the client from the shell with designated server and client IP address:<code>SampleClient.exe [ClientIPAddress] [ServerIPAddress] [OutputFilename.txt]</code>. Default setting is set to the local loopback address.
 
 
[[Image:SampleClient_ScreenShot_Good.png|thumb|700px|center|SampleClient running on Linux]]
 
</div>
 
 
</div>
 
</div>
  
 
+
==Running the Rigid Body Sample (SampleClient3D)==
=Running the Rigid Body Sample (SampleClient3D)=
+
  
 
<div style="padding-left:2em;">
 
<div style="padding-left:2em;">
 
The Rigid Body sample (SampleClient3D) illustrates how to decode NatNet 6DOF Rigid Body and Skeleton Segment data from OptiTrack quaternion format to euler angles and display them in a simple OpenGL 3D viewer.  This sample also illustrates how to associate RigidBody/Skeleton Segment names and IDs from the data descriptions with the IDs streamed in the FrameOfMocapData packet.
 
The Rigid Body sample (SampleClient3D) illustrates how to decode NatNet 6DOF Rigid Body and Skeleton Segment data from OptiTrack quaternion format to euler angles and display them in a simple OpenGL 3D viewer.  This sample also illustrates how to associate RigidBody/Skeleton Segment names and IDs from the data descriptions with the IDs streamed in the FrameOfMocapData packet.
  
 
+
===With Client/Server on same machine:===
'''With Client/Server on same machine:'''
+
 
<div style="padding-left:2em;">
 
<div style="padding-left:2em;">
 
'''1. [Motive]''' Load a dataset with rigid body or skeleton definitions
 
'''1. [Motive]''' Load a dataset with rigid body or skeleton definitions
Line 171: Line 137:
 
</div>
 
</div>
  
 
+
===With Client/Server on separate machines:===
'''With Client/Server on separate machines:'''
+
  
 
<div style="padding-left:2em;">
 
<div style="padding-left:2em;">
Line 194: Line 159:
 
[[Image:NatNetSampleClient3D.png|thumb|center|800 px|SampleClient3D - Decoding and draqing labeled rigid body position and orientation (6DoF) data.]]
 
[[Image:NatNetSampleClient3D.png|thumb|center|800 px|SampleClient3D - Decoding and draqing labeled rigid body position and orientation (6DoF) data.]]
  
 
+
==Running the .NET Sample==
=Running the .NET Sample=
+
<div class="padded">
<div style="padding-left:2em;">
+
 
'''1. [Motive]''' Start a NatNet server application  (e.g. Motive).
 
'''1. [Motive]''' Start a NatNet server application  (e.g. Motive).
  
Line 207: Line 171:
 
'''5. [WinFormTestApp]''' Press  the “Connect” button to connect to the server.
 
'''5. [WinFormTestApp]''' Press  the “Connect” button to connect to the server.
  
'''6. [WinFormTestApp]''' Press the “GetDataDesc” button to request and display a detailed description of the Server’s currently streamed objects.
+
'''6. [WinFormTestApp]''' Press the “Get Data Descriptions” button to request and display a detailed description of the Server’s currently streamed objects.
  
 
'''7. [WinFormTestApp]''' Select a Row in the DataGrid to display that value in the graph.
 
'''7. [WinFormTestApp]''' Select a Row in the DataGrid to display that value in the graph.
Line 213: Line 177:
  
  
[[Image:NatNetWinFormSample.png|thumb|center|750 px|Receiving tracking data via NatNet in a .NET environment.]]
+
<center><ul>
[[Image:NatNetWinFormSampleRemote.png|thumb|center|400 px|Issuing remote control commands to Motive.]]
+
<li style="display:inline-block; vertical-align:text-top">[[Image:NatNetWinFormSample.png|thumb|center|600 px|Receiving tracking data via NatNet in a .NET environment.]]</li>
 
+
<li style="display:inline-block; vertical-align:text-top">[[Image:NatNetWinFormSampleRemote.png|thumb|center|400 px|Issuing remote control commands to Motive.]]</li>
 
+
</ul></center>
=Running the Matlab Sample=
+
  
 +
==Running the Matlab Sample==
 
<div style="padding-left:2em;">
 
<div style="padding-left:2em;">
 
'''1. [Motive]''' Start a NatNet server application  (e.g. Motive).
 
'''1. [Motive]''' Start a NatNet server application  (e.g. Motive).
Line 226: Line 190:
 
'''3. [Matlab]''' Start Matlab
 
'''3. [Matlab]''' Start Matlab
  
'''4. [Matlab]''' Open the NatNetMatlabSample.m file.
+
'''4. [Matlab]''' Open the NatNetPollingSample.m file.
  
 
'''5. [Matlab]'''  From the editor window, press Run
 
'''5. [Matlab]'''  From the editor window, press Run
Line 233: Line 197:
  
 
[[Image:NatNetMatlab.png|thumb|center|750 px|Rael-time streaming mocap data from Motive into Matlab.]]
 
[[Image:NatNetMatlab.png|thumb|center|750 px|Rael-time streaming mocap data from Motive into Matlab.]]
</div>
 
  
  
 
[[Category:NatNet SDK]]
 
[[Category:NatNet SDK]]

Latest revision as of 11:58, 28 June 2018

Main pageNatNet SDKNatNet: Sample Projects


This page lists out the NatNet sample applications provided with the SDK and provides instructions for some of the samples. The code samples are the quickest path towards getting NatNet data into your application. We typically recommend you:

1. Identify your application’s development/interface requirements (managed, native, etc).
2. Adapt the NatNet sample code from the corresponding NatNet sample application in the samples folder into your application.
3. Use the API reference in the next page for additional information.

The Visual Studio solution file \Samples\NatNetSamples.sln will open and build all of the NatNet sample projects. If you are creating an application from scratch, please refer to the following sections for application specific requirements.

NatNet Sample Projects[edit]


The following projects are located in the NatNet SDK\Samples folder.

NatNet SDK Samples[edit]

The following sample projects utilizes NatNet SDK library for obtaining tracking data from a connected server application.
Sample Name NatNet Library Type Description
Matlab Managed: Matlab Sample MATLAB code file (.m) for using MATLAB with the NatNet managed assembly (NatNetML.dll) using the provided natnet.p wrapper class.
RebroadcastMotiveData Native: C++ Sample application that receives tracking data from the NatNet Server and redistributing it in other forms. Currently there are two protocols supported for pipelining tracking data into Unity via compatible XML packets and into Previzion software via serial port interface.
MayaPlugIn Native: C++ GitHub open source project: mayaMotive
SampleClient Native: C++ Sample NatNet console app that connects to a NatNet server, receives a data stream, and writes that data stream to an ASCII file. This sample


SampleClient3D Native: C++ Sample NatNet application that connects to a NatNet server, receives a data stream, and displays that data in an OpenGL 3D window.
SampleClientML Managed: .NET (C#) Sample NatNet C# console appication that connects to a NatNet server on the local IP address, receives data stream, and outputs the received data. Note: Skeleton As Rigid Bodies must be set to false.
TimingClient Native: C++ This program connects to a NatNet server and can be used as a quick check to determine packet timing information.
WinFormsSample Managed: C# .NET Simple C# .NET sample showing how to use the NatNet managed assembly (NatNetML.dll). This sample also demonstrates how to send and receive the NatNet commands.

Direct Depacketization Samples[edit]

The following sample projects do not use the NatNet SDK library. Client/Server connection is established at a low-level by creating sockets and threads within the program, and the streamed data are depacketized directly from the bit-stream syntax. The following sample approaches should be used only when the use of NatNet SDK library is not applicable (e.g. streaming into UNIX clients).
Sample Name Type Description
PacketClient C++ Simple example showing how to connect to a NatNet multicast stream and decode NatNet packets directly without using the NatNet SDK.
PythonClient Python Sample Python code file (.py) for using Python with NatNet streaming. This sample depacketizes data directly from the bit-stream without using the library.


XML trigger broadcast[edit]

The following samples demonstrate how to use remote triggering in Motive using the XML formatted UDP broadcase packets.
Sample Name Type Description
BroadcastSample C++ XML broadcast. Sample application illustrating how to use remote record trigger in Motive using XML formatted UDP broadcast packets.
NatCap C++ XML broadcast. Sample capture start/stop trigger broadcast app.

Running the Console Output Sample (Sample Client)[edit]

On Windows[edit]

1. [Motive] Start the Optitrack Server (e.g. Motive) and begin streaming data via the Streaming Panel.


2. [SampleClient] Start the client application from the command prompt or directly from the NatNet SDK/Samples/bin folder.


3. [SampleClient] Once the sample application starts up, it will search the local network and list out IP addresses of available tracking servers where tracking data is streamed from. Select a server address by pressing the corresponding number key.

Motive is streaming to the local loopback address, and it is detected by the SampleClient application.


4. [SampleClient] The client application is connected to the local loopback address (127.0.0.1) and receiving tracking data.

Running the SampleClient project from the windows command prompt.

Running the Rigid Body Sample (SampleClient3D)[edit]

The Rigid Body sample (SampleClient3D) illustrates how to decode NatNet 6DOF Rigid Body and Skeleton Segment data from OptiTrack quaternion format to euler angles and display them in a simple OpenGL 3D viewer. This sample also illustrates how to associate RigidBody/Skeleton Segment names and IDs from the data descriptions with the IDs streamed in the FrameOfMocapData packet.

With Client/Server on same machine:[edit]

1. [Motive] Load a dataset with rigid body or skeleton definitions

2. [Motive] Enable network streaming ( Data Streaming Pane -> Check Broadcast Frame Data )

3. [Motive] Enable streaming rigid body data (check Stream Options -> Stream Rigid Bodies = True)

4. [Sample3D] File -> Connect

With Client/Server on separate machines:[edit]

1. [Motive] Load a dataset with rigid body or skeleton definitions

2. [Motive] Set IP address to stream from (Network Interface Selection -> Local Interface)

3. [Motive] Enable network streaming ( Data Streaming Pane -> Check Broadcast Frame Data )

4. [Motive] Enable streaming rigid body data (check Stream Options -> Stream Rigid Bodies = True)

5. [Sample3D] Set Client and Server IP addresses

6. [Sample3D] File -> Connect

  • IP Address IP Address of client NIC card you wish to use.
  • Server IP Address IP Address of server entered in step 2 above.


SampleClient3D - Decoding and draqing labeled rigid body position and orientation (6DoF) data.

Running the .NET Sample[edit]

1. [Motive] Start a NatNet server application (e.g. Motive).

2. [Motive] Enable NatNet streaming from the Server application.

3. [WinFormTestApp] Start the WinForms sample application from the NatNet Samples folder.

4. [WinFormTestApp] Update the “Local” and “Server” IP Addresses as necessary.

5. [WinFormTestApp] Press the “Connect” button to connect to the server.

6. [WinFormTestApp] Press the “Get Data Descriptions” button to request and display a detailed description of the Server’s currently streamed objects.

7. [WinFormTestApp] Select a Row in the DataGrid to display that value in the graph.


  • Receiving tracking data via NatNet in a .NET environment.
  • Issuing remote control commands to Motive.

Running the Matlab Sample[edit]

1. [Motive] Start a NatNet server application (e.g. Motive).

2. [Motive] Enable NatNet streaming from the Server application.

3. [Matlab] Start Matlab

4. [Matlab] Open the NatNetPollingSample.m file.

5. [Matlab] From the editor window, press Run


Rael-time streaming mocap data from Motive into Matlab.