doxygen: entries for blenderroutines, converter, expressions, gamelogic, gameplayer, ketsji

This commit is contained in:
Nathan Letwory
2011-02-22 10:33:14 +00:00
parent 7729ecc98f
commit 5138615554
188 changed files with 1134 additions and 351 deletions

View File

@@ -631,7 +631,13 @@ INPUT = doxygen.main \
../source/blender/modifiers \
../source/blender/gpu \
../source/blender/avi \
../intern/guardedalloc
../intern/guardedalloc \
../source/gameengine/BlenderRoutines \
../source/gameengine/Converter \
../source/gameengine/Expressions \
../source/gameengine/GameLogic \
../source/gameengine/GamePlayer \
../source/gameengine/Ketsji
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

View File

@@ -47,7 +47,29 @@
* \ingroup scripts
*/
/** \defgroup gameengine Game Engine */
/** \defgroup bge Game Engine */
/** \defgroup gamelogic Game Logic
* \ingroup bge
*/
/** \defgroup bgeconv Converter
* \ingroup bge
*/
/** \defgroup blroutines Blender Routines
* \ingroup bge
*/
/** \defgroup expressions Expressions
* \ingroup bge
*/
/** \defgroup player Game Player
* \ingroup bge
*/
/** \defgroup ketsji Ketsji
* \ingroup bge
* \todo check all headers and code files for proper licenses
*/
/** \defgroup ketsjinet Ketsji Network
* \ingroup ketsji
*/
/** \defgroup audaspace Audaspace
* \ingroup intern undoc

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderCanvas.h
* \ingroup blroutines
*/
#ifndef __KX_BLENDERCANVAS
#define __KX_BLENDERCANVAS

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderGL.h
* \ingroup blroutines
*/
#ifndef __BLENDERGL
#define __BLENDERGL

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderInputDevice.h
* \ingroup blroutines
*/
#ifndef __KX_BLENDERINPUTDEVICE
#define __KX_BLENDERINPUTDEVICE

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderKeyboardDevice.h
* \ingroup blroutines
*/
#ifndef __KX_BLENDERKEYBOARDDEVICE
#define __KX_BLENDERKEYBOARDDEVICE

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderMouseDevice.h
* \ingroup blroutines
*/
#ifndef __KX_BLENDERMOUSEDEVICE
#define __KX_BLENDERMOUSEDEVICE

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderRenderTools.h
* \ingroup blroutines
*/
#ifndef __KX_BLENDERRENDERTOOLS
#define __KX_BLENDERRENDERTOOLS

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,12 +26,15 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderSystem.h
* \ingroup blroutines
* \brief Blender System embedding. Needed when gameengine runs embedded within Blender.
*/
#ifndef __KX_BLENDERSYSTEM
#define __KX_BLENDERSYSTEM
/**
* Blender System embedding. Needed when gameengine runs embedded within Blender.
*/
#include "KX_ISystem.h"
#ifdef WITH_CXX_GUARDEDALLOC
@@ -47,8 +50,6 @@ public:
virtual ~KX_BlenderSystem() {};
virtual double GetTimeInSeconds();
#ifdef WITH_CXX_GUARDEDALLOC
public:
void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_BlenderSystem"); }

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ActionActuator.h
* \ingroup bgeconv
*/
#ifndef BL_ACTIONACTUATOR
#define BL_ACTIONACTUATOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ArmatureActuator.h
* \ingroup bgeconv
*/
#ifndef BL_ARMATUREACTUATOR
#define BL_ARMATUREACTUATOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ActionChannel.h
* \ingroup bgeconv
*/
#ifndef __BL_ARMATURECHANNEL
#define __BL_ARMATURECHANNEL

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ArmatureConstraint.h
* \ingroup bgeconv
*/
#ifndef __BL_ARMATURECONSTRAINT
#define __BL_ARMATURECONSTRAINT

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ArmatureObject.h
* \ingroup bgeconv
*/
#ifndef BL_ARMATUREOBJECT
#define BL_ARMATUREOBJECT

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_BlenderDataConversion.h
* \ingroup bgeconv
*/
#ifndef __BLENDER_CONVERT
#define __BLENDER_CONVERT

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_DeformableGameObject.h
* \ingroup bgeconv
*/
#ifndef BL_DEFORMABLEGAMEOBJECT
#define BL_DEFORMABLEGAMEOBJECT

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_MeshDeformer.h
* \ingroup bgeconv
*/
#ifndef BL_MESHDEFORMER
#define BL_MESHDEFORMER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ModifierDeformer.h
* \ingroup bgeconv
*/
#ifndef BL_MODIFIERDEFORMER
#define BL_MODIFIERDEFORMER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ShapeActionActuator.h
* \ingroup bgeconv
*/
#ifndef BL_SHAPEACTIONACTUATOR
#define BL_SHAPEACTIONACTUATOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_ShapeDeformer.h
* \ingroup bgeconv
*/
#ifndef BL_SHAPEDEFORMER
#define BL_SHAPEDEFORMER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BL_SkinDeformer.h
* \ingroup bgeconv
*/
#ifndef BL_SKINDEFORMER
#define BL_SKINDEFORMER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file BlenderWorldInfo.h
* \ingroup bgeconv
*/
#ifndef __BLENDERWORLDINFO_H
#define __BLENDERWORLDINFO_H
#include "MT_CmMatrix4x4.h"

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderScalarInterpolator.h
* \ingroup bgeconv
*/
#ifndef __KX_SCALARINTERPOLATOR_H
#define __KX_SCALARINTERPOLATOR_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_BlenderSceneConverter.h
* \ingroup bgeconv
*/
#ifndef __KX_BLENDERSCENECONVERTER_H
#define __KX_BLENDERSCENECONVERTER_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_ConvertActuators.h
* \ingroup bgeconv
*/
#ifndef __KX_CONVERTACTUATORS_H
#define __KX_CONVERTACTUATORS_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_ConvertControllers.h
* \ingroup bgeconv
*/
#ifndef __KX_CONVERTCONTROLLERS_H
#define __KX_CONVERTCONTROLLERS_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_ConvertProperties.h
* \ingroup bgeconv
*/
#ifndef __KX_CONVERTPROPERTIES
#define __KX_CONVERTPROPERTIES

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_ConvertSensors.h
* \ingroup bgeconv
*/
#ifndef __KX_CONVERTSENSOR_H
#define __KX_CONVERTSENSOR_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_IpoConvert.h
* \ingroup bgeconv
*/
#ifndef __KX_IPOCONVERT_H
#define __KX_IPOCONVERT_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_SoftBodyDeformer.h
* \ingroup bgeconv
*/
#ifndef KX_SOFTBODYDEFORMER
#define KX_SOFTBODYDEFORMER

