Commit Graph

283 Commits

Author SHA1 Message Date
Campbell Barton
fd60de606a Style cleanup of gpu rst file. 2012-02-09 06:38:54 +00:00
Campbell Barton
4fd4a2e7b9 added note in docs about not beaing able to create new data by calling the class direct. 2012-01-31 22:37:36 +00:00
Dalai Felinto
359917fb2b pydoc cleanup + remove unused bge.logic constants
+ adding PINGPONG as action actuator constant in rst
2012-01-30 06:47:01 +00:00
Dalai Felinto
5585b3e908 rst bge touch ups: making the title of the examples slightly more noticeable
-  it's still not correct, comparing to the other examples, but at least it looks okish.
-  fixed some small typos
2012-01-23 19:53:23 +00:00
Mitchell Stokes
686ce92fe8 Committing patch "[#27676] Change window size/resolution in realtime" by me.
Description:
This patch allows the user to change the size of the window (or the resolution in fullscreen mode) using the new bge.render.setWindowSize() method. This only works in the Blenderplayer since it doesn't make a whole lot of sense for the embedded player.
2012-01-22 20:25:25 +00:00
Mitchell Stokes
57d48d4493 Committing patch "[#29763] Adding an active_events property to SCA_PythonKeyboard and SCA_PythonMouse"
Here is the description:
As the summary says, this patch adds a new event to both SCA_PythonKeyboard and SCA_PythonMouse. This property is similar to the events property that both have, but it only returns events which are not KX_NO_INPUTSTATUS. This moves the "no input" check from Python to C, which gave my input handling code a 2x speed up. Python sucks (performance-wise) with iterating lists and SCA_PythonKeyboard has close to 200 events (I think something like 177, but I don't know for sure).
2012-01-22 05:45:56 +00:00
Dalai Felinto
6964b5a6c4 cucumber merge: world scaling + video texture constants
revisions: 38166,38167,38177,38179,38180,38187,38242

To be implemented after merge:
1) add pydocs(rst) for the video texture new defines
2) see if a NodeSetLocalMatrix would fit well

#43439 by kupoman
Changing the worldTransform and localTransform python attributes to use BLI_math to simplify the code

#38242 by kupoman
Adding the constants SOURCE_ERROR, SOURCE_EMPTY, SOURCE_READY, SOURCE_PLAYING, SOURCE_STOPPED to the video texture module. Updates to the documentation will follow after a merge with trunk

#38187 by kupoman
Updates to the documentation to reflect that worldScale is now writable, and added localTransform and worldTransform to KX_GameObject.

#38180 by kupoman
The Transform attribute of KX_GameObject was based on world space data. I converted that one to worldTransform, and added a localTransform for local space transform information.

#38179 by kupoman
Fixed the transform attribute of KX_GameObject's set method to properly deal with negative scaling.

#38177 by kupoman
Updated the transform property on KX_GameObject so that it is now read/write, and added the corresponding set method. Also simplified the get method by calling GetOpenGLMatrix instead of making the matrix myself.

#38167 by kupoman
Adding a read only transform attribute to KX_GameObject that returns a 4x4 matrix representing the object's transformations.

#38166 by kupoman
Adding a worldScale attribute to KX_GameObject. This attribute scales the object independently of its parent's scale.
2012-01-22 03:21:28 +00:00
Dalai Felinto
14e75b6c84 bge api doc update
bge.texture materialId wasn't showing up
bge.type was outdated (I removed the glew example, I hope no one mind)
2012-01-13 08:58:12 +00:00
Campbell Barton
153be23dbe give a more useful error when attempting to opengl render in background mode.
add some tips to the python docs.
2012-01-13 06:59:16 +00:00
Campbell Barton
2d2d0da51b remove blender 2.5 references in docs 2012-01-12 15:16:08 +00:00
Campbell Barton
cce9c43295 correct api doc examples and a typo 2012-01-05 05:43:35 +00:00
Campbell Barton
9a0bf1ffa4 Correct use of your vs you're in py api docs 2012-01-04 03:22:37 +00:00
Campbell Barton
3c480e85e3 update the api changelog 2.60 --> 2.61 2011-12-22 21:44:52 +00:00
Campbell Barton
9aaa67cc4c corrections for docs 2011-11-28 17:19:25 +00:00
Brecht Van Lommel
2345efc6c5 Patch #29336: renaming UV (Texture) Layer to UV Map in the user interface,
by Gaia Clary.

Rationale: the name was confusing and not always used consistently, and this
map itself is not something that can be layered, rather the map can be used
as texture coordinates in some layered setup.

