mvBaseForce Class Reference

interface/abstract class for creating user-defined forces More...

#include <mvBaseForce.h>

Inheritance diagram for mvBaseForce:

mvGravityForce mvUniformAccelForce

List of all members.

Public Member Functions

virtual bool calcFullForces (mvForceResultPtr fResult)=0
 calculates the full forces applied on a body - MUST BE OVERLOADED
virtual void filter (mvForceStatus &worldStatus)
 blah blah
virtual mvErrorEnum getParameterf (mvParamEnum paramFlag, mvFloat *dest) const
 blah blah
virtual mvErrorEnum getParameteri (mvParamEnum paramFlag, mvIndex *index) const
 blah blah
virtual mvErrorEnum getParametero (mvParamEnum paramFlag, mvOptionEnum *dest) const
 blah blah
virtual mvErrorEnum getParameterv (mvParamEnum paramFlag, mvFloat *dest, mvCount *size) const
 blah blah
mvOptionEnum getType () const
 blah blah
void * getUserData () const
 blah blah
bool isEnabled () const
 blah blah
 mvBaseForce (mvOptionEnum type)
 mvBaseForce.cpp Copyright (c) 2006, 2007 David Young.
void setEnabled (bool value)
 blah blah
virtual mvErrorEnum setParameterf (mvParamEnum paramFlag, mvFloat num)
 blah blah
virtual mvErrorEnum setParameteri (mvParamEnum paramFlag, mvIndex index)
 blah blah
virtual mvErrorEnum setParametero (mvParamEnum paramFlag, mvOptionEnum option)
 blah blah
virtual mvErrorEnum setParameterv (mvParamEnum paramFlag, mvFloat *numArray)
 blah blah
void setUserData (void *tempData)
 blah blah
virtual ~mvBaseForce ()
 blah blah


Detailed Description

interface/abstract class for creating user-defined forces

Constructor & Destructor Documentation

mvBaseForce::mvBaseForce ( mvOptionEnum  type  ) 

mvBaseForce.cpp 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. blah blah


Member Function Documentation

virtual bool mvBaseForce::calcFullForces ( mvForceResultPtr  fResult  )  [pure virtual]

calculates the full forces applied on a body - MUST BE OVERLOADED

Parameters:
[in,out] fResult Module for storing result & retrieve information about current system
Returns:
If this mvBaseForce should be included in total forces applied on the current body

Implemented in mvGravityForce, and mvUniformAccelForce.


The documentation for this class was generated from the following files:
Generated on Wed Nov 14 17:04:59 2007 for mvMotionAI by  doxygen 1.5.3