Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Make anim API private #1924

Merged
merged 1 commit into from
Mar 19, 2020
Merged

[DOCS] Make anim API private #1924

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/anim/anim.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Object.assign(pc, function () {

/**
* @private
* @constant
* @type {number}
* @name pc.INTERPOLATION_STEP
Expand All @@ -9,6 +10,7 @@ Object.assign(pc, function () {
var INTERPOLATION_STEP = 0;

/**
* @private
* @constant
* @type {number}
* @name pc.INTERPOLATION_LINEAR
Expand All @@ -17,6 +19,7 @@ Object.assign(pc, function () {
var INTERPOLATION_LINEAR = 1;

/**
* @private
* @constant
* @type {number}
* @name pc.INTERPOLATION_CUBIC
Expand All @@ -25,6 +28,7 @@ Object.assign(pc, function () {
var INTERPOLATION_CUBIC = 2;

/**
* @private
* @class
* @name pc.AnimData
* @classdesc Wraps a set of data used in animation.
Expand Down Expand Up @@ -53,6 +57,7 @@ Object.assign(pc, function () {
});

/**
* @private
* @class
* @name pc.AnimCache
* @classdesc Internal cache data for the evaluation of a single curve timeline.
Expand Down Expand Up @@ -190,6 +195,7 @@ Object.assign(pc, function () {
});

/**
* @private
* @class
* @name pc.AnimCurve
* @classdesc Animation curve links an input data set to an output data set
Expand All @@ -211,6 +217,7 @@ Object.assign(pc, function () {
};

/**
* @private
* @class
* @name pc.AnimTarget
* @classdesc AnimTarget names a target graph node and specifies the curves which drive translation, rotation and scale.
Expand Down Expand Up @@ -251,6 +258,7 @@ Object.assign(pc, function () {
});

/**
* @private
* @class
* @name pc.AnimTrack
* @classdesc AnimTrack contains a set of curve data which can be used to animate a set of target nodes.
Expand Down Expand Up @@ -319,6 +327,7 @@ Object.assign(pc, function () {
});

/**
* @private
* @class
* @name pc.AnimSnapshot
* @classdesc AnimSnapshot stores the state of an animation track at a particular time.
Expand Down Expand Up @@ -357,6 +366,7 @@ Object.assign(pc, function () {
};

/**
* @private
* @class
* @name pc.AnimClip
* @classdesc AnimClip wraps the running state of an animation track. It contains and update
Expand Down Expand Up @@ -499,6 +509,7 @@ Object.assign(pc, function () {
});

/**
* @private
* @class
* @name pc.AnimController
* @classdesc AnimContoller stores a set of animation clips and performs blending
Expand Down