diff --git a/md_README.html b/md_README.html index 484727ac..b38ea072 100644 --- a/md_README.html +++ b/md_README.html @@ -5,7 +5,7 @@ -UnitySensors: UnitySensors +UnitySensors: README @@ -82,16 +82,17 @@
-
UnitySensors
+
README
-

Unity 2022.3.x Test Runner

-

unity_sensors_ros_assets

-

-Overview

-

Robot sensor packages available on Unity. You can communicate sensor info via ROS and ROS2 using ROSTCPConnector and ROSTCPEndpoint.
-

-

The following sensors are added.

+

+UnitySensors

+

+
unity_sensors_ros_assets

+🔍 Overview

+

UnitySensos is a projet that regroup two Unity3D packages that allow you to easly use Unity3D as robotic simulation ! There are several Prefab and Scene files available for testing each sensor.

+

1. UnitySensor

+

The following sensors are available inside :

  • Velodyne 3D LiDAR (Velodyne VLP-16, VLP-16-HiRes, VLP-32, HDL-32E, VLS-128)
  • Livox 3D LiDAR(Avia, Horizon, Mid40, Mid70, Tele, HAP, Mid360)
    • @@ -102,28 +103,42 @@

  • (GroundTruth)
  • (TF)

-

There are several Prefab and Scene files available for testing each sensor.

-

-Dependencies

- -

-Package Installation (For using UnitySensors in your project)

+

2. UnitySensorROS

+

This package is responsible to make the link between sensor and ROS by serializing sensor raw data and sending to them to ROS using ROS-TCP-Connector package. To receive the data in ROS take a look at ROS-TCP-Endpoint.

+

+🚀 Quick start

+

+Inside Unity3D

+
+

[!NOTE]

+

Unitysensor is made for Unity 2021.3 or later

+
    -
  1. Using Unity 2021.3 or later, open the Package Manager from Window -> Package Manager.
    2. +
  2. Open the Package Manager from Window -> Package Manager.
  3. In the Package Manager window, find and click the + button in the upper lefthand corner of the window. Select Add package from git URL....
  4. Enter the git URL for the desired package.
      -
    1. For the UnitySensors, enter https://github.com/Field-Robotics-Japan/UnitySensors.git?path=/Assets/UnitySensors#v2.0.4.
      2. -
    2. For the UnitySensorsROS, enter https://github.com/Field-Robotics-Japan/UnitySensors.git?path=/Assets/UnitySensorsROS#v2.0.4. Note: UnitySensorsROS does not contain UnitySensors.
      3. +
    3. For the UnitySensors, enter https://github.com/Field-Robotics-Japan/UnitySensors.git?path=/Assets/UnitySensors#v2.0.5.
      4. +
    4. For the UnitySensorsROS, enter https://github.com/Field-Robotics-Japan/UnitySensors.git?path=/Assets/UnitySensorsROS#v2.0.5. Note: UnitySensorsROS does not contain UnitySensors.
  5. Click Add.
-

-Documentation

-

-LICENSE

+

+Inside ROS workspace

+
    +
  1. Download lastest release of ROS-TCP-Endpoint.
    2. +
  2. Build your workspace.
    3. +
  3. Launch ROS endpoint node.
    4. +
+

+🤝 Contributing

+
A huge thank you to everyone who is helping to improve UnitySensors !
contributors badge

+🔗 Dependencies

+ +

+📄 LICENSE

Copyright [2020-2024] Ryodo Tanaka (groad.nosp@m.pg@g.nosp@m.mail..nosp@m.com) and Akiro Harada

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