The original intent was to indicate this contained more than just UV's, but
the game engine settings have already been moved out, and apparently users
didn't really get this from the name anyway.
2011-11-23 17:25:25 +00:00
Campbell Barton
c6c6a3578b tab -> spaces 2011-11-18 04:55:43 +00:00
Campbell Barton
e9be8b4a0a document py gotchas
- dont assume you get the data names you ask for
- beware of collisions with library names
- beware of py modules calling sys.exit
2011-11-18 04:48:27 +00:00
Campbell Barton
f8d0c8b11e patch [#29049] Minor phrasing and grammar patch 2011-10-28 01:10:46 +00:00
Campbell Barton
cc1ed7cbc5 fix/update for credits script and bad formatting in sphinx docs. 2011-10-17 13:54:47 +00:00
Campbell Barton
2dc6ca49b3 py docs:
added python doc section on script performance and a note on relative file paths in the gotcha's page.
also added script for spell checking py comments.
2011-10-17 10:43:55 +00:00
Campbell Barton
67c15da97d docs / clenup (no functional code changes)
- added API examples for mathutils.Color/Euler/Quaternion/Matrix.
- corrected own bad spelling matricies --> matrices.
- minor pep8 edits.
- update CMake ignore file list.
2011-10-17 02:20:53 +00:00
Campbell Barton
6d5891e7ea fix bad URL in bgl doc 2011-10-16 15:01:13 +00:00
Campbell Barton
c40b976ea8 py docs - gpu module wasn't included in docs.
also added convenience target to build sphinx api docs:
 make doc_py
2011-10-13 06:59:09 +00:00
Campbell Barton
14dd4d19ed update generated api changelog for edits since 2.59 2011-10-05 22:43:00 +00:00
Campbell Barton
78968a0fc9 fix for mistake in api changelog script with function names. 2011-10-02 23:53:41 +00:00
Campbell Barton
a80520804a add '2.58 to 2.59' to changelog (should have done this for 2.59 release) and texface changes for 2.59 -> 2.60. 2011-10-02 23:47:05 +00:00
Campbell Barton
447a60b7c4 svn merge -rHEAD:40523 doc/python_api/rst/change_log.rst
revert changes for texface, will apply manually after.
2011-10-02 23:23:45 +00:00
Dalai Felinto
11a0e00819 BGE Material settings renaming Back Culling to Backface Culling and make it on by default
under suggestion of Mitchell Stokes (Moguri)
2011-09-26 06:39:19 +00:00
Dalai Felinto
51555877b0 manual update on changelog (python API)
Change as suggested by Campbell.
I'm not sure if this is the way to do for enums, I will check with him later
2011-09-24 23:50:00 +00:00
Dalai Felinto
e5b98f7a2f Python API changelog r37840-40524 (HEAD)
updating the doc.

I'm also including the latest API dump with it. This helps to keep track of the revisions to update and the next person updating doesnt need to build an old Blender for that (as I just had to).

I updated the sphinx_changelog_gen.py with this info as well.
I'll update changelog.rst manually next. I'm not so sure how to indicate that the properties were replaced instead of only removed.
2011-09-24 22:40:56 +00:00
Campbell Barton
5ba213a424 move utf8 string.c functions into their own file, also add python tip for printing operators. 2011-09-15 08:07:42 +00:00
Campbell Barton
1e6dbb1a4d added section about editmode switching to gotchas 2011-09-10 23:06:44 +00:00
Campbell Barton
e883de2739 spelling corrections from Philippe Casteleyn 2011-09-10 14:28:13 +00:00
Benoit Bolsee
01744abd81 GPU: add gpu python module with export_shader() function to export GLSL shader.
shader = gpu.export_shader(scene,material) 

Returns the GLSL shader that blender generates to produce the visual effect
of material in scene for the purpose of reusing the shader in an external engine.
This function is meant to be used in a material exporter so that the GLSL
shader can be exported entirely. The return value is a dictionary containing the
shader source code and all associated data. 

The full documentation is under sphinx.

Warning: there has been an API between the patch and this commit:
uniform['lamp'] and uniform['image'] now return python reference to 
ID block instead of ID name as before. The X3D exporter that uses this
function must be adapted.
2011-09-09 11:55:38 +00:00
Campbell Barton
4eb9b9e4f1 bpy api - add new page for best-practice (so Thomas has something to point to when kicking devs for writing shoddy UI layouts) 2011-09-08 23:59:47 +00:00
Campbell Barton
49547241d6 correction to docs. 2011-09-08 10:15:27 +00:00
Campbell Barton
290ad64a22 finished tips and tricks section of blender/python api docs, now included in generated docs. 2011-09-08 01:26:23 +00:00
Campbell Barton
520778163d interface + naming improvements to vertex wright modifier
- WeightVG -> Vertex Weight
- mapping_mode -> falloff_type
- nicer layout for VertexWeightModifiers add/remove options
2011-09-07 07:46:26 +00:00
Campbell Barton
fa32395b33 more minor doc fixes 2011-09-06 00:41:28 +00:00
Campbell Barton
67712c10c4 fix for doc building after pepper merge, also WIP tips/tricks. 2011-09-06 00:12:34 +00:00
Mitchell Stokes
4280e0a04f BGE animations: adding a missing comma. 2011-09-02 03:57:37 +00:00
Campbell Barton
255a81c3bf wip doc for py api tips and tricks. 2011-09-01 07:07:18 +00:00
Mitchell Stokes
1ad8ed8a60 BGE animations: Updating some constant names. They were still the originally proposed names instead of the ones that are actually used now. 2011-08-31 23:46:31 +00:00
Mitchell Stokes
812d5d2e5c BGE Animations: The return type for KX_GameObject.getActionFrame() was an integer when it should have been a float. I've fixed this and converted the tabs in the new BGE animation docs to space. I have also added more info on return types for KX_GameObject.getActionFrame() and KX_GameObject.isPlayingAction(). 2011-08-31 22:32:14 +00:00
Mitchell Stokes
f63d049adc BGE: Adding two new functions to bge.render to allow users to change the anisotropic filtering level used by textures:
* setAnisotropicFiltering(level)
  * getAnisotropicFiltering()
2011-08-31 05:51:51 +00:00
Joerg Mueller
43ab8e8624 * Merge trunk up to r39790.
* Subversion bump (also for init_userdef_do_versions).
* Minor fix for compilation without ffmpeg.
2011-08-30 08:22:03 +00:00
Campbell Barton
909d74d124 - use python convention for headings
- use implicit examples rather than .. code-block::
2011-08-27 08:09:12 +00:00
Campbell Barton
2e8771e987 bpy Gotcha's section on bones by Bassam Kurdali, with some edit.
added some examples & notes too.
2011-08-27 07:05:04 +00:00
Campbell Barton
a9dea3afe9 correct missing bpy doc references. 2011-08-26 18:48:48 +00:00
Campbell Barton
f10f4f570d added a section to gotcha's python bpy docs about unicode encoding problems. 2011-08-26 18:32:23 +00:00
Campbell Barton
e9ca846018 document some of the pitfalls in the blender python api (taken from frequent mails and bug reports) 2011-08-26 04:00:55 +00:00
Campbell Barton
50a9454e0f move wiki api intro and overview docs into the api reference docs.
Updated docs since some parts still were from beta still.
2011-08-25 04:25:33 +00:00
Campbell Barton
ef18ec335f svn merge -r39145:39286 https://svn.blender.org/svnroot/bf-blender/trunk/blender 2011-08-11 05:04:01 +00:00
Campbell Barton
da6bc69ca9 fix [#28191] Exception when enabling a script for a newer Blender build 2011-08-09 14:16:22 +00:00
Campbell Barton
08e184f302 note to address issue raised by report [#28190]. 2011-08-09 13:50:27 +00:00
Joerg Mueller
daab78bc61 Merging trunk up to r39145. 2011-08-07 15:25:06 +00:00
Dalai Felinto
f3c40df5e3 rst API doc fixes: literalincluding bge.texture and bge.constraints examples + bgl fixes 2011-08-04 09:47:40 +00:00
Joerg Mueller
4e8e502c02 Merging trunk up to r38932. 2011-08-02 12:16:06 +00:00
Campbell Barton
f4293067c1 py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it. 2011-07-31 03:15:37 +00:00
Dalai Felinto
dfc661565a patch [#27909] Added constants in bge.constraints by Solano Felicio (solano) + some changes in rst
I named all the BGE modules with their actual names (e.g. Rasterizer, Video Texture, ...). so in the API index.html page they look more like the other Blender modules.
I did the same for the bgl module.

For bge.constraints this patch exposes the constants values for debug mode and createConstraints (they were hardcoded innts before).

+ making all the "todo" and #comments into rst comments (.. comments)
Thanks Solano, it's great to get help to those tasks :)
2011-07-30 23:16:22 +00:00
Joerg Mueller
4532bd731d Merge with trunk up to r38584. 2011-07-21 21:11:58 +00:00
Mitchell Stokes
9fa6e32d5c BGE Animations: Updating the python docs. 2011-07-16 05:29:15 +00:00
Campbell Barton
0a46f9a737 rename bgl.Buffer attribute list to a method, to_list() as used for IDProps, also made repr function nicer. 2011-07-13 23:45:47 +00:00
Joerg Mueller
d9cf985730 Merging trunk up to r38329. 2011-07-12 13:09:22 +00:00
Dalai Felinto
936737b70f example of Physics Constraints module :)
+ some small fixes in other docs.

A topic for later(soon?), I think we should name the modules according to the rest of Blender modules. So instead of:
Game Engine bge.logic Module

We would have it:
Game Logic (bge.logic)
...
2011-07-08 06:51:12 +00:00
Campbell Barton
6aae2698ac patch [#27885] bge.constraints documentation
by Solano Felicio (solano)
2011-07-08 02:59:25 +00:00
Campbell Barton
9a0de18a52 bge.texture doc, needed whitespace to format correctly. 2011-07-07 19:35:55 +00:00
Campbell Barton
af27622a87 some corrections to bge.texture docs 2011-07-07 19:23:51 +00:00
Joerg Mueller
34c5784f99 Merging trunk up to r38167. 2011-07-06 20:26:56 +00:00
Dalai Felinto
b9810ffdde moving bge.texture example to an external file 2011-07-06 07:15:56 +00:00
Dalai Felinto
26d75618ef patch [#27871] bge.texture documentation from Solano Felício (+ changes from me) it still needs work
... and I can't test rst in windows so for now let's pretend it builds. If someone can generate the docs and see how it goes please let me know.

(plus a small fix for bge.logic rst)
2011-07-06 07:05:29 +00:00
Mitchell Stokes
c1715223b9 BGE Animations: Updating the bge.types docs to include the three new methods to KX_GameObject: playAction(), getActionFrame(), setActionFrame(). 2011-07-05 22:32:10 +00:00
Campbell Barton
01550f880e add 'bgl' OpenGL doc to sphinx 2011-07-01 11:16:42 +00:00
Campbell Barton
5916309ac9 moving BGL to rst format, first move file. 2011-07-01 11:13:26 +00:00
Campbell Barton
e1ba5c8167 moved modules added to changelog (this isn't detected by the changelog generator) 2011-06-27 04:21:53 +00:00
Campbell Barton
fb1ded6572 update automatic rna changelog 2011-06-22 12:05:24 +00:00
Campbell Barton
ce914e51ab fix [#27659] Segfault when adding None to a group 2011-06-14 09:41:29 +00:00
Campbell Barton
214f4e8c03 include some useful info in bge docs, by ZiauddinMK on IRC. 2011-06-14 07:46:38 +00:00
Dalai Felinto
a2dda7c74d BGE Patch: [#27425] Allow to change the damping of the camera actuator
##########
original name: "Allow to change the strenght of the "go behind" constraint of the camera actuator"

The camera actuator is an actuator that drive the camera to follow an object, with a set of constraint.
Currently, when the object followed rotate on himself (like a person, or an helicopter), the camera is really slow to go behind (at least 10 seconds).

This patch gives the UI to tweak the strenght of the 'go behind'[named damping] constraint.
###########

epydocs (rst) updated too
2011-06-13 17:08:33 +00:00
Campbell Barton
24b012c978 Sphinx RNA API changelog generator.
- lists added and removed functions and properties.
- lists renamed properties (does fuzzy comparison using min/max, description, type)
- lists functions with arguments changed.

Committed change log from 2.56 -> 2.57:
  http://www.blender.org/documentation/250PythonDoc/change_log.html
2011-04-07 07:53:28 +00:00
Mitchell Stokes
8d100c032e Updating BGE dynamic loading docs:
* Adding load_action and verbose keyword args for LibLoad()
  * Adding LibList()
2011-04-07 04:00:56 +00:00
Campbell Barton
e46da7166b remove BGE's PyObjectPlus.isA method docs, was removed in favor of built-in isinstance(), report [#26080]. 2011-02-21 10:15:19 +00:00
Luca Bonavita
996efebbe3 == python api doc ==
First commit to make some structure in doc/ directory.

- moved source/blender/python/doc -> doc/python_api
- moved source/gameengine/PyDoc/*.rst -> doc/python_api/rst
- modified accordingly sphinx_doc_gen.py and sphinx_doc_gen.sh
  (later on I'll try alternative/ scripts by neXyon as promised :)
- source/gameengine/PyDoc/ is still there because contains epydoc stuff for the bge, will ask more and look into it later
2010-10-13 10:42:33 +00:00