Skip to content

Commit 7f37408

Browse files
committed
document scene graph attributes
1 parent 69024b7 commit 7f37408

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

packages/engine/Source/Scene/Model/ModelSceneGraph.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,11 @@ Object.defineProperties(ModelSceneGraph.prototype, {
242242
/**
243243
* The bounding sphere containing all the primitives in the scene graph
244244
* in model space
245+
*
246+
* @type {BoundingSphere}
247+
* @readonly
248+
*
249+
* @private
245250
*/
246251
rootBoundingSphere: {
247252
get: function () {
@@ -253,13 +258,25 @@ Object.defineProperties(ModelSceneGraph.prototype, {
253258
* The transform for the scene graph computed by multiplying the
254259
* components transform by the the axisCorrectionMatrix
255260
* glTF * AxisCorrection
261+
*
262+
* @type {Matrix4}
263+
* @readonly
264+
*
265+
* @private
256266
*/
257267
rootTransform: {
258268
get: function () {
259269
return this._rootTransform;
260270
},
261271
},
262272

273+
/**
274+
* Accessor to ModelInstanceCollection to support runtime instancing
275+
*
276+
* @type {ModelInstanceCollection}
277+
*
278+
* @private
279+
*/
263280
modelInstances: {
264281
get: function () {
265282
return this._modelInstances;
@@ -269,6 +286,14 @@ Object.defineProperties(ModelSceneGraph.prototype, {
269286
},
270287
},
271288

289+
/**
290+
* Model has runtime instances
291+
*
292+
* @type {Boolean}
293+
* @readonly
294+
*
295+
* @private
296+
*/
272297
hasInstances: {
273298
get: function () {
274299
return this._modelInstances && this._modelInstances.length > 0;

0 commit comments

Comments
 (0)