Details

Reviewers

Daniel Stokes (kupoman)
Dalai Felinto (dfelinto)
Mitchell Stokes (moguri)

Commits

rBS225027ce5dea: BGE - new read-only attribute in KX_GameObject python api (LOD level)
rB225027ce5dea: BGE - new read-only attribute in KX_GameObject python api (LOD level)

Summary

Added a new "current_lod_level" property to the python api of KX_GameObject. The property returns the current lod level of the game object. The purpose of the property is activate logic routines only when an object is at a certain lod-distance from the camera, avoiding to separately recomputing the same distance in the logic script. Usage in python script might look like:

owner = bge.logic.getCurrentController().owner
lod_level = owner.currentLodLevel
if lod_level == 0: ...do something
else: ... object might be too distant

Diff Detail

Event Timeline

Pierluigi Grassi (pgi) updated this revision to Diff 3112.Jan 8 2015, 6:26 PM

Pierluigi Grassi (pgi) retitled this revision from to BGE - new read-only attribute in KX_GameObject python api (LOD level).

Pierluigi Grassi (pgi) updated this object.

Pierluigi Grassi (pgi) added reviewers: Dalai Felinto (dfelinto), Mitchell Stokes (moguri).

Pierluigi Grassi (pgi) added a project: BF Blender.

Pierluigi Grassi (pgi) edited projects, added Game Engine; removed BF Blender.Jan 8 2015, 7:43 PM

Mitchell Stokes (moguri) added a reviewer: Daniel Stokes (kupoman).Jan 9 2015, 2:47 AM

Looks good to me, just needs documentation.

If I recall correctly, you can update the file doc/rst/bge.types.KX_GameObject.rst, and then figure out how to build the documentation to test it. I don't remember this process very well, but I am pretty sure it involves the sphinx scripts in doc/python_api.

While I'd really like to do PEP8 naming, we should be consistent with naming and use "currentLodLevel".

This revision now requires changes to proceed.Jan 9 2015, 4:52 AM

I have update the name of the variables, now the python attribute is currentLodLevel. I will update the doc as soon as I find a way to make the script work.

Python api doc for the new attribute.

Looks like you might have screwed up Differential a bit, try uploading a diff that contains all of your changes for this (docs and the Python attribute). Currently it is only showing the doc change.

Added a new diff file that is the sum of doc + code.

This is a minor nitpick, but shouldn't the "lod" in the docs be either "Lod" or "LOD"?

This revision is now accepted and ready to land.Jan 14 2015, 6:06 PM

Yes, being an acronym LOD should be capitalized.
The doc should really be written by someone who actually speaks english (I just pretend to). For example, I would have loved to say what happens when there is no LOD (the value remains zero) but the sentence I wrote tried to kill me, so I gave up.

I believe I have been spelling it out in many user facing strings as "level of detail", and as "LoD" when I need to abbreviate it to save space. I vote for using "level of detail" in the documentation string (e.g. "index of the level of detail currently").

Doc update, I voted for the explicit proposal too.

Looks good to me. I'm busy this evening, but I can try to land this tomorrow.

Something I just noticed is that you should be using the KX_PYATTRIBUTE_INT_RO macro rather than KX_PYATTRIBUTE_RO_FUNCTION. This would mean adding less code (you don't have to create the function). I believe it should look like this:

KX_PYATTRIBUTE_INT_RO("currentLodLevel", KX_GameObject, m_currentLodLevel);

This revision now requires changes to proceed.Jan 26 2015, 8:58 AM