HOM_ik_Joint.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
*/

#ifndef __HOM_ik_Joint_h__
#define __HOM_ik_Joint_h__

#include "HOM_API.h"
#include "HOM_ElemPtr.h"
#include "HOM_Module.h"
#include "HOM_PtrOrNull.h"
#include <string>

class HOM_Matrix4;
class HOM_Vector3;

SWIGOUT(%rename(_ik_Joint) HOM_ik_Joint;)

class HOM_API HOM_ik_Joint
{
public:
    HOM_ik_Joint() { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_ik_Joint() { HOM_DESTRUCT_OBJECT(this) }

    virtual bool operator==(HOM_PtrOrNull<HOM_ik_Joint> joint) const = 0;
    bool operator!=(HOM_PtrOrNull<HOM_ik_Joint> joint) const
        { return !operator==(joint); }

    virtual int __hash__() const = 0;
    virtual std::string __repr__() const = 0;

    SWIGOUT(%newobject worldTransform;)
    virtual HOM_Matrix4 *worldTransform() const = 0;
    virtual void setWorldTransform(const HOM_Matrix4 &xform) = 0;

    // TODO - add child accessor?
    // TODO - add joint index accessor?

    SWIGOUT(%newobject parent;)
    virtual HOM_ik_Joint *parent() const = 0;
    virtual void setParent(HOM_ik_Joint *parent) = 0;

    virtual std::string rotationOrder() const = 0;
    virtual void setRotationOrder(const char *rotate_order) = 0;

    SWIGOUT(%newobject rotationWeights;)
    virtual HOM_Vector3 *rotationWeights() const = 0;
    virtual void setRotationWeights(const HOM_Vector3 &weights) = 0;

    SWIGOUT(%newobject translationWeights;)
    virtual HOM_Vector3 *translationWeights() const = 0;
    virtual void setTranslationWeights(const HOM_Vector3 &weights) = 0;

    virtual double mass() const = 0;
    virtual void setMass(double mass) = 0;

    SWIGOUT(%newobject localCenterOfMass;)
    virtual HOM_Vector3 *localCenterOfMass() const = 0;
    virtual void setLocalCenterOfMass(const HOM_Vector3 &com) = 0;

    virtual std::pair<HOM_ElemPtr<HOM_Vector3>, HOM_ElemPtr<HOM_Vector3> >
        rotationLimits() const = 0;
    virtual void setRotationLimits(const HOM_Vector3 &lower,
                                   const HOM_Vector3 &upper) = 0;

    virtual std::pair<HOM_ElemPtr<HOM_Vector3>, HOM_ElemPtr<HOM_Vector3> >
        translationLimits() const = 0;
    virtual void setTranslationLimits(const HOM_Vector3 &lower,
                                      const HOM_Vector3 &upper) = 0;

    SWIGOUT(%newobject restTransform;)
    virtual HOM_Matrix4 *restTransform() const = 0;
    virtual void setRestTransform(const HOM_Matrix4 &xform) = 0;

    SWIGOUT(%newobject restRotationWeights;)
    virtual HOM_Vector3 *restRotationWeights() const = 0;
    virtual void setRestRotationWeights(const HOM_Vector3 &weights) = 0;

    SWIGOUT(%newobject restTranslationWeights;)
    virtual HOM_Vector3 *restTranslationWeights() const = 0;
    virtual void setRestTranslationWeights(const HOM_Vector3 &weights) = 0;
};

#endif