/***************************************************************************
 *                          Zanoza Modeler v2.x                            *
 *      This is unpublished propietary source code of Zanoza Software.     *
 *      The copyright notice does not evidence any actual or intended      *
 *                    publication of such source code.                     *
 *                                                                         *
 *                Copyright (c) 2002-2008 Zanoza Software.                 *
 *                                                                         *
 *                        All rights reserved.                             *
 ***************************************************************************
 *--------------------------------------------------------------------------
 * @author:   Oleg Melashenko
 *--------------------------------------------------------------------------
 * @purpose:  Declaration of the class IBoneNode
 *   Interface for bones, used in skeletal models/animation. Each bone has it's own 
 *   ID inside skeleton and a pair of transformation: the initial transformation
 *   (skin-position) and current transformation.
 *   Interface supports IK limits on rotation. By supplying min=max to IK limiter, you
 *   disable transformation; by supplying min > max you remvoe limit from
 *   the mode (e.g. supplying min=1, max=-1 to X-rotation limiter you remove
 *   X-axis rotation limits. All limits apply to relative transformation from initial position.
 *   
 *   In current implementation IBoneNode is not visualizeable, since ISkeletonNode
 *   draws all it's bones.
 *--------------------------------------------------------------------------
 * @created: Saturday, March 08, 2003 16:47:12
 */

#if !defined(IBoneNode_h_included)
#define IBoneNode_h_included
//forward declaration of this class might require
namespace scene
{ class IBoneNode; };
#include <zmodeler.h>
#include <scene/zmSceneTypes.h>
#include <scene/INode.h>


namespace scene
{
  
  class IBoneNode : public scene::INode
  {
  public:
    virtual ZRESULT setPosMode(eSkeletonMode mode)=0;
    virtual ZRESULT getPosMode(eSkeletonMode& mode)=0;
    virtual ZRESULT setDirectionalAxis(core::eAxis axis)=0;
    virtual ZRESULT getDirectionalAxis(core::eAxis& axis)=0;
    virtual ZRESULT setIKTerminator(bool bTerm)=0;
    virtual ZRESULT isIKTerminator(void)=0;
    /* Provides bone's default color. */
    virtual ZRESULT setDefaultColor(ZColor col)=0;
    /* Provides bone's default color. */
    virtual ZRESULT getDefaultColor(ZColor& col)=0;
    virtual ZRESULT setIKLimits(float fMinX, float fMinY, float fMinZ, float fMaxX, float fMaxY, float fMaxZ)=0;
    virtual ZRESULT getIKLimits(float& fMinX, float& fMinY, float& fMinZ, float& fMaxX, float& fMaxY, float& fMaxZ)=0;
    virtual ZRESULT getBoneID(long& nID)=0;
    virtual ZRESULT setBoneID(long nID)=0;
  
  };//class IBoneNode
};//scene

#endif
