From 650b3c965f05336fd42d1d566ac62129d168f6ff Mon Sep 17 00:00:00 2001 From: Pascal Serrarens Date: Tue, 18 Jan 2022 17:18:15 +0100 Subject: [PATCH] Updated HelpURLs to new Doxygen documentation --- .../Scripts/Extensions/HumanoidSensor.cs | 5 +- .../HumanoidFree/Scripts/HumanoidControl.cs | 102 +++++++++--------- .../Scripts/Targets/FootTarget.cs | 6 +- .../Scripts/Targets/HandTarget.cs | 2 +- .../Scripts/Targets/HeadTarget.cs | 2 +- .../Scripts/Targets/HipsTarget.cs | 2 +- .../Scripts/Tools/AvatarManager.cs | 2 +- Runtime/Sites/Scripts/Possessable.cs | 1 + Runtime/Sites/Scripts/Site.cs | 1 + Runtime/Tools/Input/ControllerInput.cs | 1 + Runtime/Tools/Networking/NetworkingStarter.cs | 2 +- Runtime/Tools/Scripts/Counter.cs | 1 + Runtime/Tools/Scripts/Handle.cs | 4 +- Runtime/Tools/Scripts/HumanoidSpawnPoint.cs | 1 + Runtime/Tools/Scripts/Socket.cs | 2 +- 15 files changed, 69 insertions(+), 65 deletions(-) diff --git a/Runtime/HumanoidFree/Scripts/Extensions/HumanoidSensor.cs b/Runtime/HumanoidFree/Scripts/Extensions/HumanoidSensor.cs index 3549864..720c107 100644 --- a/Runtime/HumanoidFree/Scripts/Extensions/HumanoidSensor.cs +++ b/Runtime/HumanoidFree/Scripts/Extensions/HumanoidSensor.cs @@ -147,9 +147,9 @@ namespace Passer.Humanoid { } public virtual void ShowSensor(HumanoidTarget target, bool shown) { } - //} + //} - //public class HumanoidSensor : UnitySensor { + //public class HumanoidSensor : UnitySensor { protected virtual void UpdateTarget(HumanoidTarget.TargetTransform target, Transform sensorTransform) { if (target.transform == null || sensorTransform == null) @@ -176,7 +176,6 @@ namespace Passer.Humanoid { protected Vector3 GetTargetPosition(Transform sensorTransform) { Vector3 targetPosition = sensorTransform.position + sensorTransform.rotation * sensor2TargetRotation * sensor2TargetPosition; - Debug.DrawLine(targetPosition, sensorTransform.position, Color.magenta); return targetPosition; } diff --git a/Runtime/HumanoidFree/Scripts/HumanoidControl.cs b/Runtime/HumanoidFree/Scripts/HumanoidControl.cs index 0a28488..54f4c9c 100644 --- a/Runtime/HumanoidFree/Scripts/HumanoidControl.cs +++ b/Runtime/HumanoidFree/Scripts/HumanoidControl.cs @@ -104,8 +104,8 @@ namespace Passer.Humanoid { /// * \ref HumanoidControl::scaling "Scaling" /// * \ref HumanoidControl::dontDestroyOnLoad "Don't Destroy on Load" /// * \ref HumanoidControl::disconnectInstances "Disconnect Instances" - [HelpURL("https://passervr.com/documentation/humanoid-control/humanoid-control-script/")] - public class HumanoidControl : MonoBehaviour /*: PawnControl*/ { + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_humanoid_control.html")] + public class HumanoidControl : MonoBehaviour { /// The path at which the HumanoidControl script is found public string path; @@ -228,7 +228,7 @@ namespace Passer.Humanoid { // Experimental public string remoteTrackerIpAddress; -#endregion + #endregion /// /// The local Id of this humanoid @@ -239,7 +239,7 @@ namespace Passer.Humanoid { public Cerebellum.Cerebellum cerebellum; #endif -#region Settings + #region Settings /// If true, real world objects like controllers and cameras are shown in the scene public bool showRealObjects = true; @@ -310,9 +310,9 @@ namespace Passer.Humanoid { /// public bool disconnectInstances = false; -#endregion + #endregion -#region Init + #region Init protected void Awake() { if (dontDestroyOnLoad) @@ -352,9 +352,9 @@ namespace Passer.Humanoid { StartSensors(); } -#endregion + #endregion -#region Avatar + #region Avatar private float GetAvatarNeckHeight() { if (avatarRig == null) @@ -635,9 +635,9 @@ namespace Passer.Humanoid { return 0; } -#endregion + #endregion -#region Targets + #region Targets protected void NewTargetComponents() { #if pCEREBELLUM if (cerebellum == null) @@ -943,9 +943,9 @@ namespace Passer.Humanoid { }; } -#endregion + #endregion -#region Trackers + #region Trackers /// Use game controller input public bool gameControllerEnabled = true; @@ -992,10 +992,10 @@ namespace Passer.Humanoid { //#if hSTEAMVR && UNITY_STANDALONE_WIN // public SteamVRTracker steamVR = new SteamVRTracker(); //#endif -//#if hOCULUS && (UNITY_STANDALONE_WIN || UNITY_ANDROID) -// /// The Oculus tracker -// public OculusTracker oculus = new OculusTracker(); -//#endif + //#if hOCULUS && (UNITY_STANDALONE_WIN || UNITY_ANDROID) + // /// The Oculus tracker + // public OculusTracker oculus = new OculusTracker(); + //#endif /// The Windows Mixed Reality tracker #if hWINDOWSMR && UNITY_WSA_10_0 public WindowsMRTracker mixedReality = new WindowsMRTracker(); @@ -1291,9 +1291,9 @@ namespace Passer.Humanoid { tracker.AdjustTracking(translation, rotation); } -#endregion + #endregion -#region Configuration + #region Configuration /// /// Scans the humanoid to retrieve all bones /// @@ -1306,9 +1306,9 @@ namespace Passer.Humanoid { leftFootTarget.RetrieveBones(); rightFootTarget.RetrieveBones(); } -#endregion + #endregion -#region Update + #region Update protected void Update() { Controllers.Clear(); @@ -1344,9 +1344,9 @@ namespace Passer.Humanoid { Controllers.EndFrame(); } -#endregion + #endregion -#region Stop + #region Stop public void OnApplicationQuit() { #if hLEAP leapTracker.StopTracker(); @@ -1370,11 +1370,11 @@ namespace Passer.Humanoid { optitrack.StopTracker(); #endif } -#endregion + #endregion -#region Destroy + #region Destroy -#endregion + #endregion public Vector3 up { get { @@ -1419,7 +1419,7 @@ namespace Passer.Humanoid { } } -#region Calibration + #region Calibration public void SetStartPosition() { } @@ -1448,9 +1448,9 @@ namespace Passer.Humanoid { } } -#endregion + #endregion -#region Pose + #region Pose protected virtual void UpdatePose() { if (pose != null) { @@ -1459,7 +1459,7 @@ namespace Passer.Humanoid { } } -#region Pose Event + #region Pose Event public delegate void OnHumanoidPose(HumanoidPose pose); public event OnHumanoidPose onHumanoidPose; @@ -1520,11 +1520,11 @@ namespace Passer.Humanoid { } } -#endregion + #endregion -#endregion + #endregion -#region Movement + #region Movement /// /// maximum forward speed in units(meters)/second @@ -1569,7 +1569,7 @@ namespace Passer.Humanoid { protected Vector3 inputMovement = Vector3.zero; -#region Input/API + #region Input/API /// /// maximum forward speed in units(meters)/second @@ -1781,9 +1781,9 @@ namespace Passer.Humanoid { } -#endregion + #endregion -#region Checks + #region Checks [HideInInspector] public Vector3 targetVelocity; @@ -1896,9 +1896,9 @@ namespace Passer.Humanoid { return distance * elapsedTime * elapsedTime + start; } -#endregion + #endregion -#region Collisions + #region Collisions public bool triggerEntered; public bool collided; @@ -2071,9 +2071,9 @@ namespace Passer.Humanoid { ); } -#endregion + #endregion -#region Ground + #region Ground /// /// The ground Transform on which the pawn is standing @@ -2221,9 +2221,9 @@ namespace Passer.Humanoid { lastGroundAngle = ground.eulerAngles.y; } -#endregion + #endregion -#region Body Pull + #region Body Pull protected virtual void CheckBodyPull() { if (!bodyPull) @@ -2262,7 +2262,7 @@ namespace Passer.Humanoid { transform.Translate(translation, Space.World); } -#endregion + #endregion [HideInInspector] private float lastTime; @@ -2301,7 +2301,7 @@ namespace Passer.Humanoid { lastHeadDirection = headTarget.neck.target.transform.eulerAngles.y; } -#region Animation + #region Animation public string animatorParameterForward; public string animatorParameterSideward; public string animatorParameterRotation; @@ -2381,7 +2381,7 @@ namespace Passer.Humanoid { targetsRig.SetTrigger(parameterName); } -#endregion + #endregion [HideInInspector] private float lastLocalHipY; @@ -2402,7 +2402,7 @@ namespace Passer.Humanoid { lastLocalHipY = localHipY; } -#endregion Movement + #endregion Movement /// Gets the Real World GameObject for this Humanoid /// The root transform of the humanoid @@ -2470,7 +2470,7 @@ namespace Passer.Humanoid { // return footBase; //} -#region Networking + #region Networking /// Is true when this is a remote pawn /// Remote pawns are not controlled locally, but are controlled from another computer. @@ -2483,9 +2483,9 @@ namespace Passer.Humanoid { /// The local Id of this humanoid public int id = -1; -#endregion + #endregion -#region Humanoid store + #region Humanoid store private static HumanoidControl[] _allHumanoids = new HumanoidControl[0]; public static HumanoidControl[] allHumanoids { @@ -2574,6 +2574,8 @@ namespace Passer.Humanoid { screenPosition.y > 0 && screenPosition.y < camera.pixelHeight); } -#endregion + #endregion } -} \ No newline at end of file +} + + diff --git a/Runtime/HumanoidFree/Scripts/Targets/FootTarget.cs b/Runtime/HumanoidFree/Scripts/Targets/FootTarget.cs index b4eba67..99e8abe 100644 --- a/Runtime/HumanoidFree/Scripts/Targets/FootTarget.cs +++ b/Runtime/HumanoidFree/Scripts/Targets/FootTarget.cs @@ -41,14 +41,14 @@ namespace Passer.Humanoid { /// /// Settings /// ======== - /// \ref FootTarget::rotationSpeedLimitation "Rotation Speed Limitation" - /// \ref FootTarget::slidePrevention "Slide Prevention" + /// * \ref FootTarget::rotationSpeedLimitation "Rotation Speed Limitation" + /// * \ref FootTarget::slidePrevention "Slide Prevention" /// /// Events /// ====== /// * \ref FootTarget::groundEvent "Ground Event" /// - [HelpURLAttribute("https://passervr.com/documentation/humanoid-control/foot-target/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_foot_target.html")] public class FootTarget : HumanoidTarget { public bool isLeft; public Side side; diff --git a/Runtime/HumanoidFree/Scripts/Targets/HandTarget.cs b/Runtime/HumanoidFree/Scripts/Targets/HandTarget.cs index ad81dc8..a015ed2 100644 --- a/Runtime/HumanoidFree/Scripts/Targets/HandTarget.cs +++ b/Runtime/HumanoidFree/Scripts/Targets/HandTarget.cs @@ -100,7 +100,7 @@ namespace Passer.Humanoid { /// * Add \ref Passer::Teleporter "Teleporter": Adds a preconfigured interaction pointer /// to the hand target which can teleport the avatar by pointing to new positions. [System.Serializable] - [HelpURLAttribute("https://passervr.com/documentation/humanoid-control/hand-target/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_hand_target.html")] public partial class HandTarget : HumanoidTarget { public HandTarget() { shoulder = new TargetedShoulderBone(this); diff --git a/Runtime/HumanoidFree/Scripts/Targets/HeadTarget.cs b/Runtime/HumanoidFree/Scripts/Targets/HeadTarget.cs index db9a859..9b56d0f 100644 --- a/Runtime/HumanoidFree/Scripts/Targets/HeadTarget.cs +++ b/Runtime/HumanoidFree/Scripts/Targets/HeadTarget.cs @@ -61,7 +61,7 @@ namespace Passer.Humanoid { /// Interaction, Event System and UI. /// * Add \ref Passer::Teleporter "Teleporter": Adds a preconfigured gaze interaction pointer /// to the head target which can teleport the avatar by pointing to new positions. - [HelpURL("https://passervr.com/documentation/humanoid-control/head-target/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_head_target.html")] public class HeadTarget : HumanoidTarget { public HeadTarget() { diff --git a/Runtime/HumanoidFree/Scripts/Targets/HipsTarget.cs b/Runtime/HumanoidFree/Scripts/Targets/HipsTarget.cs index cc939fd..18308e8 100644 --- a/Runtime/HumanoidFree/Scripts/Targets/HipsTarget.cs +++ b/Runtime/HumanoidFree/Scripts/Targets/HipsTarget.cs @@ -38,7 +38,7 @@ namespace Passer.Humanoid { /// ======== /// \ref HipsTarget::bodyRotation "Body Rotation" /// - [HelpURLAttribute("https://passervr.com/documentation/humanoid-control/hips-target/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_hips_target.html")] public partial class HipsTarget : HumanoidTarget { public HipsTarget() { diff --git a/Runtime/HumanoidFree/Scripts/Tools/AvatarManager.cs b/Runtime/HumanoidFree/Scripts/Tools/AvatarManager.cs index bc2d21c..f280687 100644 --- a/Runtime/HumanoidFree/Scripts/Tools/AvatarManager.cs +++ b/Runtime/HumanoidFree/Scripts/Tools/AvatarManager.cs @@ -42,7 +42,7 @@ namespace Passer.Humanoid { /// /// \image AvatarManagerControllerInput.png /// - [HelpURLAttribute("https://passervr.com/documentation/humanoid-control/avatar-manager/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_avatar_manager.html")] public class AvatarManager : MonoBehaviour { /// The index of the current avatar in the list diff --git a/Runtime/Sites/Scripts/Possessable.cs b/Runtime/Sites/Scripts/Possessable.cs index ff27738..01ccfdc 100644 --- a/Runtime/Sites/Scripts/Possessable.cs +++ b/Runtime/Sites/Scripts/Possessable.cs @@ -15,6 +15,7 @@ namespace Passer { /// * %Is unique, see Possession::isUnique /// /// \version 4 + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_possessable.html")] public class Possessable : MonoBehaviour { /// diff --git a/Runtime/Sites/Scripts/Site.cs b/Runtime/Sites/Scripts/Site.cs index a787a2b..37bf1d5 100644 --- a/Runtime/Sites/Scripts/Site.cs +++ b/Runtime/Sites/Scripts/Site.cs @@ -31,6 +31,7 @@ namespace Passer { /// Example sites can be found in Assets/Passer/Sites/ /// /// \version 4.0 and higher + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_site.html")] [RequireComponent(typeof(HumanoidSpawnPoint))] public class Site : MonoBehaviour { diff --git a/Runtime/Tools/Input/ControllerInput.cs b/Runtime/Tools/Input/ControllerInput.cs index 7b13f3c..9d3552b 100644 --- a/Runtime/Tools/Input/ControllerInput.cs +++ b/Runtime/Tools/Input/ControllerInput.cs @@ -20,6 +20,7 @@ namespace Passer { /// (e.g. SteamVR or Oculus Touch controllers). /// For game controllers like the Xbox controller, this corresponds to the left and right side of the gamepad. /// Event input is using an EventHandler to define its behaviour. + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_controller_input.html")] public class ControllerInput : MonoBehaviour { public enum SideButton { diff --git a/Runtime/Tools/Networking/NetworkingStarter.cs b/Runtime/Tools/Networking/NetworkingStarter.cs index bde2234..1d31423 100644 --- a/Runtime/Tools/Networking/NetworkingStarter.cs +++ b/Runtime/Tools/Networking/NetworkingStarter.cs @@ -17,7 +17,7 @@ namespace Passer { /// The easiest way to turn a single-user scene in a multi-user environment is to add the /// NetworkingStarter prefab to the scene. You can find this in the Humanoid->Prefabs->Networking folder. [System.Serializable] - [HelpURLAttribute("https://passervr.com/documentation/humanoid-control/networking-support/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_networking_starter.html")] #if hNW_PHOTON #if hPHOTON2 public class NetworkingStarter : Photon.Pun.MonoBehaviourPunCallbacks diff --git a/Runtime/Tools/Scripts/Counter.cs b/Runtime/Tools/Scripts/Counter.cs index 7bf95f5..48fb22f 100644 --- a/Runtime/Tools/Scripts/Counter.cs +++ b/Runtime/Tools/Scripts/Counter.cs @@ -21,6 +21,7 @@ namespace Passer { /// - Value Change Event, see Counter::counterEvent /// /// \version 4.0 and higher + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_counter.html")] public class Counter : MonoBehaviour { #region Properties diff --git a/Runtime/Tools/Scripts/Handle.cs b/Runtime/Tools/Scripts/Handle.cs index 7912d9d..435525a 100644 --- a/Runtime/Tools/Scripts/Handle.cs +++ b/Runtime/Tools/Scripts/Handle.cs @@ -40,9 +40,7 @@ namespace Passer { /// The difference is that empty entries do not override the ControllerInput configuration. /// When the handle is released by the hand, /// the ControllerInput is restored to the original configuration. - - /// - [HelpURL("https://passervr.com/documentation/humanoid-control/grabbing-objects/handle/")] + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_handle.html")] public class Handle : MonoBehaviour { /// The way in which the hand can grab the handle diff --git a/Runtime/Tools/Scripts/HumanoidSpawnPoint.cs b/Runtime/Tools/Scripts/HumanoidSpawnPoint.cs index 2d5e0cf..bea7698 100644 --- a/Runtime/Tools/Scripts/HumanoidSpawnPoint.cs +++ b/Runtime/Tools/Scripts/HumanoidSpawnPoint.cs @@ -19,6 +19,7 @@ namespace Passer.Humanoid { /// In the scene view, the capsule is visualized as an orange cylinder when the spawn point is selected: /// /// \image html HumanoidSpawnPointGizmo.png + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_humanoid_spawn_point.html")] public class HumanoidSpawnPoint : SpawnPoint { /// diff --git a/Runtime/Tools/Scripts/Socket.cs b/Runtime/Tools/Scripts/Socket.cs index ef358eb..f4ffe45 100644 --- a/Runtime/Tools/Scripts/Socket.cs +++ b/Runtime/Tools/Scripts/Socket.cs @@ -122,7 +122,7 @@ namespace Passer { /// This joint is implemented using a Configurable Joint /// such that it will follow the Handle’s Transform as closely as possible. /// When the Handle is released, the joint is destroyed again. - /// + [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_socket.html")] public class Socket : MonoBehaviour { protected static void DebugLog(string s) {