Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-07 19:41:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

* Apply suggestions from code review

Browse source 
Fix JSDoc comments and debug messages.
This commit is contained in:
Phil Palmer 2021-01-04 00:57:17 -05:00
parent 646a5798e6
commit 5d1bd5cc19
2 changed files with 6 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
interface/src/avatar/MyAvatar.cpp
View file

@ -5242,7 +5242,7 @@ bool MyAvatar::getIsInSittingState() const {
// Deprecated, will be removed. // Deprecated, will be removed.
MyAvatar::SitStandModelType MyAvatar::getUserRecenterModel() const { MyAvatar::SitStandModelType MyAvatar::getUserRecenterModel() const {
qCDebug(interfaceapp) qCDebug(interfaceapp)
<< "MyAvatar.getUserRecenterModel is deprecated and will be removed. If you need it, please contact the developers."; << "MyAvatar.getUserRecenterModel is deprecated and will be removed.";
// The legacy SitStandModelType corresponding to each AllowAvatarLeaningPreference. // The legacy SitStandModelType corresponding to each AllowAvatarLeaningPreference.
std::array<SitStandModelType, static_cast<uint>(AllowAvatarLeaningPreference::Count)> legacySitStandModels = { std::array<SitStandModelType, static_cast<uint>(AllowAvatarLeaningPreference::Count)> legacySitStandModels = {
@ -5340,7 +5340,7 @@ void MyAvatar::setIsInSittingState(bool isSitting) {
// Deprecated, will be removed. // Deprecated, will be removed.
void MyAvatar::setUserRecenterModel(MyAvatar::SitStandModelType modelName) { void MyAvatar::setUserRecenterModel(MyAvatar::SitStandModelType modelName) {
qCDebug(interfaceapp) qCDebug(interfaceapp)
<< "MyAvatar.setUserRecenterModel is deprecated and will be removed. If you need it, please contact the developers."; << "MyAvatar.setUserRecenterModel is deprecated and will be removed.";
switch (modelName) { switch (modelName) {
case SitStandModelType::ForceSit: case SitStandModelType::ForceSit:
@ -5375,8 +5375,7 @@ void MyAvatar::setAllowAvatarStandingPreference(const MyAvatar::AllowAvatarStand
// Deprecated, will be removed. // Deprecated, will be removed.
void MyAvatar::setIsSitStandStateLocked(bool isLocked) { void MyAvatar::setIsSitStandStateLocked(bool isLocked) {
Q_UNUSED(isLocked); Q_UNUSED(isLocked);
qCDebug(interfaceapp) << "MyAvatar.setIsSitStandStateLocked is deprecated and will be removed. If you need it, please " qCDebug(interfaceapp) << "MyAvatar.setIsSitStandStateLocked is deprecated and will be removed.";
"contact the developers. See also: MyAvatar.setUserRecenterModel.";
} }
// Set the user preference of when the avatar may lean. // Set the user preference of when the avatar may lean.

14
interface/src/avatar/MyAvatar.h
View file

@ -291,8 +291,8 @@ class MyAvatar : public Avatar {
* sitting / standing state, which is updated when the user next sits or stands. * sitting / standing state, which is updated when the user next sits or stands.
* @property {boolean} isSitStandStateLocked - <code>true</code> to lock the avatar sitting/standing state, i.e., use this * @property {boolean} isSitStandStateLocked - <code>true</code> to lock the avatar sitting/standing state, i.e., use this
* to disable automatically changing state. * to disable automatically changing state.
* <p class="important">Deprecated: This property is deprecated and will be removed. If you need it, please contact * <p class="important">Deprecated: This property is deprecated and will be removed.
* the developers. See also: <code>getUserRecenterModel</code> and <code>setUserRecenterModel</code>.</p> * See also: <code>getUserRecenterModel</code> and <code>setUserRecenterModel</code>.</p>
* @property {boolean} allowTeleporting - <code>true</code> if teleporting is enabled in the Interface settings, * @property {boolean} allowTeleporting - <code>true</code> if teleporting is enabled in the Interface settings,
* <code>false</code> if it isn't. <em>Read-only.</em> * <code>false</code> if it isn't. <em>Read-only.</em>
* *
@ -414,16 +414,8 @@ class MyAvatar : public Avatar {
Q_PROPERTY(float walkBackwardSpeed READ getWalkBackwardSpeed WRITE setWalkBackwardSpeed NOTIFY walkBackwardSpeedChanged); Q_PROPERTY(float walkBackwardSpeed READ getWalkBackwardSpeed WRITE setWalkBackwardSpeed NOTIFY walkBackwardSpeedChanged);
Q_PROPERTY(float sprintSpeed READ getSprintSpeed WRITE setSprintSpeed NOTIFY sprintSpeedChanged); Q_PROPERTY(float sprintSpeed READ getSprintSpeed WRITE setSprintSpeed NOTIFY sprintSpeedChanged);
Q_PROPERTY(bool isInSittingState READ getIsInSittingState WRITE setIsInSittingState); Q_PROPERTY(bool isInSittingState READ getIsInSittingState WRITE setIsInSittingState);
Q_PROPERTY(MyAvatar::SitStandModelType userRecenterModel READ getUserRecenterModel WRITE setUserRecenterModel); // Deprecated Q_PROPERTY(MyAvatar::SitStandModelType userRecenterModel READ getUserRecenterModel WRITE setUserRecenterModel); // Deprecated
Q_PROPERTY(bool isSitStandStateLocked READ getIsSitStandStateLocked WRITE setIsSitStandStateLocked); // Deprecated
/**jsdoc
* @deprecated This property is deprecated and will be removed. If you need it, please contact the developers.
* See also: {@link MyAvatar.getUserRecenterModel|getUserRecenterModel} and
* {@link MyAvatar.setUserRecenterModel|setUserRecenterModel}.
*/
Q_PROPERTY(bool isSitStandStateLocked READ getIsSitStandStateLocked WRITE setIsSitStandStateLocked);
Q_PROPERTY(bool allowTeleporting READ getAllowTeleporting) Q_PROPERTY(bool allowTeleporting READ getAllowTeleporting)
const QString DOMINANT_LEFT_HAND = "left"; const QString DOMINANT_LEFT_HAND = "left";