D:/mvMotionAI/mvMotionAI/include/mv/mvEnums.h File Reference

#include <mv/mvMotionAI-Types.h>

Enumerations
enum	mvEffectTypeEnum { MV_DEFAULT_EFFECT = 0, MV_GLOBAL_EFFECT, MV_LOCAL_EFFECT }
	Determines the effect of the forces recorded in mvBehaviourResult & mvForceResult. More...
enum	mvErrorEnum { MV_NO_ERROR = 0 }
	Error codes in mvMotionAI library. More...
enum	mvMotionTypeEnum { MV_DEFAULT_MOTION = 0, MV_STEERING_MOTION, MV_DIRECTIONAL_MOTION }
	Determines the type of force recorded in mvBehaviourResult & mvForceResult. More...
enum	mvOptionEnum {   MV_FALSE = 0, MV_TRUE , MV_GROUP_BEHAVIOUR_MEMBER_ENTRY, MV_EXISTING_GROUP_BEHAVIOUR,   MV_EXISTING_BEHAVIOUR }
	Option or state values within mvMotionAI library. More...
enum	mvParamEnum
	Enums for querying and setting variables in mvMotionAI library.

---

Detailed Description

Copyright (c) 2006, 2007 David Young.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---

Enumeration Type Documentation

enum mvEffectTypeEnum

Determines the effect of the forces recorded in mvBehaviourResult & mvForceResult.

Enumerator:

MV_DEFAULT_EFFECT	default effect applied
MV_GLOBAL_EFFECT	force effect applied w.r.t. world/global coordinates
MV_LOCAL_EFFECT	force effect applied w.r.t. the direction that the body is facing

enum mvErrorEnum

Error codes in mvMotionAI library.

If no problems MV_NO_ERROR (0) is returned, else any nonzero value means an error has occured. If programming with the mvMotionAI, avoid using MV_ERROR_ENUM_IS_NOT_FOUND as it has no real meaning.

Enumerator:

MV_NO_ERROR

no error has occured, normal operation

enum mvMotionTypeEnum

Determines the type of force recorded in mvBehaviourResult & mvForceResult.

Enumerator:

MV_DEFAULT_MOTION	default motion applied
MV_STEERING_MOTION	steering motion applied i.e. change in motion needed
MV_DIRECTIONAL_MOTION	direction motion applied i.e. the desired final motion

enum mvOptionEnum

Option or state values within mvMotionAI library.

Enumerator:

MV_FALSE	false or zero
MV_TRUE	true or non zero : NOTE in boolean situation, any error code other than MV_FALSE is true
MV_GROUP_BEHAVIOUR_MEMBER_ENTRY	RESERVED for internal use
MV_EXISTING_GROUP_BEHAVIOUR	RESERVED for internal use
MV_EXISTING_BEHAVIOUR	RESERVED for internal use

---