blender/source/gameengine/Ketsji/KX_CameraActuator.h

139 lines
3.3 KiB
C
Raw Normal View History

/*
2002-10-12 11:37:38 +00:00
* KX_CameraActuator.h
*
*
* ***** BEGIN GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*
* 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.
2002-10-12 11:37:38 +00:00
*
* 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,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2002-10-12 11:37:38 +00:00
*
* 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 *****
2002-10-12 11:37:38 +00:00
*/
/** \file KX_CameraActuator.h
* \ingroup ketsji
*/
#ifndef __KX_CAMERAACTUATOR_H__
#define __KX_CAMERAACTUATOR_H__
2002-10-12 11:37:38 +00:00
#include "SCA_IActuator.h"
#include "MT_Scalar.h"
#include "SCA_LogicManager.h"
2002-10-12 11:37:38 +00:00
/**
* The camera actuator does a Robbie Muller perspective for you. This is a
2002-10-12 11:37:38 +00:00
* weird set of rules that positions the camera sort of behind the object,
* tracking, while avoiding any objects between the 'ideal' position and the
* actor being tracked.
*/
class KX_CameraActuator : public SCA_IActuator
{
Py_Header
private :
2002-10-12 11:37:38 +00:00
/** Object that will be tracked. */
SCA_IObject *m_ob;
2002-10-12 11:37:38 +00:00
/** height (float), */
//const MT_Scalar m_height;
/** min (float), */
//const MT_Scalar m_minHeight;
/** max (float), */
//const MT_Scalar m_maxHeight;
/** height (float), */
2009-02-07 20:35:16 +00:00
float m_height;
2002-10-12 11:37:38 +00:00
/** min (float), */
2009-02-07 20:35:16 +00:00
float m_minHeight;
2002-10-12 11:37:38 +00:00
/** max (float), */
2009-02-07 20:35:16 +00:00
float m_maxHeight;
2002-10-12 11:37:38 +00:00
/** axis the camera tries to get behind: +x/+y/-x/-y */
short m_axis;
/** damping (float), */
float m_damping;
2002-10-12 11:37:38 +00:00
/* get the KX_IGameObject with this name */
CValue *findObject(const char *obName);
2002-10-12 11:37:38 +00:00
/* parse x or y to a toggle pick */
bool string2axischoice(const char *axisString);
public:
static STR_String X_AXIS_STRING;
static STR_String Y_AXIS_STRING;
/**
* Set the bool toggle to true to use x lock, false for y lock
*/
KX_CameraActuator(
SCA_IObject *gameobj,
//const CValue *ob,
SCA_IObject *ob,
2009-02-07 20:35:16 +00:00
float hght,
float minhght,
float maxhght,
short axis,
float damping
2002-10-12 11:37:38 +00:00
);
~KX_CameraActuator();
/** Methods Inherited from CValue */
CValue* GetReplica();
virtual void ProcessReplica();
2002-10-12 11:37:38 +00:00
/** Methods inherited from SCA_IActuator */
virtual bool Update(
2002-10-12 11:37:38 +00:00
double curtime,
bool frame
2002-10-12 11:37:38 +00:00
);
virtual bool UnlinkObject(SCA_IObject* clientobj);
2002-10-12 11:37:38 +00:00
/** Methods inherited from SCA_ILogicBrick */
virtual void Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);
2002-10-12 11:37:38 +00:00
#ifdef WITH_PYTHON
2002-10-12 11:37:38 +00:00
/* --------------------------------------------------------------------- */
/* Python interface ---------------------------------------------------- */
/* --------------------------------------------------------------------- */
/* set object to look at */
static PyObject* pyattr_get_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
static int pyattr_set_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
2002-10-12 11:37:38 +00:00
#endif /* WITH_PYTHON */
2002-10-12 11:37:38 +00:00
};
#endif /* __KX_CAMERAACTUATOR_H__ */