View File

@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file BoolValue.h
* \ingroup expressions
*/
#if !defined _BOOLVALUE_H
#define _BOOLVALUE_H

View File

@@ -13,6 +13,10 @@
*
*/
/** \file ConstExpr.h
* \ingroup expressions
*/
#ifndef __CONSTEXPR_H__
#define __CONSTEXPR_H__

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file EXP_C-Api.h
* \ingroup expressions
*/
#ifndef __EXPRESSION_INCLUDE
#define __EXPRESSION_INCLUDE

View File

@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file EmptyValue.h
* \ingroup expressions
*/
#if !defined _EMPTYVALUE_H
#define _EMPTYVALUE_H

View File

@@ -13,6 +13,10 @@
*
*/
/** \file ErrorValue.h
* \ingroup expressions
*/
#if !defined _ERRORVALUE_H
#define _ERRORVALUE_H

View File

@@ -13,6 +13,10 @@
*
*/
/** \file Expression.h
* \ingroup expressions
*/
#if !defined _EXPRESSION_H
#define _EXPRESSION_H

View File

@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file FloatValue.h
* \ingroup expressions
*/
#if !defined _FLOATVALUE_H
#define _FLOATVALUE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file IdentifierExpr.h
* \ingroup expressions
*/
#ifndef __IDENTIFIER_EXPR
#define __IDENTIFIER_EXPR

