SNMPhysicsJointUpVector.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SNMPhysicsJointUpVector.h                      *
 *
 *  Copyright (C) 2002-2011 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLPHYSICS_SCENENODEMODIFIERS_JOINTUPVECTOR_H__
#define __PLPHYSICS_SCENENODEMODIFIERS_JOINTUPVECTOR_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLMath/Vector3.h>
#include "PLPhysics/SceneNodeModifiers/SNMPhysicsJoint.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLPhysics {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Physics up vector joint scene node modifier
*
*  @remarks
*    This scene node modifier adds an up vector joint. An up vector joint is a constraint that allows a body 
*    to translate freely in 3d space, but it only allows the body to rotate around the pin direction 
*    vector. This could be use by the application to control a character with physics and collision.
*    Since the up vector joint is a unuary constraint, there is not need to have user callback or 
*    user data assigned to it. The application can simple hold to the joint handle and update the pin 
*    on the force callback function of the rigid body owning the joint.
*
*  @note
*    - This joint type has no target
*/
class SNMPhysicsJointUpVector : public SNMPhysicsJoint {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLPHYSICS_RTTI_EXPORT, SNMPhysicsJointUpVector, "PLPhysics", PLPhysics::SNMPhysicsJoint, "Physics up vector joint scene node modifier")
        // Attributes
        pl_attribute(PinDir,    PLMath::Vector3,    PLMath::Vector3(0.0f, 1.0f, 0.0f),  ReadWrite,  GetSet, "The aligning vector in scene container space if the 'LocalPinDirection'-flag is not set, else in local scene node space",  "")
        // Constructors
        pl_constructor_1(ParameterConstructor,  PLScene::SceneNode&,    "Parameter constructor",    "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public RTTI get/set functions                         ]
    //[-------------------------------------------------------]
    public:
        PLPHYSICS_API const PLMath::Vector3 &GetPinDir() const;
        PLPHYSICS_API void SetPinDir(const PLMath::Vector3 &vValue);


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cSceneNode
        *    Owner scene node
        */
        PLPHYSICS_API SNMPhysicsJointUpVector(PLScene::SceneNode &cSceneNode);

        /**
        *  @brief
        *    Destructor
        */
        PLPHYSICS_API virtual ~SNMPhysicsJointUpVector();


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        PLMath::Vector3 m_vPinDir;  /**< The aligning vector in local space */


    //[-------------------------------------------------------]
    //[ Private virtual SNMPhysicsJoint functions             ]
    //[-------------------------------------------------------]
    private:
        virtual void CreatePhysicsJoint() override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLPhysics


#endif // __PLPHYSICS_SCENENODEMODIFIERS_JOINTUPVECTOR_H__