diff --git a/navtreedata.js b/navtreedata.js index e85f8847..bf2d0edb 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -29,12 +29,17 @@ var NAVTREE = [ "README", "md_Assets_UnitySensors_README.html", null ], [ "LICENSE", "md_Assets_UnitySensorsROS_LICENSE.html", null ], [ "README", "md_Assets_UnitySensorsROS_README.html", null ], - [ "UnitySensors", "md_README.html", [ - [ "Overview", "md_README.html#autotoc_md1", null ], - [ "Dependencies", "md_README.html#autotoc_md2", null ], - [ "Package Installation (For using UnitySensors in your project)", "md_README.html#autotoc_md3", null ], - [ "Documentation", "md_README.html#autotoc_md4", null ], - [ "LICENSE", "md_README.html#autotoc_md5", null ] + [ "README", "md_README.html", [ + [ "UnitySensors", "md_README.html#autotoc_md0", [ + [ "🔍 Overview", "md_README.html#autotoc_md1", null ], + [ "🚀 Quick start", "md_README.html#autotoc_md2", [ + [ "Inside Unity3D", "md_README.html#autotoc_md3", null ], + [ "Inside ROS workspace", "md_README.html#autotoc_md4", null ] + ] ], + [ "🤝 Contributing", "md_README.html#autotoc_md5", null ], + [ "🔗 Dependencies", "md_README.html#autotoc_md6", null ], + [ "📄 LICENSE", "md_README.html#autotoc_md7", null ] + ] ] ] ], [ "Packages", "namespaces.html", [ [ "Packages", "namespaces.html", "namespaces_dup" ] @@ -66,7 +71,7 @@ var NAVTREEINDEX = "CameraInfoMsgPublisher_8cs.html", "classUnitySensors_1_1Sensor_1_1Camera_1_1DepthCameraSensor.html#a8e501399615870eed61f1e34c5b87803", "dir_0afa90f913499267ce6cb3faafbf7ca0.html", -"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#acdfe11e1cfdff0c690633eff7ccb66a7" +"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#a6c0f04045a862cc82ffef29a9cfa9a91" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/navtreeindex2.js b/navtreeindex2.js index dfa8e8da..917f15cc 100644 --- a/navtreeindex2.js +++ b/navtreeindex2.js @@ -137,11 +137,14 @@ var NAVTREEINDEX2 = "md_Assets_UnitySensors_LICENSE.html":[0], "md_Assets_UnitySensors_README.html":[1], "md_README.html":[4], -"md_README.html#autotoc_md1":[4,0], -"md_README.html#autotoc_md2":[4,1], -"md_README.html#autotoc_md3":[4,2], -"md_README.html#autotoc_md4":[4,3], -"md_README.html#autotoc_md5":[4,4], +"md_README.html#autotoc_md0":[4,0], +"md_README.html#autotoc_md1":[4,0,0], +"md_README.html#autotoc_md2":[4,0,1], +"md_README.html#autotoc_md3":[4,0,1,0], +"md_README.html#autotoc_md4":[4,0,1,1], +"md_README.html#autotoc_md5":[4,0,2], +"md_README.html#autotoc_md6":[4,0,3], +"md_README.html#autotoc_md7":[4,0,4], "namespaceUnitySensors.html":[5,0,0], "namespaceUnitySensors_1_1Attribute.html":[5,0,0,0], "namespaceUnitySensors_1_1DataType.html":[5,0,0,1], @@ -246,8 +249,5 @@ var NAVTREEINDEX2 = "structUnitySensors_1_1Sensor_1_1LiDAR_1_1ITextureToPointsJob.html#ac5a5db612959f0473ad10394e8ee18fb":[6,0,0,5,4,1,6], "structUnitySensors_1_1Sensor_1_1LiDAR_1_1ITextureToPointsJob.html#ac5f807e27fa200b6de3cf07e6fe7f608":[6,0,0,5,4,1,8], "structUnitySensors_1_1Sensor_1_1LiDAR_1_1ITextureToPointsJob.html#acba1b48b31fc870c4e95bea684511363":[6,0,0,5,4,1,10], -"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html":[6,0,0,5,4,4], -"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#a6c0f04045a862cc82ffef29a9cfa9a91":[6,0,0,5,4,4,6], -"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#a82ffb910cdb3661a27d7c77772f9cb2b":[6,0,0,5,4,4,0], -"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#acb94482030929948f8186dfe5c5f6463":[6,0,0,5,4,4,2] +"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html":[6,0,0,5,4,4] }; diff --git a/navtreeindex3.js b/navtreeindex3.js index 2886aba8..f1bd5f98 100644 --- a/navtreeindex3.js +++ b/navtreeindex3.js @@ -1,5 +1,8 @@ var NAVTREEINDEX3 = { +"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#a6c0f04045a862cc82ffef29a9cfa9a91":[6,0,0,5,4,4,6], +"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#a82ffb910cdb3661a27d7c77772f9cb2b":[6,0,0,5,4,4,0], +"structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#acb94482030929948f8186dfe5c5f6463":[6,0,0,5,4,4,2], "structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#acdfe11e1cfdff0c690633eff7ccb66a7":[6,0,0,5,4,4,3], "structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#ad9ab356cd090986ae904e6b5dfe27d6d":[6,0,0,5,4,4,5], "structUnitySensors_1_1Sensor_1_1LiDAR_1_1IUpdateRaycastCommandsJob.html#ae6ee063333bee214765554742542e5bf":[6,0,0,5,4,4,1], diff --git a/pages.html b/pages.html index 619af951..3d5e7ced 100644 --- a/pages.html +++ b/pages.html @@ -91,7 +91,7 @@  README  LICENSE  README - UnitySensors + README
diff --git a/search/all_10.js b/search/all_10.js index f58f339c..b6bee483 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -8,7 +8,7 @@ var searchData= ['raycasthits_292',['raycastHits',['../structUnitySensors_1_1Sensor_1_1LiDAR_1_1IRaycastHitsToPointsJob.html#a19531df0d3f51e1e727c2966ea038ad1',1,'UnitySensors::Sensor::LiDAR::IRaycastHitsToPointsJob']]], ['raycastlidarsensor_293',['RaycastLiDARSensor',['../classUnitySensors_1_1Sensor_1_1LiDAR_1_1RaycastLiDARSensor.html',1,'UnitySensors::Sensor::LiDAR']]], ['raycastlidarsensor_2ecs_294',['RaycastLiDARSensor.cs',['../RaycastLiDARSensor_8cs.html',1,'']]], - ['readme_295',['README',['../md_Assets_UnitySensors_README.html',1,'(Global Namespace)'],['../md_Assets_UnitySensorsROS_README.html',1,'(Global Namespace)']]], + ['readme_295',['README',['../md_Assets_UnitySensors_README.html',1,'(Global Namespace)'],['../md_Assets_UnitySensorsROS_README.html',1,'(Global Namespace)'],['../md_README.html',1,'(Global Namespace)']]], ['readme_2emd_296',['README.md',['../README_8md.html',1,'(Global Namespace)'],['../Assets_2UnitySensorsROS_2README_8md.html',1,'(Global Namespace)'],['../Assets_2UnitySensors_2README_8md.html',1,'(Global Namespace)']]], ['readonlyattribute_297',['ReadOnlyAttribute',['../classUnitySensors_1_1Attribute_1_1ReadOnlyAttribute.html',1,'UnitySensors::Attribute']]], ['readonlyattribute_2ecs_298',['ReadOnlyAttribute.cs',['../ReadOnlyAttribute_8cs.html',1,'']]], @@ -41,5 +41,5 @@ var searchData= ['rosmsgserializer_3c_20pointcloud2msg_20_3e_325',['RosMsgSerializer< PointCloud2Msg >',['../classUnitySensors_1_1ROS_1_1Serializer_1_1RosMsgSerializer.html',1,'UnitySensors::ROS::Serializer']]], ['rosmsgserializer_3c_20posestampedmsg_20_3e_326',['RosMsgSerializer< PoseStampedMsg >',['../classUnitySensors_1_1ROS_1_1Serializer_1_1RosMsgSerializer.html',1,'UnitySensors::ROS::Serializer']]], ['rosmsgserializer_3c_20tfmessagemsg_20_3e_327',['RosMsgSerializer< TFMessageMsg >',['../classUnitySensors_1_1ROS_1_1Serializer_1_1RosMsgSerializer.html',1,'UnitySensors::ROS::Serializer']]], - ['rotation_328',['rotation',['../classUnitySensors_1_1Sensor_1_1GroundTruth_1_1GroundTruth.html#a2963603a71fc07a3d3b4ee3d46179b9e',1,'UnitySensors.Sensor.GroundTruth.GroundTruth.rotation()'],['../classUnitySensors_1_1Sensor_1_1IMU_1_1IMUSensor.html#a7e1a3b620826f52571adb64a0cef1d8d',1,'UnitySensors.Sensor.IMU.IMUSensor.rotation()'],['../structUnitySensors_1_1Sensor_1_1TF_1_1TFData.html#adcbb80e29b39f70e7b45928577f309a6',1,'UnitySensors.Sensor.TF.TFData.rotation()'],['../interfaceUnitySensors_1_1Interface_1_1Sensor_1_1IImuDataInterface.html#a0de4b45f2e0fdef884807b697cc529af',1,'UnitySensors.Interface.Sensor.IImuDataInterface.rotation()'],['../interfaceUnitySensors_1_1Interface_1_1Geometry_1_1IPoseInterface.html#a492bc120c0919bfb13a51df720d8d3ea',1,'UnitySensors.Interface.Geometry.IPoseInterface.rotation()']]] + ['rotation_328',['rotation',['../interfaceUnitySensors_1_1Interface_1_1Geometry_1_1IPoseInterface.html#a492bc120c0919bfb13a51df720d8d3ea',1,'UnitySensors.Interface.Geometry.IPoseInterface.rotation()'],['../interfaceUnitySensors_1_1Interface_1_1Sensor_1_1IImuDataInterface.html#a0de4b45f2e0fdef884807b697cc529af',1,'UnitySensors.Interface.Sensor.IImuDataInterface.rotation()'],['../classUnitySensors_1_1Sensor_1_1GroundTruth_1_1GroundTruth.html#a2963603a71fc07a3d3b4ee3d46179b9e',1,'UnitySensors.Sensor.GroundTruth.GroundTruth.rotation()'],['../classUnitySensors_1_1Sensor_1_1IMU_1_1IMUSensor.html#a7e1a3b620826f52571adb64a0cef1d8d',1,'UnitySensors.Sensor.IMU.IMUSensor.rotation()'],['../structUnitySensors_1_1Sensor_1_1TF_1_1TFData.html#adcbb80e29b39f70e7b45928577f309a6',1,'UnitySensors.Sensor.TF.TFData.rotation()']]] ]; diff --git a/search/all_13.js b/search/all_13.js index e71e0de0..8676c109 100644 --- a/search/all_13.js +++ b/search/all_13.js @@ -23,7 +23,7 @@ var searchData= ['time_389',['Time',['../namespaceUnitySensors_1_1ROS_1_1Utils_1_1Time.html',1,'UnitySensors::ROS::Utils']]], ['unitysensor_390',['UnitySensor',['../classUnitySensors_1_1Sensor_1_1UnitySensor.html',1,'UnitySensors::Sensor']]], ['unitysensor_2ecs_391',['UnitySensor.cs',['../UnitySensor_8cs.html',1,'']]], - ['unitysensors_392',['UnitySensors',['../md_README.html',1,'(Global Namespace)'],['../namespaceUnitySensors.html',1,'UnitySensors']]], + ['unitysensors_392',['UnitySensors',['../namespaceUnitySensors.html',1,'']]], ['update_393',['Update',['../classUnitySensors_1_1Demo_1_1PingPongObject.html#ab15463a37a5aaaf74835f733806f0555',1,'UnitySensors.Demo.PingPongObject.Update()'],['../classUnitySensors_1_1Sensor_1_1IMU_1_1IMUSensor.html#a0ceaa826b1c89f65fbcbeab906de5779',1,'UnitySensors.Sensor.IMU.IMUSensor.Update()'],['../classUnitySensors_1_1Sensor_1_1UnitySensor.html#a58546100f0d5c0b340e2c1bcf0ee0004',1,'UnitySensors.Sensor.UnitySensor.Update()'],['../classUnitySensors_1_1Visualization_1_1Sensor_1_1PointCloudVisualizer.html#a0e30ff91b78c093f8269860b6af8cfe1',1,'UnitySensors.Visualization.Sensor.PointCloudVisualizer.Update()'],['../classUnitySensors_1_1ROS_1_1Publisher_1_1RosMsgPublisher.html#a977abed656003487750a71c5ae5623ac',1,'UnitySensors.ROS.Publisher.RosMsgPublisher.Update()'],['../classUnitySensors_1_1ROS_1_1Utils_1_1Time_1_1ROSClock.html#afb5881096343d78a3f967b72451ec398',1,'UnitySensors.ROS.Utils.Time.ROSClock.Update()']]], ['updatebuffers_394',['UpdateBuffers',['../classUnitySensors_1_1Visualization_1_1Sensor_1_1PointCloudVisualizer.html#a65d6c58ecc50aeadc2f2cd9807ad7d39',1,'UnitySensors::Visualization::Sensor::PointCloudVisualizer']]], ['updatesensor_395',['UpdateSensor',['../classUnitySensors_1_1Sensor_1_1Camera_1_1DepthCameraSensor.html#aba900c14037b7c0d7790517efe8eb2a0',1,'UnitySensors.Sensor.Camera.DepthCameraSensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1TF_1_1TFLink.html#afaf7fc67cde24e2861b7afd69595b3b8',1,'UnitySensors.Sensor.TF.TFLink.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1UnitySensor.html#ab5c726fe413722ab026b965dbeb77377',1,'UnitySensors.Sensor.UnitySensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1LiDAR_1_1RaycastLiDARSensor.html#aaa4257b8e0c0f64ab6cd06153f4232e6',1,'UnitySensors.Sensor.LiDAR.RaycastLiDARSensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1LiDAR_1_1DepthBufferLiDARSensor.html#a10ba510c6ae2bb384ebcdaa38f61613f',1,'UnitySensors.Sensor.LiDAR.DepthBufferLiDARSensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1IMU_1_1IMUSensor.html#a31e1c00bce1b1b2353c08c6828f32cb8',1,'UnitySensors.Sensor.IMU.IMUSensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1GroundTruth_1_1GroundTruth.html#ad186d21db286a344afc390b1ef01fbb3',1,'UnitySensors.Sensor.GroundTruth.GroundTruth.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1GNSS_1_1GNSSSensor.html#a7b507c3e14c33dc1e1a8e475931aafdd',1,'UnitySensors.Sensor.GNSS.GNSSSensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1Camera_1_1RGBDCameraSensor.html#adfd5048f60f64350fa6e5f301fcbcaf3',1,'UnitySensors.Sensor.Camera.RGBDCameraSensor.UpdateSensor()'],['../classUnitySensors_1_1Sensor_1_1Camera_1_1RGBCameraSensor.html#ab44ef707505aa80901caeae4e10c7592',1,'UnitySensors.Sensor.Camera.RGBCameraSensor.UpdateSensor()']]], diff --git a/search/pages_1.js b/search/pages_1.js index b3333cd2..24bfa818 100644 --- a/search/pages_1.js +++ b/search/pages_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['readme_829',['README',['../md_Assets_UnitySensors_README.html',1,'(Global Namespace)'],['../md_Assets_UnitySensorsROS_README.html',1,'(Global Namespace)']]] + ['readme_829',['README',['../md_Assets_UnitySensors_README.html',1,'(Global Namespace)'],['../md_Assets_UnitySensorsROS_README.html',1,'(Global Namespace)'],['../md_README.html',1,'(Global Namespace)']]] ]; diff --git a/search/pages_2.html b/search/pages_2.html deleted file mode 100644 index 084edfd0..00000000 --- a/search/pages_2.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
-
Loading...
-
- -
Searching...
-
No Matches
- -
- - diff --git a/search/pages_2.js b/search/pages_2.js deleted file mode 100644 index 4eb8b0eb..00000000 --- a/search/pages_2.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['unitysensors_830',['UnitySensors',['../md_README.html',1,'']]] -]; diff --git a/search/searchdata.js b/search/searchdata.js index c309e7e3..0060b2b6 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -10,7 +10,7 @@ var indexSectionsWithContent = 7: "s", 8: "cfgnst", 9: "acdglmprstv", - 10: "lru" + 10: "lr" }; var indexSectionNames =