View File

@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file IfExpr.h
* \ingroup expressions
*/
#if !defined(AFX_IFEXPR_H__1F691841_C5C7_11D1_A863_0000B4542BD8__INCLUDED_)
#define AFX_IFEXPR_H__1F691841_C5C7_11D1_A863_0000B4542BD8__INCLUDED_

View File

@@ -14,6 +14,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file InputParser.h
* \ingroup expressions
*/
#ifndef __INPUTPARSER_H__
#define __INPUTPARSER_H__

View File

@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file IntValue.h
* \ingroup expressions
*/
#if !defined _INTVALUE_H
#define _INTVALUE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_HashedPtr.h
* \ingroup expressions
*/
#ifndef __KX_HASHEDPTR
#define __KX_HASHEDPTR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file KX_Python.h
* \ingroup expressions
*/
#ifndef KX_PYTHON_H
#define KX_PYTHON_H

View File

@@ -13,6 +13,10 @@
*
*/
/** \file ListValue.h
* \ingroup expressions
*/
#if !defined _LISTVALUE_H
#define _LISTVALUE_H

View File

@@ -13,6 +13,10 @@
*
*/
/** \file Operator1Expr.h
* \ingroup expressions
*/
#if !defined(AFX_OPERATOR1EXPR_H__A1653901_BF41_11D1_A51C_00A02472FC58__INCLUDED_)
#define AFX_OPERATOR1EXPR_H__A1653901_BF41_11D1_A51C_00A02472FC58__INCLUDED_

View File

@@ -13,6 +13,10 @@
*
*/
/** \file Operator2Expr.h
* \ingroup expressions
*/
#if !defined _OPERATOR2EXPR_H
#define _OPERATOR2EXPR_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PyObjectPlus.h
* \ingroup expressions
*/
#ifndef _adr_py_lib_h_ // only process once,
#define _adr_py_lib_h_ // even if multiply included

View File

@@ -13,6 +13,10 @@
*
*/
/** \file StringValue.h
* \ingroup expressions
*/
#ifndef __STRINGVALUE_H__
#define __STRINGVALUE_H__

View File

