Skip to content

Commit 13c42e1

Browse files
committed
other descriptions for the setters and getters
1 parent a4faed2 commit 13c42e1

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

js/artoolkit.api.js

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -957,12 +957,15 @@
957957
ARController.prototype.setLogLevel = function (mode) {
958958
return artoolkit.setLogLevel(mode);
959959
};
960+
960961
/**
961962
Gets the logging level used by ARToolKit.
963+
@return {number} return the log level in use.
962964
*/
963965
ARController.prototype.getLogLevel = function () {
964966
return artoolkit.getLogLevel();
965967
};
968+
966969
/**
967970
Sets the dir (direction) of the marker. Direction that tells about the rotation
968971
about the marker (possible values are 0, 1, 2 or 3).
@@ -971,23 +974,42 @@
971974
This is important to compute the transformation matrix in arGetTransMat().
972975
@param {number} markerIndex the index of the marker
973976
@param {number} dir direction of the marker (possible values are 0, 1, 2 or 3).
977+
@return {number} 0 (void)
974978
*/
975979
ARController.prototype.setMarkerInfoDir = function (markerIndex, dir) {
976980
return artoolkit.setMarkerInfoDir(this.id, markerIndex, dir);
977981
};
978982

983+
/**
984+
Sets the value of the near plane of the camera.
985+
@param {number} value the value of the near plane
986+
@return {number} 0 (void)
987+
*/
979988
ARController.prototype.setProjectionNearPlane = function (value) {
980989
return artoolkit.setProjectionNearPlane(this.id, value);
981990
};
982991

992+
/**
993+
Gets the value of the near plane of the camera with the give id.
994+
@return {number} the value of the near plane.
995+
*/
983996
ARController.prototype.getProjectionNearPlane = function () {
984997
return artoolkit.getProjectionNearPlane(this.id);
985998
};
986999

1000+
/**
1001+
Sets the value of the far plane of the camera.
1002+
@param {number} value the value of the far plane
1003+
@return {number} 0 (void)
1004+
*/
9871005
ARController.prototype.setProjectionFarPlane = function (value) {
9881006
return artoolkit.setProjectionFarPlane(this.id, value);
9891007
};
9901008

1009+
/**
1010+
Gets the value of the far plane of the camera with the give id.
1011+
@return {number} the value of the far plane.
1012+
*/
9911013
ARController.prototype.getProjectionFarPlane = function () {
9921014
return artoolkit.getProjectionFarPlane(this.id);
9931015
};

0 commit comments

Comments
 (0)