mvGroupBehaviour Class Reference

A cooperative behaviour between groups of objects. More...

#include <mvGroupBehaviour_V2.h>

List of all members.

Public Member Functions

mvErrorEnum addGroup (mvIndex groupNo, mvBaseActionPtr behavPtr)
 (one liner)
mvGroupBehaviourGroupNodePtr findGroupNode (mvIndex groupIndex) const
 (one liner)
mvGroupBehaviourGroupNodePtr getGroupNodeByIndex (mvIndex index) const
 (one liner)
mvErrorEnum getGroupParameterf_str (mvIndex groupIndex, const char *param, mvFloat *num) const
 (one liner)
mvErrorEnum getGroupParameteri (mvIndex groupIndex, mvParamEnum paramFlag, mvIndex *index) const
 (one liner)
mvErrorEnum getGroupParameteri_str (mvIndex groupIndex, const char *param, mvIndex *index) const
 (one liner)
mvErrorEnum getGroupParametero (mvIndex groupIndex, mvParamEnum paramFlag, mvOptionEnum *option) const
 (one liner)
mvErrorEnum getGroupParametero_str (mvIndex groupIndex, const char *param, const char **option) const
 (one liner)
mvErrorEnum getGroupParameterv (mvIndex groupIndex, mvParamEnum paramFlag, mvFloat *numArray, mvCount *noOfParameters) const
 (one liner)
mvErrorEnum getGroupParameterv_str (mvIndex groupIndex, const char *param, mvFloat *numArray, mvCount *noOfParameters) const
 (one liner)
mvCount getNoOfGroups () const
 (one liner)
mvErrorEnum getParameterf (mvParamEnum paramFlag, mvFloat *num) const
 (one liner)
mvErrorEnum getParameteri (mvParamEnum paramFlag, mvIndex *index) const
 (one liner)
mvErrorEnum getParametero (mvParamEnum paramFlag, mvOptionEnum *option) const
 (one liner)
mvErrorEnum getParameterv (mvParamEnum paramFlag, mvFloat *numArray, mvCount *noOfParameters) const
 (one liner)
 mvGroupBehaviour (mvBaseActionPtr groupBehPtr)
 (one liner)
void removeAllGroups ()
 (one liner)
mvErrorEnum removeGroup (mvIndex groupNo)
 (one liner)
mvErrorEnum setGroupParameterf (mvIndex groupIndex, mvParamEnum paramFlag, mvFloat num)
 (one liner)
mvErrorEnum setGroupParameterf_str (mvIndex groupIndex, const char *param, mvFloat num)
 (one liner)
mvErrorEnum setGroupParameteri (mvIndex groupIndex, mvParamEnum paramFlag, mvIndex index)
 (one liner)
mvErrorEnum setGroupParameteri_str (mvIndex groupIndex, const char *param, mvIndex index)
 (one liner)
mvErrorEnum setGroupParametero (mvIndex groupIndex, mvParamEnum paramFlag, mvOptionEnum option)
 (one liner)
mvErrorEnum setGroupParametero_str (mvIndex groupIndex, const char *param, const char *option)
 (one liner)
mvErrorEnum setGroupParameterv (mvIndex groupIndex, mvParamEnum paramFlag, mvFloat *numArray)
 (one liner)
mvErrorEnum setGroupParameterv_str (mvIndex groupIndex, const char *param, mvFloat *numArray)
 (one liner)
mvErrorEnum setParameterf (mvParamEnum paramFlag, mvFloat num)
 (one liner)
mvErrorEnum setParameteri (mvParamEnum paramFlag, mvIndex index)
 (one liner)
mvErrorEnum setParametero (mvParamEnum paramFlag, mvOptionEnum option)
 (one liner)
mvErrorEnum setParameterv (mvParamEnum paramFlag, mvFloat *numArray)
 (one liner)
 ~mvGroupBehaviour ()
 (one liner)


Detailed Description

A cooperative behaviour between groups of objects.

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.


Constructor & Destructor Documentation

mvGroupBehaviour::mvGroupBehaviour ( mvBaseActionPtr  groupBehPtr  ) 

(one liner)

(documentation goes here)

mvGroupBehaviour::~mvGroupBehaviour (  ) 

(one liner)

(documentation goes here)


Member Function Documentation

mvGroupBehaviourGroupNodePtr mvGroupBehaviour::findGroupNode ( mvIndex  group  )  const

(one liner)

(documentation goes here)

mvGroupBehaviourGroupNodePtr mvGroupBehaviour::getGroupNodeByIndex ( mvIndex  index  )  const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParameterf_str ( mvIndex  groupIndex,
const char *  param,
mvFloat num 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParameteri ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvIndex index 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParameteri_str ( mvIndex  groupIndex,
const char *  param,
mvIndex index 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParametero ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvOptionEnum option 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParametero_str ( mvIndex  groupIndex,
const char *  param,
const char **  option 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParameterv ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvFloat numArray,
mvCount noOfParameters 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getGroupParameterv_str ( mvIndex  groupIndex,
const char *  param,
mvFloat numArray,
mvCount noOfParameters 
) const

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::getParameterf ( mvParamEnum  paramFlag,
mvFloat num 
) const

(one liner)

Automatically call default group node template getParameterf

mvErrorEnum mvGroupBehaviour::getParameteri ( mvParamEnum  paramFlag,
mvIndex outIndex 
) const

(one liner)

automatically calls the behaviour's default template version of getParameteri

mvErrorEnum mvGroupBehaviour::getParametero ( mvParamEnum  paramFlag,
mvOptionEnum option 
) const

(one liner)

automatically calls the behaviour's default template version of getParameter

mvErrorEnum mvGroupBehaviour::getParameterv ( mvParamEnum  paramFlag,
mvFloat numArray,
mvCount noOfParameters 
) const

(one liner)

Automatically call default group node template getParameterv

void mvGroupBehaviour::removeAllGroups (  ) 

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::removeGroup ( mvIndex  groupNo  ) 

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParameterf ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvFloat  num 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParameterf_str ( mvIndex  groupIndex,
const char *  param,
mvFloat  num 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParameteri ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvIndex  paramIndex 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParameteri_str ( mvIndex  groupIndex,
const char *  param,
mvIndex  paramIndex 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParametero ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvOptionEnum  option 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParametero_str ( mvIndex  groupIndex,
const char *  param,
const char *  option 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParameterv ( mvIndex  groupIndex,
mvParamEnum  paramFlag,
mvFloat numArray 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setGroupParameterv_str ( mvIndex  groupIndex,
const char *  param,
mvFloat numArray 
)

(one liner)

(documentation goes here)

mvErrorEnum mvGroupBehaviour::setParameterf ( mvParamEnum  paramFlag,
mvFloat  num 
)

(one liner)

Automatically call default group node template setParameterf

mvErrorEnum mvGroupBehaviour::setParameteri ( mvParamEnum  paramFlag,
mvIndex  index 
)

(one liner)

Automatically call default group node template setParameteri

mvErrorEnum mvGroupBehaviour::setParametero ( mvParamEnum  paramFlag,
mvOptionEnum  option 
)

(one liner)

Automatically call default group node template setParameter

mvErrorEnum mvGroupBehaviour::setParameterv ( mvParamEnum  paramFlag,
mvFloat numArray 
)

(one liner)

Automatically call default group node template setParameterv


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