@@ -13,29 +13,14 @@
*
*/
/** \file Value.h
* \ingroup expressions
*/
#if defined(WIN32) && !defined(FREE_WINDOWS)
#pragma warning (disable:4786)
#endif //WIN32
/////////////////////////////////////////////////////////////////////////////////////
//// Baseclass CValue
//// Together with CExpression, CValue and it's derived classes can be used to
//// parse expressions into a parsetree with error detecting/correcting capabilities
//// also expandible by a CFactory pluginsystem
////
//// Features:
//// Reference Counting (AddRef() / Release())
//// Calculations (Calc() / CalcFinal())
//// Configuration (Configure())
//// Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL
//// Property system (SetProperty() / GetProperty() / FindIdentifier())
//// Replication (GetReplica())
//// Flags (IsSelected() / IsModified() / SetSelected()...)
////
//// Some small editor-specific things added
//// A helperclass CompressorArchive handles the serialization
////
/////////////////////////////////////////////////////////////////////////////////////
#ifndef __VALUE_H__
#define __VALUE_H__
@@ -184,21 +169,35 @@ public:
#endif
};
//
// CValue
//
// Base class for all editor functionality, flexible object type that allows
// calculations and uses reference counting for memory management.
//
//
#include "PyObjectPlus.h"
#ifdef WITH_PYTHON
#include "object.h"
#endif
/**
* Baseclass CValue
*
* Together with CExpression, CValue and it's derived classes can be used to
* parse expressions into a parsetree with error detecting/correcting capabilities
* also expandible by a CFactory pluginsystem
*
* Base class for all editor functionality, flexible object type that allows
* calculations and uses reference counting for memory management.
*
* Features:
* - Reference Counting (AddRef() / Release())
* - Calculations (Calc() / CalcFinal())
* - Configuration (Configure())
* - Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL
* - Property system (SetProperty() / GetProperty() / FindIdentifier())
* - Replication (GetReplica())
* - Flags (IsSelected() / IsModified() / SetSelected()...)
*
* - Some small editor-specific things added
* - A helperclass CompressorArchive handles the serialization
*
*/
class CValue : public PyObjectPlus
{

View File

@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
/** \file VectorValue.h
* \ingroup expressions
*/
#if !defined _VECTORVALUE_H
#define _VECTORVALUE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* VoidValue.h: interface for the CVoidValue class.
* $Id$
*
@@ -27,6 +27,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file VoidValue.h
* \ingroup expressions
*/
#ifndef __VOIDVALUE_H__
#define __VOIDVALUE_H__

View File

@@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_Joystick.h
* \ingroup gamelogic
*/
#ifndef _SCA_JOYSTICK_H_
#define _SCA_JOYSTICK_H_
@@ -33,7 +37,7 @@
#include "SDL.h"
#endif
/*
/**
* Basic Joystick class
* I will make this class a singleton because there should be only one joystick
* even if there are more than one scene using it and count how many scene are using it.
@@ -53,22 +57,22 @@ class SCA_Joystick
#endif
int m_joyindex;
/*
/**
*support for JOYAXIS_MAX axes (in pairs)
*/
int m_axis_array[JOYAXIS_MAX];
/*
/**
*support for JOYHAT_MAX hats (each is a direction)
*/
int m_hat_array[JOYHAT_MAX];
/*
/**
* Precision or range of the axes
*/
int m_prec;
/*
/**
* max # of buttons avail
*/
@@ -76,17 +80,17 @@ class SCA_Joystick
int m_buttonmax;
int m_hatmax;
/* is the joystick initialized ?*/
/** is the joystick initialized ?*/
bool m_isinit;
/* is triggered for each event type */
/** is triggered for each event type */
bool m_istrig_axis;
bool m_istrig_button;
bool m_istrig_hat;
#ifndef DISABLE_SDL
/*
/**
* event callbacks
*/
void OnAxisMotion(SDL_Event *sdl_event);
@@ -99,27 +103,27 @@ class SCA_Joystick
#endif
#endif
/*
/**
* Open the joystick
*/
bool CreateJoystickDevice(void);
/*
/**
* Close the joystick
*/
void DestroyJoystickDevice(void);
/*
/**
* fills the axis mnember values
*/
void pFillButtons(void);
/*
/**
* returns m_axis_array
*/
int pAxisTest(int axisnum);
/*
/**
* returns m_axis_array
*/
int pGetAxis(int axisnum, int udlr);
@@ -146,7 +150,7 @@ public:
bool aButtonReleaseIsPositive(int button);
bool aHatIsPositive(int hatnum, int dir);
/*
/**
* precision is default '3200' which is overridden by input
*/
@@ -176,7 +180,7 @@ public:
return m_istrig_hat;
}
/*
/**
* returns the # of...
*/
@@ -184,7 +188,7 @@ public:
int GetNumberOfButtons(void);
int GetNumberOfHats(void);
/*
/**
* Test if the joystick is connected
*/
int Connected(void);

View File

@@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -24,6 +24,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_JoystickDefines.h
* \ingroup gamelogic
*/
#ifndef _SCA_JOYSTICKDEFINES_H_
#define _SCA_JOYSTICKDEFINES_H_

View File

@@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_JoystickPrivate.h
* \ingroup gamelogic
*/
#ifndef __SCA_JOYSTICKPRIVATE_H__
#define __SCA_JOYSTICKPRIVATE_H__
#include "SCA_Joystick.h"

View File

