OgreBone.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

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.
-----------------------------------------------------------------------------
*/

#ifndef __Bone_H__
#define __Bone_H__

#include "OgrePrerequisites.h"
#include "OgreNode.h"


namespace Ogre 
{
    class _OgreExport Bone : public Node
    {
    public:
        Bone(unsigned short handle, Skeleton* creator);
        Bone(const String& name, unsigned short handle, Skeleton* creator);
        ~Bone();

        Bone* createChild(unsigned short handle, 
            const Vector3& translate = Vector3::ZERO, const Quaternion& rotate = Quaternion::IDENTITY);


        unsigned short getHandle(void) const;

        void setBindingPose(void);

        void reset(void);

        void setManuallyControlled(bool manuallyControlled);

        bool isManuallyControlled() const;

        
        void _getOffsetTransform(Matrix4& m) const;

        const Vector3& _getBindingPoseInverseScale(void) const { return mBindDerivedInverseScale; }
        const Vector3& _getBindingPoseInversePosition(void) const { return mBindDerivedInversePosition; }
        const Quaternion& _getBindingPoseInverseOrientation(void) const { return mBindDerivedInverseOrientation; }

        void needUpdate(bool forceParentUpdate = false);


    protected:
        unsigned short mHandle;

        bool mManuallyControlled;

        Node* createChildImpl(void);
        Node* createChildImpl(const String& name);

        Skeleton* mCreator;

        Vector3 mBindDerivedInverseScale;
        Quaternion mBindDerivedInverseOrientation;
        Vector3 mBindDerivedInversePosition;
    };

}

#endif