70d239ef7d
General
=======
- Removal of Damp option in motion actuator (replaced by
Servo control motion).
- No PyDoc at present, will be added soon.
Generalization of the Lvl option
================================
A sensor with the Lvl option selected will always produce an
event at the start of the game or when entering a state or at
object creation. The event will be positive or negative
depending of the sensor condition. A negative pulse makes
sense when used with a NAND controller: it will be converted
into an actuator activation.
Servo control motion
====================
A new variant of the motion actuator allows to control speed
with force. The control if of type "PID" (Propotional, Integral,
Derivate): the force is automatically adapted to achieve the
target speed. All the parameters of the servo controller are
configurable. The result is a great variety of motion style:
anysotropic friction, flying, sliding, pseudo Dloc...
This actuator should be used in preference to Dloc and LinV
as it produces more fluid movements and avoids the collision
problem with Dloc.
LinV : target speed as (X,Y,Z) vector in local or world
coordinates (mostly useful in local coordinates).
Limit: the force can be limited along each axis (in the same
coordinates of LinV). No limitation means that the force
will grow as large as necessary to achieve the target
speed along that axis. Set a max value to limit the
accelaration along an axis (slow start) and set a min
value (negative) to limit the brake force.
P: Proportional coefficient of servo controller, don't set
directly unless you know what you're doing.
I: Integral coefficient of servo controller. Use low value
(<0.1) for slow reaction (sliding), high values (>0.5)
for hard control. The P coefficient will be automatically
set to 60 times the I coefficient (a reasonable value).
D: Derivate coefficient. Leave to 0 unless you know what
you're doing. High values create instability.
Notes: - This actuator works perfectly in zero friction
environment: the PID controller will simulate friction
by applying force as needed.
- This actuator is compatible with simple Drot motion
actuator but not with LinV and Dloc motion.
- (0,0,0) is a valid target speed.
- All parameters are accessible through Python.
Distance constraint actuator
============================
A new variant of the constraint actuator allows to set the
distance and orientation relative to a surface. The controller
uses a ray to detect the surface (or any object) and adapt the
distance and orientation parallel to the surface.
Damp: Time constant (in nb of frames) of distance and
orientation control.
Dist: Select to enable distance control and set target
distance. The object will be position at the given
distance of surface along the ray direction.
Direction: chose a local axis as the ray direction.
Range: length of ray. Objecgt within this distance will be
detected.
N : Select to enable orientation control. The actuator will
change the orientation and the location of the object
so that it is parallel to the surface at the vertical
of the point of contact of the ray.
M/P : Select to enable material detection. Default is property
detection.
Property/Material: name of property/material that the target of
ray must have to be detected. If not set, property/
material filter is disabled and any collisioning object
within range will be detected.
PER : Select to enable persistent operation. Normally the
actuator disables itself automatically if the ray does
not reach a valid target.
time : Maximum activation time of actuator.
0 : unlimited.
>0: number of frames before automatic deactivation.
rotDamp: Time constant (in nb of frame) of orientation control.
0 : use Damp parameter.
>0: use a different time constant for orientation.
Notes: - If neither N nor Dist options are set, the actuator
does not change the position and orientation of the
object; it works as a ray sensor.
- The ray has no "X-ray" capability: if the first object
hit does not have the required property/material, it
returns no hit and the actuator disables itself unless
PER option is enabled.
- This actuator changes the position and orientation but
not the speed of the object. This has an important
implication in a gravity environment: the gravity will
cause the speed to increase although the object seems
to stay still (it is repositioned at each frame).
The gravity must be compensated in one way or another.
the new servo control motion actuator is the simplest
way: set the target speed along the ray axis to 0
and the servo control will automatically compensate
the gravity.
- This actuator changes the orientation of the object
and will conflict with Drot motion unless it is
placed BEFORE the Drot motion actuator (the order of
actuator is important)
- All parameters are accessible through Python.
Orientation constraint
======================
A new variant of the constraint actuator allows to align an
object axis along a global direction.
Damp : Time constant (in nb of frames) of orientation control.
X,Y,Z: Global coordinates of reference direction.
time : Maximum activation time of actuator.
0 : unlimited.
>0: number of frames before automatic deactivation.
Notes: - (X,Y,Z) = (0,0,0) is not a valid direction
- This actuator changes the orientation of the object
and will conflict with Drot motion unless it is placed
BEFORE the Drot motion actuator (the order of
actuator is important).
- This actuator doesn't change the location and speed.
It is compatible with gravity.
- All parameters are accessible through Python.
Actuator sensor
===============
This sensor detects the activation and deactivation of actuators
of the same object. The sensor generates a positive pulse when
the corresponding sensor is activated and a negative pulse when
it is deactivated (the contrary if the Inv option is selected).
This is mostly useful to chain actions and to detect the loss of
contact of the distance motion actuator.
Notes: - Actuators are disabled at the start of the game; if you
want to detect the On-Off transition of an actuator
after it has been activated at least once, unselect the
Lvl and Inv options and use a NAND controller.
- Some actuators deactivates themselves immediately after
being activated. The sensor detects this situation as
an On-Off transition.
- The actuator name can be set through Python.
155 lines
4.6 KiB
C++
155 lines
4.6 KiB
C++
/**
|
|
* KX_ConstraintActuator.h
|
|
*
|
|
* $Id$
|
|
*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
#ifndef __KX_CONSTRAINTACTUATOR
|
|
#define __KX_CONSTRAINTACTUATOR
|
|
|
|
#include "SCA_IActuator.h"
|
|
#include "MT_Scalar.h"
|
|
#include "MT_Vector3.h"
|
|
#include "KX_ClientObjectInfo.h"
|
|
|
|
class KX_ConstraintActuator : public SCA_IActuator
|
|
{
|
|
Py_Header;
|
|
protected:
|
|
// Damp time (int),
|
|
int m_posDampTime;
|
|
int m_rotDampTime;
|
|
// min (float)
|
|
float m_minimumBound;
|
|
// max (float)
|
|
float m_maximumBound;
|
|
// reference direction
|
|
MT_Vector3 m_refDirection;
|
|
// locrotxyz choice (pick one): only one choice allowed at a time!
|
|
int m_locrot;
|
|
// active time of actuator
|
|
int m_activeTime;
|
|
int m_currentTime;
|
|
// option
|
|
int m_option;
|
|
// property to check
|
|
char m_property[32];
|
|
|
|
/**
|
|
* Clamp <var> to <min>, <max>. Borders are included (in as far as
|
|
* float comparisons are good for equality...).
|
|
*/
|
|
void Clamp(MT_Scalar &var, float min, float max);
|
|
|
|
|
|
public:
|
|
// m_locrot
|
|
enum KX_CONSTRAINTTYPE {
|
|
KX_ACT_CONSTRAINT_NODEF = 0,
|
|
KX_ACT_CONSTRAINT_LOCX,
|
|
KX_ACT_CONSTRAINT_LOCY,
|
|
KX_ACT_CONSTRAINT_LOCZ,
|
|
KX_ACT_CONSTRAINT_ROTX,
|
|
KX_ACT_CONSTRAINT_ROTY,
|
|
KX_ACT_CONSTRAINT_ROTZ,
|
|
KX_ACT_CONSTRAINT_DIRPX,
|
|
KX_ACT_CONSTRAINT_DIRPY,
|
|
KX_ACT_CONSTRAINT_DIRPZ,
|
|
KX_ACT_CONSTRAINT_DIRMX,
|
|
KX_ACT_CONSTRAINT_DIRMY,
|
|
KX_ACT_CONSTRAINT_DIRMZ,
|
|
KX_ACT_CONSTRAINT_ORIX,
|
|
KX_ACT_CONSTRAINT_ORIY,
|
|
KX_ACT_CONSTRAINT_ORIZ,
|
|
KX_ACT_CONSTRAINT_MAX
|
|
};
|
|
// match ACT_CONST_... values from BIF_interface.h
|
|
enum KX_CONSTRAINTOPT {
|
|
KX_ACT_CONSTRAINT_NORMAL = 64,
|
|
KX_ACT_CONSTRAINT_MATERIAL = 128,
|
|
KX_ACT_CONSTRAINT_PERMANENT = 256,
|
|
KX_ACT_CONSTRAINT_DISTANCE = 512
|
|
};
|
|
bool IsValidMode(KX_CONSTRAINTTYPE m);
|
|
bool RayHit(KX_ClientObjectInfo* client, MT_Point3& hit_point, MT_Vector3& hit_normal, void * const data);
|
|
|
|
KX_ConstraintActuator(SCA_IObject* gameobj,
|
|
int posDamptime,
|
|
int rotDampTime,
|
|
float min,
|
|
float max,
|
|
float refDir[3],
|
|
int locrot,
|
|
int time,
|
|
int option,
|
|
char *property,
|
|
PyTypeObject* T=&Type);
|
|
virtual ~KX_ConstraintActuator();
|
|
virtual CValue* GetReplica() {
|
|
KX_ConstraintActuator* replica = new KX_ConstraintActuator(*this);
|
|
replica->ProcessReplica();
|
|
// this will copy properties and so on...
|
|
CValue::AddDataToReplica(replica);
|
|
return replica;
|
|
};
|
|
|
|
virtual bool Update(double curtime, bool frame);
|
|
|
|
/* --------------------------------------------------------------------- */
|
|
/* Python interface ---------------------------------------------------- */
|
|
/* --------------------------------------------------------------------- */
|
|
|
|
virtual PyObject* _getattr(const STR_String& attr);
|
|
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDamp);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetDamp);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetRotDamp);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetRotDamp);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDirection);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetDirection);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetOption);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetOption);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetTime);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetTime);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetProperty);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetProperty);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMin);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetMin);
|
|
static char SetDistance_doc[];
|
|
static char GetDistance_doc[];
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMax);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetMax);
|
|
static char SetRayLength_doc[];
|
|
static char GetRayLength_doc[];
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetLimit);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,GetLimit);
|
|
};
|
|
|
|
#endif //__KX_CONSTRAINTACTUATOR
|
|
|