@@ -1,4 +1,4 @@
/**
/*
* SCA_2DFilterActuator.h
*
* $Id$
@@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_2DFilterActuator.h
* \ingroup gamelogic
*/
#ifndef __SCA_2DFILETRACTUATOR_H__
#define __SCA_2DFILETRACTUATOR_H__

View File

@@ -1,4 +1,4 @@
/**
/*
* SCA_ANDController.h
*
* $Id$
@@ -29,6 +29,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_ANDController.h
* \ingroup gamelogic
*/
#ifndef __KX_ANDCONTROLLER
#define __KX_ANDCONTROLLER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_ActuatorEventManager.h
* \ingroup gamelogic
*/
#ifndef __KX_ACTUATOREVENTMANAGER
#define __KX_ACTUATOREVENTMANAGER

View File

@@ -1,4 +1,4 @@
/**
/*
* Actuator sensor
*
* $Id$
@@ -29,6 +29,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_ActuatorSensor.h
* \ingroup gamelogic
*/
#ifndef __KX_ACTUATORSENSOR
#define __KX_ACTUATORSENSOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_AlwaysEventManager.h
* \ingroup gamelogic
*/
#ifndef __KX_ALWAYSEVENTMGR
#define __KX_ALWAYSEVENTMGR
#include "SCA_EventManager.h"

View File

@@ -1,4 +1,4 @@
/**
/*
* SCA_AlwaysSensor.h
*
* $Id$
@@ -29,6 +29,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_AlwaysSensor.h
* \ingroup gamelogic
*/
#ifndef __KX_ALWAYSSENSOR
#define __KX_ALWAYSSENSOR
#include "SCA_ISensor.h"

View File

@@ -1,4 +1,4 @@
/**
/*
* Manager for sensor that only need to call Update
*
* $Id$
@@ -29,6 +29,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_BasicEventManager.h
* \ingroup gamelogic
*/
#ifndef __SCA_BASICEVENTMGR
#define __SCA_BASICEVENTMGR

View File

@@ -1,4 +1,4 @@
/**
/*
* SCA_DelaySensor.h
*
* $Id$
@@ -29,6 +29,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_DelaySensor.h
* \ingroup gamelogic
*/
#ifndef __KX_DELAYSENSOR
#define __KX_DELAYSENSOR
#include "SCA_ISensor.h"

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_EventManager.h
* \ingroup gamelogic
*/
#ifndef __KX_EVENTMANAGER
#define __KX_EVENTMANAGER

View File

@@ -1,4 +1,4 @@
/**
/*
* KX_EXPRESSIONController.h
*
* $Id$
@@ -29,6 +29,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_ExpressionController.h
* \ingroup gamelogic
*/
#ifndef __KX_EXPRESSIONCONTROLLER
#define __KX_EXPRESSIONCONTROLLER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,13 +26,18 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_IActuator.h
* \ingroup gamelogic
*/
#ifndef __KX_IACTUATOR
#define __KX_IACTUATOR
#include "SCA_IController.h"
#include <vector>
/*
/**
* Use of SG_DList : None
* Use of SG_QList : element of activated actuator list of their owner
* Head: SCA_IObject::m_activeActuators

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,13 +26,18 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_IController.h
* \ingroup gamelogic
*/
#ifndef __KX_ICONTROLLER
#define __KX_ICONTROLLER
#include "SCA_ILogicBrick.h"
#include "PyObjectPlus.h"
/*
/**
* Use of SG_DList element: none
* Use of SG_QList element: build ordered list of activated controller on the owner object
* Head: SCA_IObject::m_activeControllers

View File

@@ -1,7 +1,4 @@
/**
* Interface for input devices. The defines for keyboard/system/mouse events
* here are for internal use in the KX module.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -30,6 +27,13 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_IController.h
* \ingroup gamelogic
* \brief Interface for input devices. The defines for keyboard/system/mouse events
* here are for internal use in the KX module.
*
*/
#ifndef KX_INPUTDEVICE_H
#define KX_INPUTDEVICE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_ILogicBrick.h
* \ingroup gamelogic
*/
#ifndef __KX_ILOGICBRICK
#define __KX_ILOGICBRICK

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,9 +25,12 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* An abstract object that has some logic, python scripting and
* reference counting Note: transformation stuff has been moved to
* SceneGraph
*/
/** \file SCA_IController.h
* \ingroup gamelogic
* \brief An abstract object that has some logic, python scripting and
* reference counting Note: transformation stuff has been moved to
* SceneGraph
*/
#ifndef SCA_IOBJECT_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_IScene.h
* \ingroup gamelogic
*/
#ifndef __KX_ISCENE_H
#define __KX_ISCENE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,8 +25,12 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* Interface Class for all logic Sensors. Implements
* pulsemode and pulsefrequency, and event suppression.
*/
/** \file SCA_IController.h
* \ingroup gamelogic
* \brief Interface Class for all logic Sensors. Implements
* pulsemode and pulsefrequency, and event suppression.
*/
#ifndef __SCA_ISENSOR

