[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [20184] trunk/blender/source/gameengine/ PyDoc: Moved game engine types into GameTypes. py because every type put into a module giving lots of references to KX_GameObject .KX_GameObject and having to write in links like L{CListValue<CListValue. CListValue>}.
Campbell Barton
ideasman42 at gmail.com
Wed May 13 12:15:20 CEST 2009
Revision: 20184
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=20184
Author: campbellbarton
Date: 2009-05-13 12:15:19 +0200 (Wed, 13 May 2009)
Log Message:
-----------
Moved game engine types into GameTypes.py because every type put into a module giving lots of references to KX_GameObject.KX_GameObject and having to write in links like L{CListValue<CListValue.CListValue>}.
Looked into ways around this but epydoc has no way to import a class without its module and the @include field is maked as 'TODO'.
Also removed the outdated 'WhatsNew' section and linked to the 2.49 release notes.
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/GameLogic.py
trunk/blender/source/gameengine/PyDoc/GameTypes.py
Removed Paths:
-------------
trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py
trunk/blender/source/gameengine/PyDoc/BL_Shader.py
trunk/blender/source/gameengine/PyDoc/BL_ShapeActionActuator.py
trunk/blender/source/gameengine/PyDoc/CListValue.py
trunk/blender/source/gameengine/PyDoc/CPropValue.py
trunk/blender/source/gameengine/PyDoc/CValue.py
trunk/blender/source/gameengine/PyDoc/KX_BlenderMaterial.py
trunk/blender/source/gameengine/PyDoc/KX_CDActuator.py
trunk/blender/source/gameengine/PyDoc/KX_Camera.py
trunk/blender/source/gameengine/PyDoc/KX_CameraActuator.py
trunk/blender/source/gameengine/PyDoc/KX_ConstraintActuator.py
trunk/blender/source/gameengine/PyDoc/KX_ConstraintWrapper.py
trunk/blender/source/gameengine/PyDoc/KX_GameActuator.py
trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
trunk/blender/source/gameengine/PyDoc/KX_IpoActuator.py
trunk/blender/source/gameengine/PyDoc/KX_LightObject.py
trunk/blender/source/gameengine/PyDoc/KX_MeshProxy.py
trunk/blender/source/gameengine/PyDoc/KX_MouseFocusSensor.py
trunk/blender/source/gameengine/PyDoc/KX_NearSensor.py
trunk/blender/source/gameengine/PyDoc/KX_NetworkMessageActuator.py
trunk/blender/source/gameengine/PyDoc/KX_NetworkMessageSensor.py
trunk/blender/source/gameengine/PyDoc/KX_ObjectActuator.py
trunk/blender/source/gameengine/PyDoc/KX_ParentActuator.py
trunk/blender/source/gameengine/PyDoc/KX_PhysicsObjectWrapper.py
trunk/blender/source/gameengine/PyDoc/KX_PolyProxy.py
trunk/blender/source/gameengine/PyDoc/KX_PolygonMaterial.py
trunk/blender/source/gameengine/PyDoc/KX_RadarSensor.py
trunk/blender/source/gameengine/PyDoc/KX_RaySensor.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_EndObjectActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py
trunk/blender/source/gameengine/PyDoc/KX_Scene.py
trunk/blender/source/gameengine/PyDoc/KX_SceneActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SoundActuator.py
trunk/blender/source/gameengine/PyDoc/KX_StateActuator.py
trunk/blender/source/gameengine/PyDoc/KX_TouchSensor.py
trunk/blender/source/gameengine/PyDoc/KX_TrackToActuator.py
trunk/blender/source/gameengine/PyDoc/KX_VehicleWrapper.py
trunk/blender/source/gameengine/PyDoc/KX_VertexProxy.py
trunk/blender/source/gameengine/PyDoc/KX_VisibilityActuator.py
trunk/blender/source/gameengine/PyDoc/PyObjectPlus.py
trunk/blender/source/gameengine/PyDoc/SCA_2DFilterActuator.py
trunk/blender/source/gameengine/PyDoc/SCA_ANDController.py
trunk/blender/source/gameengine/PyDoc/SCA_ActuatorSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_AlwaysSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_DelaySensor.py
trunk/blender/source/gameengine/PyDoc/SCA_IActuator.py
trunk/blender/source/gameengine/PyDoc/SCA_IController.py
trunk/blender/source/gameengine/PyDoc/SCA_ILogicBrick.py
trunk/blender/source/gameengine/PyDoc/SCA_IObject.py
trunk/blender/source/gameengine/PyDoc/SCA_ISensor.py
trunk/blender/source/gameengine/PyDoc/SCA_JoystickSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_KeyboardSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_MouseSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_NANDController.py
trunk/blender/source/gameengine/PyDoc/SCA_NORController.py
trunk/blender/source/gameengine/PyDoc/SCA_ORController.py
trunk/blender/source/gameengine/PyDoc/SCA_PropertyActuator.py
trunk/blender/source/gameengine/PyDoc/SCA_PropertySensor.py
trunk/blender/source/gameengine/PyDoc/SCA_PythonController.py
trunk/blender/source/gameengine/PyDoc/SCA_RandomActuator.py
trunk/blender/source/gameengine/PyDoc/SCA_RandomSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_XNORController.py
trunk/blender/source/gameengine/PyDoc/SCA_XORController.py
trunk/blender/source/gameengine/PyDoc/WhatsNew.py
Deleted: trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py 2009-05-13 06:53:21 UTC (rev 20183)
+++ trunk/blender/source/gameengine/PyDoc/BL_ActionActuator.py 2009-05-13 10:15:19 UTC (rev 20184)
@@ -1,230 +0,0 @@
-# $Id$
-# Documentation for BL_ActionActuator
-import SCA_ILogicBrick
-from SCA_IActuator import *
-
-
-class BL_ActionActuator(SCA_IActuator):
- """
- Action Actuators apply an action to an actor.
-
- @ivar action: The name of the action to set as the current action.
- @type action: string
- @ivar start: Specifies the starting frame of the animation.
- @type start: float
- @ivar end: Specifies the ending frame of the animation.
- @type end: float
- @ivar blendin: Specifies the number of frames of animation to generate when making transitions between actions.
- @type blendin: float
- @ivar priority: Sets the priority of this actuator. Actuators will lower
- priority numbers will override actuators with higher
- numbers.
- @type priority: integer
- @ivar frame: Sets the current frame for the animation.
- @type frame: float
- @ivar property: Sets the property to be used in FromProp playback mode.
- @type property: string
- @ivar blendTime: Sets the internal frame timer. This property must be in
- the range from 0.0 to blendin.
- @type blendTime: float
- @ivar type: The operation mode of the actuator. KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
- @type type: integer
- @ivar useContinue: The actions continue option, True or False.
- When True, the action will always play from where last left off,
- otherwise negative events to this actuator will reset it to its start frame.
- @type: boolean
- @ivar frameProperty: The name of the property that is set to the current frame number.
- @type frameProperty: string
- """
- def setChannel(channel, matrix, mode = False):
- """
- @param channel: A string specifying the name of the bone channel.
- @type channel: string
- @param matrix: A 4x4 matrix specifying the overriding transformation
- as an offset from the bone's rest position.
- @type matrix: list [[float]]
- @param mode: True for armature/world space, False for bone space
- @type mode: boolean
- """
-
- #--The following methods are deprecated--
- def setAction(action, reset = True):
- """
- DEPRECATED: use the 'action' property
- Sets the current action.
-
- @param action: The name of the action to set as the current action.
- @type action: string
- @param reset: Optional parameter indicating whether to reset the
- blend timer or not. A value of 1 indicates that the
- timer should be reset. A value of 0 will leave it
- unchanged. If reset is not specified, the timer will
- be reset.
- """
-
- def setStart(start):
- """
- DEPRECATED: use the 'start' property
- Specifies the starting frame of the animation.
-
- @param start: the starting frame of the animation
- @type start: float
- """
-
- def setEnd(end):
- """
- DEPRECATED: use the 'end' property
- Specifies the ending frame of the animation.
-
- @param end: the ending frame of the animation
- @type end: float
- """
- def setBlendin(blendin):
- """
- DEPRECATED: use the 'blendin' property
- Specifies the number of frames of animation to generate
- when making transitions between actions.
-
- @param blendin: the number of frames in transition.
- @type blendin: float
- """
-
- def setPriority(priority):
- """
- DEPRECATED: use the 'priority' property
- Sets the priority of this actuator.
-
- @param priority: Specifies the new priority. Actuators will lower
- priority numbers will override actuators with higher
- numbers.
- @type priority: integer
- """
- def setFrame(frame):
- """
- DEPRECATED: use the 'frame' property
- Sets the current frame for the animation.
-
- @param frame: Specifies the new current frame for the animation
- @type frame: float
- """
-
- def setProperty(prop):
- """
- DEPRECATED: use the 'property' property
- Sets the property to be used in FromProp playback mode.
-
- @param prop: the name of the property to use.
- @type prop: string.
- """
-
- def setBlendtime(blendtime):
- """
- DEPRECATED: use the 'blendTime' property
- Sets the internal frame timer.
-
- Allows the script to directly modify the internal timer
- used when generating transitions between actions.
-
- @param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
- @type blendtime: float
- """
-
- def setType(mode):
- """
- DEPRECATED: use the 'type' property
- Sets the operation mode of the actuator
-
- @param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
- @type mode: integer
- """
-
- def setContinue(cont):
- """
- DEPRECATED: use the 'continue' property
- Set the actions continue option True or False. see getContinue.
-
- @param cont: The continue option.
- @type cont: bool
- """
-
- def getType():
- """
- DEPRECATED: use the 'type' property
- Returns the operation mode of the actuator
-
- @rtype: integer
- @return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
- """
-
- def getContinue():
- """
- DEPRECATED: use the 'continue' property
- When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame.
-
- @rtype: bool
- """
-
- def getAction():
- """
- DEPRECATED: use the 'action' property
- getAction() returns the name of the action associated with this actuator.
-
- @rtype: string
- """
-
- def getStart():
- """
- DEPRECATED: use the 'start' property
- Returns the starting frame of the action.
-
- @rtype: float
- """
- def getEnd():
- """
- DEPRECATED: use the 'end' property
- Returns the last frame of the action.
-
- @rtype: float
- """
- def getBlendin():
- """
- DEPRECATED: use the 'blendin' property
- Returns the number of interpolation animation frames to be generated when this actuator is triggered.
-
- @rtype: float
- """
- def getPriority():
- """
- DEPRECATED: use the 'priority' property
- Returns the priority for this actuator. Actuators with lower Priority numbers will
- override actuators with higher numbers.
-
- @rtype: integer
- """
- def getFrame():
- """
- DEPRECATED: use the 'frame' property
- Returns the current frame number.
-
- @rtype: float
- """
- def getProperty():
- """
- DEPRECATED: use the 'property' property
- Returns the name of the property to be used in FromProp mode.
-
- @rtype: string
- """
- def setFrameProperty(prop):
- """
- DEPRECATED: use the 'frameProperty' property
- @param prop: A string specifying the property of the object that will be updated with the action frame number.
- @type prop: string
- """
- def getFrameProperty():
- """
- DEPRECATED: use the 'frameProperty' property
- Returns the name of the property that is set to the current frame number.
-
- @rtype: string
- """
Deleted: trunk/blender/source/gameengine/PyDoc/BL_Shader.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/BL_Shader.py 2009-05-13 06:53:21 UTC (rev 20183)
+++ trunk/blender/source/gameengine/PyDoc/BL_Shader.py 2009-05-13 10:15:19 UTC (rev 20184)
@@ -1,248 +0,0 @@
-
-from PyObjectPlus import *
-
-class BL_Shader(PyObjectPlus):
- """
- BL_Shader GLSL shaders.
-
- TODO - Description
- """
-
- def setUniformfv(name, fList):
- """
- Set a uniform with a list of float values
-
- @param name: the uniform name
- @type name: string
-
- @param fList: a list (2, 3 or 4 elements) of float values
- @type fList: list[float]
- """
-
- def delSource():
- """
- TODO - Description
-
- """
- def getFragmentProg():
- """
- Returns the fragment program.
-
- @rtype: string
- @return: The fragment program.
- """
- def getVertexProg():
- """
- Get the vertex program.
-
- @rtype: string
- @return: The vertex program.
- """
- def isValid():
- """
- Check if the shader is valid.
-
- @rtype: bool
- @return: True if the shader is valid
- """
- def setAttrib(enum):
- """
- Set attribute location. (The parameter is ignored a.t.m. and the value of "tangent" is always used.)
-
- @param enum: attribute location value
- @type enum: integer
- """
- def setNumberOfPasses( max_pass ):
- """
- Set the maximum number of passes. Not used a.t.m.
-
- @param max_pass: the maximum number of passes
- @type max_pass: integer
- """
- def setSampler(name, index):
- """
- Set uniform texture sample index.
-
- @param name: Uniform name
- @type name: string
-
- @param index: Texture sample index.
- @type index: integer
- """
- def setSource(vertexProgram, fragmentProgram):
- """
- Set the vertex and fragment programs
-
- @param vertexProgram: Vertex program
- @type vertexProgram: string
-
- @param fragmentProgram: Fragment program
- @type fragmentProgram: string
- """
- def setUniform1f(name, fx):
- """
- Set a uniform with 1 float value.
-
- @param name: the uniform name
- @type name: string
-
- @param fx: Uniform value
- @type fx: float
- """
- def setUniform1i(name, ix):
- """
- Set a uniform with an integer value.
-
- @param name: the uniform name
- @type name: string
-
- @param ix: the uniform value
- @type ix: integer
- """
- def setUniform2f(name, fx, fy):
- """
- Set a uniform with 2 float values
-
- @param name: the uniform name
- @type name: string
-
- @param fx: first float value
- @type fx: float
-
- @param fy: second float value
- @type fy: float
- """
- def setUniform2i(name, ix, iy):
- """
- Set a uniform with 2 integer values
-
- @param name: the uniform name
- @type name: string
-
- @param ix: first integer value
- @type ix: integer
-
- @param iy: second integer value
- @type iy: integer
- """
- def setUniform3f(name, fx,fy,fz):
- """
- Set a uniform with 3 float values.
-
- @param name: the uniform name
- @type name: string
-
- @param fx: first float value
- @type fx: float
-
- @param fy: second float value
- @type fy: float
-
- @param fz: third float value
- @type fz: float
- """
- def setUniform3i(name, ix,iy,iz):
- """
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list