make entity model matrix computation public #5584
Conversation
rahwang
force-pushed
the
entity-model-matrix
branch
from
3b37cfe
to
7728f21
Compare
|
@ggetz do you want to do a first pass review? |
|
@rahwang Looks good to me, just update CHANGES.md |
rahwang
force-pushed
the
entity-model-matrix
branch
from
7728f21
to
a05c5dc
Compare
|
Thanks @ggetz ! Done. |
|
@mramato did you want to look at this before merging? |
|
@rahwang please merge in master. |
Source/DataSources/Entity.js
Outdated
| */ | ||
| Entity.prototype._getModelMatrix = function(time, result) { | ||
| Entity.prototype.computeModelMatrix = function(time, result) { | ||
| var position = Property.getValueOrUndefined(this._position, time, positionScratch); |
There was a problem hiding this comment.
Now that this is public, we should add a Check call for time (and unit test to go along with it) since it's required.
Source/DataSources/Entity.js
Outdated
| @@ -581,9 +581,14 @@ define([ | |||
| var orientationScratch = new Quaternion(); | |||
|
|
|||
| /** | |||
| * @private | |||
| * Computes the model matrix for the entity's transform at specified time. | |||
| * | |||
There was a problem hiding this comment.
Expand on this documentation to indicate what happens if the entity has no position or no orientation.
Source/DataSources/Entity.js
Outdated
| * @param {JulianDate} time The time to retrieve model matrix for. | ||
| * @param {Matrix4} [result] The object onto which to store the result. | ||
| * | ||
| * @returns {Matrix4} The modified result parameter or a new Matrix4 instance if one was not provided. |
There was a problem hiding this comment.
Here too, since undefined can be returned.
CHANGES.md
Outdated
| * Fixed documentation for `OrthographicFrustum` [#5586](https://github.com/AnalyticalGraphicsInc/cesium/issues/5586) | ||
|
|
||
|
|
|
I was tempted to say let's make this a Just those couple of comments. Thanks @rahwang! |
CHANGES.md
Outdated
| @@ -5,8 +5,10 @@ Change Log | |||
|
|
|||
| * Fixed a bug where a Model's compressed textures were not being displayed. [#5596](https://github.com/AnalyticalGraphicsInc/cesium/pull/5596) | |||
| * Fixed a bug where jsep was undefined when using webpack [#5593](https://github.com/AnalyticalGraphicsInc/cesium/issues/5593) | |||
| * Make Entity mode matrix public via computeModelMatrix(). [#5584](https://github.com/AnalyticalGraphicsInc/cesium/pull/5584) | |||
There was a problem hiding this comment.
We usually say something like Added Entity.computeModelMatrix which .... End users have no idea what was private/public so you need to explain what the function is.
rahwang
force-pushed
the
entity-model-matrix
branch
from
95535ab
to
4735c4d
Compare
|
Thanks @mramato . Done! |
|
Sorry for the delay here @rahwang! I merged in master and fixed CHANGES.md but other than that this looks great. |
Could you review, @mramato ? Thanks!