View File

@@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_JoystickManager.h
* \ingroup gamelogic
*/
#ifndef __JOYSTICKMANAGER_H_
#define __JOYSTICKMANAGER_H_

View File

@@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_JoystickSensor.h
* \ingroup gamelogic
*/
#ifndef __JOYSENSOR_H_
#define __JOYSENSOR_H

View File

@@ -1,6 +1,4 @@
/**
* Manager for keyboard events
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,12 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_KeyboardManager.h
* \ingroup gamelogic
* \brief Manager for keyboard events
*
*/
#ifndef __KX_KEYBOARDMANAGER
#define __KX_KEYBOARDMANAGER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,7 +25,11 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* Sensor for keyboard input
*/
/** \file SCA_KeyboardSensor.h
* \ingroup gamelogic
* \brief Sensor for keyboard input
*/
#ifndef __KX_KEYBOARDSENSOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,7 +25,10 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* Regulates the top-level logic behaviour for one scene.
*/
/** \file SCA_IController.h
* \ingroup gamelogic
* \brief Regulates the top-level logic behaviour for one scene.
*/
#ifndef __KX_LOGICMANAGER
#define __KX_LOGICMANAGER

View File

@@ -1,6 +1,4 @@
/**
* Manager for mouse events
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,12 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_MouseManager.h
* \ingroup gamelogic
* \brief Manager for mouse events.
*
*/
#ifndef __KX_MOUSEMANAGER
#define __KX_MOUSEMANAGER

View File

@@ -1,6 +1,4 @@
/**
* Senses mouse events
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_MouseSensor.h
* \ingroup gamelogic
* \brief Senses mouse events
*/
#ifndef __KX_MOUSESENSOR
#define __KX_MOUSESENSOR

View File

@@ -1,6 +1,4 @@
/**
* SCA_NANDController.h
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_NANDController.h
* \ingroup gamelogic
*/
#ifndef __KX_NANDCONTROLLER
#define __KX_NANDCONTROLLER

View File

@@ -1,6 +1,4 @@
/**
* SCA_NORController.h
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_NORController.h
* \ingroup gamelogic
*/
#ifndef __KX_NORCONTROLLER
#define __KX_NORCONTROLLER

View File

@@ -1,6 +1,4 @@
/**
* SCA_ORController.h
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_ORController.h
* \ingroup gamelogic
*/
#ifndef __KX_ORCONTROLLER
#define __KX_ORCONTROLLER

View File

@@ -1,6 +1,4 @@
/**
* SCA_PropertyActuator.h
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_PropertyActuator.h
* \ingroup gamelogic
*/
#ifndef __KX_PROPERTYACTUATOR
#define __KX_PROPERTYACTUATOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_PropertyEventManager.h
* \ingroup gamelogic
*/
#ifndef __KX_PROPERTYEVENTMANAGER
#define __KX_PROPERTYEVENTMANAGER

View File

