forked from bartvdbraak/blender
becd467be8
rayCast(to,from,dist,prop,face,xray,poly):
The face paremeter determines the orientation of the normal:
0 or omitted => hit normal is always oriented towards the ray origin (as if you casted the ray from outside)
1 => hit normal is the real face normal (only for mesh object, otherwise face has no effect)
The ray has X-Ray capability if xray parameter is 1, otherwise the first object hit (other than self object) stops the ray.
The prop and xray parameters interact as follow:
prop off, xray off: return closest hit or no hit if there is no object on the full extend of the ray.
prop off, xray on : idem.
prop on, xray off: return closest hit if it matches prop, no hit otherwise.
prop on, xray on : return closest hit matching prop or no hit if there is no object matching prop on the full extend of the ray.
if poly is 0 or omitted, returns a 3-tuple with object reference, hit point and hit normal or (None,None,None) if no hit.
if poly is 1, returns a 4-tuple with in addition a KX_PolyProxy as 4th element.
The KX_PolyProxy object holds information on the polygon hit by the ray: the index of the vertex forming the poylgon, material, etc.
Attributes (read-only):
matname: The name of polygon material, empty if no material.
material: The material of the polygon
texture: The texture name of the polygon.
matid: The material index of the polygon, use this to retrieve vertex proxy from mesh proxy
v1: vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy
v2: vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy
v3: vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy
v4: vertex index of the fourth vertex of the polygon, 0 if polygon has only 3 vertex
use this to retrieve vertex proxy from mesh proxy
visible: visible state of the polygon: 1=visible, 0=invisible
collide: collide state of the polygon: 1=receives collision, 0=collision free.
Methods:
getMaterialName(): Returns the polygon material name with MA prefix
getMaterial(): Returns the polygon material
getTextureName(): Returns the polygon texture name
getMaterialIndex(): Returns the material bucket index of the polygon.
getNumVertex(): Returns the number of vertex of the polygon.
isVisible(): Returns whether the polygon is visible or not
isCollider(): Returns whether the polygon is receives collision or not
getVertexIndex(vertex): Returns the mesh vertex index of a polygon vertex
getMesh(): Returns a mesh proxy
New methods of KX_MeshProxy have been implemented to retrieve KX_PolyProxy objects:
getNumPolygons(): Returns the number of polygon in the mesh.
getPolygon(index): Gets the specified polygon from the mesh.
More details in PyDoc.
162 lines
4.8 KiB
C++
162 lines
4.8 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_RayCast;
|
|
|
|
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;
|
|
// sinus of minimum angle
|
|
float m_minimumSine;
|
|
// sinus of maximum angle
|
|
float m_maximumSine;
|
|
// 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_DIRNX,
|
|
KX_ACT_CONSTRAINT_DIRNY,
|
|
KX_ACT_CONSTRAINT_DIRNZ,
|
|
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, KX_RayCast* result, void * const data);
|
|
bool NeedRayCast(KX_ClientObjectInfo*);
|
|
|
|
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_NOARGS(KX_ConstraintActuator,GetDamp);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetRotDamp);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetRotDamp);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetDirection);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetDirection);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetOption);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetOption);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetTime);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetTime);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetProperty);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetProperty);
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMin);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetMin);
|
|
static char SetDistance_doc[];
|
|
static char GetDistance_doc[];
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetMax);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetMax);
|
|
static char SetRayLength_doc[];
|
|
static char GetRayLength_doc[];
|
|
KX_PYMETHOD_DOC(KX_ConstraintActuator,SetLimit);
|
|
KX_PYMETHOD_DOC_NOARGS(KX_ConstraintActuator,GetLimit);
|
|
};
|
|
|
|
#endif //__KX_CONSTRAINTACTUATOR
|
|
|