@@ -1,6 +1,4 @@
/**
* Property sensor
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_PropertySensor.h
* \ingroup gamelogic
* \brief Property sensor
*/
#ifndef __KX_PROPERTYSENSOR
#define __KX_PROPERTYSENSOR

View File

@@ -1,6 +1,4 @@
/**
* Execute Python scripts
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_PythonController.h
* \ingroup gamelogic
* \brief Execute Python scripts
*/
#ifndef KX_PYTHONCONTROLLER_H
#define KX_PYTHONCONTROLLER_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -22,6 +22,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_PythonKeyboard.h
* \ingroup gamelogic
*/
#ifndef __KX_PYKEYBOARD
#define __KX_PYKEYBOARD

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -22,6 +22,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_PythonMouse.h
* \ingroup gamelogic
*/
#ifndef __KX_PYMOUSE
#define __KX_PYMOUSE

View File

@@ -1,7 +1,4 @@
/**
* Draw a random number, and put it in a property
*
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -30,6 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_RandomActuator.h
* \ingroup gamelogic
* \brief Draw a random number, and put it in a property
*/
#ifndef __KX_RANDOMACTUATOR
#define __KX_RANDOMACTUATOR

View File

@@ -1,6 +1,4 @@
/**
* Manager for random events
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_RandomEventManager.h
* \ingroup gamelogic
* \brief Manager for random events
*/
#ifndef __KX_RANDOMEVENTMGR
#define __KX_RANDOMEVENTMGR

View File

@@ -1,8 +1,4 @@
/**
* Generate random numbers that can be used by other components. Each
* generator needs its own generator, so that the seed can be set
* on a per-generator basis.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -31,6 +27,13 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_RandomNumberGenerator.h
* \ingroup gamelogic
* \brief Generate random numbers that can be used by other components. Each
* generator needs its own generator, so that the seed can be set
* on a per-generator basis.
*/
#ifndef __KX_RANDOMNUMBERGENERATOR
#define __KX_RANDOMNUMBERGENERATOR

View File

@@ -1,6 +1,4 @@
/**
* Generate random pulses
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_RandomSensor.h
* \ingroup gamelogic
* \brief Generate random pulses
*/
#ifndef __KX_RANDOMSENSOR
#define __KX_RANDOMSENSOR

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_TimeEventManager.h
* \ingroup gamelogic
*/
#ifndef __KX_TIMEEVENTMANAGER
#define __KX_TIMEEVENTMANAGER

View File

@@ -1,6 +1,4 @@
/**
* SCA_XNORController.h
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_XNORController.h
* \ingroup gamelogic
*/
#ifndef __KX_XNORCONTROLLER
#define __KX_XNORCONTROLLER

View File

@@ -1,6 +1,4 @@
/**
* SCA_XORController.h
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -29,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_XORController.h
* \ingroup gamelogic
*/
#ifndef __KX_XORCONTROLLER
#define __KX_XORCONTROLLER

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file GPC_Canvas.h
* \ingroup player
*/
#ifndef _GPC_CANVAS_H_
#define _GPC_CANVAS_H_

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file GPC_Engine.h
* \ingroup player
*/
#ifndef __GPC_ENGINE_H
#define __GPC_ENGINE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file GPC_KeyboardDevice.h
* \ingroup player
*/
#ifndef __GPC_KEYBOARDDEVICE_H
#define __GPC_KEYBOARDDEVICE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file GPC_MouseDevice.h
* \ingroup player
*/
#ifndef __GPC_MOUSE_DEVICE_H
#define __GPC_MOUSE_DEVICE_H

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file GPC_RawImage.h
* \ingroup player
*/
#ifndef __GPC_RAWIMAGE_H__
#define __GPC_RAWIMAGE_H__

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file GPC_RawLoadDotBlendArray.h
* \ingroup player
*/
#ifndef __GPC_RAWLOADDOTBLENDARRAY_H
#define __GPC_RAWLOADDOTBLENDARRAY_H

Some files were not shown because too many files have changed in this diff Show More